diff --git a/.buildinfo b/.buildinfo new file mode 100644 index 0000000..44d0ce2 --- /dev/null +++ b/.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: e4dd0cebedc9134d87f3c4373472ea75 +tags: d77d1c0d9ca2f4c8421862c7c5a0d620 diff --git a/.nojekyll b/.nojekyll new file mode 100644 index 0000000..e69de29 diff --git a/_downloads/07ab827005bb2435cfa6959d87adca94/accelerate_cuda.def b/_downloads/07ab827005bb2435cfa6959d87adca94/accelerate_cuda.def new file mode 100644 index 0000000..a983762 --- /dev/null +++ b/_downloads/07ab827005bb2435cfa6959d87adca94/accelerate_cuda.def @@ -0,0 +1,6 @@ +Bootstrap: docker +From: pytorch/pytorch:2.2.2-cuda12.1-cudnn8-runtime + +%post + + pip install accelerate evaluate datasets scipy scikit-learn transformers diff --git a/_downloads/69e350fcc7a533a6096e256764f8d27b/puhti-openmpi.def b/_downloads/69e350fcc7a533a6096e256764f8d27b/puhti-openmpi.def new file mode 100644 index 0000000..5f6eea7 --- /dev/null +++ b/_downloads/69e350fcc7a533a6096e256764f8d27b/puhti-openmpi.def @@ -0,0 +1,70 @@ +Bootstrap: docker +From: rockylinux:{{ OS_VERSION }} + +%arguments + + NPROCS=4 + OPENMPI_VERSION=4.1.4rc1 + OSU_MICRO_BENCHMARKS_VERSION=7.4 + GCC_VERSION=9 + UCX_VERSION=1.13.0 + OS_NAME=rhel + OS_VERSION=8.6 + OFED_VERSION=5.6-2.0.9.0 + +%post + + ### Install OpenMPI dependencies + + # Base tools and newer gcc version + + dnf install -y dnf-plugins-core epel-release + dnf config-manager --set-enabled powertools + dnf install -y make gdb wget numactl-devel which + dnf -y install gcc-toolset-{{ GCC_VERSION }} + source /opt/rh/gcc-toolset-{{ GCC_VERSION }}/enable + + # Enable Mellanox OFED rpm repo + + wget https://www.mellanox.com/downloads/ofed/RPM-GPG-KEY-Mellanox + rpm --import RPM-GPG-KEY-Mellanox + rm RPM-GPG-KEY-Mellanox + cd /etc/yum.repos.d/ + wget https://linux.mellanox.com/public/repo/mlnx_ofed/{{ OFED_VERSION }}/{{ OS_NAME }}{{ OS_VERSION }}/mellanox_mlnx_ofed.repo + cd / + + # Install network library components + + dnf -y install rdma-core ucx-ib-{{ UCX_VERSION }} ucx-devel-{{ UCX_VERSION }} ucx-knem-{{ UCX_VERSION }} ucx-cma-{{ UCX_VERSION }} ucx-rdmacm-{{ UCX_VERSION }} + + ### Install OpenMPI + + dnf -y install openmpi-{{ OPENMPI_VERSION }} + + ### Build example application + + export OMPI_DIR=/usr/mpi/gcc/openmpi-{{ OPENMPI_VERSION }} + export PATH="$OMPI_DIR/bin:$PATH" + export LD_LIBRARY_PATH="$OMPI_DIR/lib:$LD_LIBRARY_PATH" + + # Build osu benchmarks + cd /opt + wget -q http://mvapich.cse.ohio-state.edu/download/mvapich/osu-micro-benchmarks-{{ OSU_MICRO_BENCHMARKS_VERSION }}.tar.gz + tar xf osu-micro-benchmarks-{{ OSU_MICRO_BENCHMARKS_VERSION }}.tar.gz + cd osu-micro-benchmarks-{{ OSU_MICRO_BENCHMARKS_VERSION }} + ./configure --prefix=/opt/osu-micro-benchmarks CC=mpicc CFLAGS=-O3 + make -j{{ NPROCS }} + make install + cd .. + rm -rf osu-micro-benchmarks-{{ OSU_MICRO_BENCHMARKS_VERSION }} osu-micro-benchmarks-{{ OSU_MICRO_BENCHMARKS_VERSION }}.tar.gz + +%environment + export OMPI_DIR=/usr/mpi/gcc/openmpi-{{ OPENMPI_VERSION }} + export PATH="$OMPI_DIR/bin:$PATH" + export LD_LIBRARY_PATH="$OMPI_DIR/lib:$LD_LIBRARY_PATH" + export MANPATH="$OMPI_DIR/share/man:$MANPATH" + +%runscript + source /opt/rh/gcc-toolset-{{ GCC_VERSION }}/enable + /opt/osu-micro-benchmarks/libexec/osu-micro-benchmarks/mpi/pt2pt/osu_bw + diff --git a/_downloads/89af20c2d98096490dcc145892ed280d/run_lammps_indent.sh b/_downloads/89af20c2d98096490dcc145892ed280d/run_lammps_indent.sh new file mode 100644 index 0000000..3e6dc8b --- /dev/null +++ b/_downloads/89af20c2d98096490dcc145892ed280d/run_lammps_indent.sh @@ -0,0 +1,17 @@ +#!/bin/bash +#SBATCH --time=00:10:00 +#SBATCH --mem=2G +#SBATCH --nodes=1 +#SBATCH --ntasks-per-node=4 +#SBATCH --output=lammps_indent.out + +# Copy example from image +apptainer exec lammps-openmpi.sif cp -r /opt/lammps/examples/indent . + +cd indent + +# Load OpenMPI module +module load openmpi + +# Run simulation +srun apptainer run ../lammps-openmpi.sif -in in.indent diff --git a/_downloads/af972a158f9b94f597741a2187c63f9c/run_accelerate_cuda.sh b/_downloads/af972a158f9b94f597741a2187c63f9c/run_accelerate_cuda.sh new file mode 100644 index 0000000..eade966 --- /dev/null +++ b/_downloads/af972a158f9b94f597741a2187c63f9c/run_accelerate_cuda.sh @@ -0,0 +1,16 @@ +#!/bin/bash +#SBATCH --mem=32G +#SBATCH --nodes=1 +#SBATCH --ntasks-per-node=1 +#SBATCH --gpus-per-task=2 +#SBATCH --cpus-per-task=12 +#SBATCH --time=00:10:00 +#SBATCH --output=accelerate_cuda.out + +export OMP_NUM_THREADS=$(( $SLURM_CPUS_PER_TASK / $SLURM_GPUS_ON_NODE )) + +apptainer exec --nv accelerate_cuda.sif \ + torchrun \ + --nproc_per_node $SLURM_GPUS_ON_NODE \ + ./nlp_example.py \ + --mixed_precision fp16 diff --git a/_downloads/b2789bd6fc9a1e97d79c827edc887d37/lammps-openmpi.def b/_downloads/b2789bd6fc9a1e97d79c827edc887d37/lammps-openmpi.def new file mode 100644 index 0000000..54b4a8a --- /dev/null +++ b/_downloads/b2789bd6fc9a1e97d79c827edc887d37/lammps-openmpi.def @@ -0,0 +1,68 @@ +Bootstrap: docker +From: ubuntu:latest + +%arguments + + NPROCS=4 + OPENMPI_VERSION=4.1.6 + LAMMPS_VERSION=29Aug2024 + +%post + + ### Install OpenMPI dependencies + + apt-get update + apt-get install -y wget bash gcc gfortran g++ make file bzip2 ca-certificates libucx-dev + + ### Build OpenMPI + + OPENMPI_VERSION_SHORT=$(echo {{ OPENMPI_VERSION }} | cut -f 1-2 -d '.') + cd /opt + mkdir ompi + wget -q https://download.open-mpi.org/release/open-mpi/v${OPENMPI_VERSION_SHORT}/openmpi-{{ OPENMPI_VERSION }}.tar.bz2 + tar -xvf openmpi-{{ OPENMPI_VERSION }}.tar.bz2 + # Compile and install + cd openmpi-{{ OPENMPI_VERSION }} + ./configure --prefix=/opt/ompi --with-ucx=/usr + make -j{{ NPROCS }} + make install + cd .. + rm -rf openmpi-{{ OPENMPI_VERSION }} openmpi-{{ OPENMPI_VERSION }}.tar.bz2 + + ### Build example application + + # Install LAMMPS dependencies + apt-get install -y cmake + + export OMPI_DIR=/opt/ompi + export PATH="$OMPI_DIR/bin:$PATH" + export LD_LIBRARY_PATH="$OMPI_DIR/lib:$LD_LIBRARY_PATH" + export CMAKE_PREFIX_PATH="$OMPI_DIR:$CMAKE_PREFIX_PATH" + + # Build LAMMPS + cd /opt + wget -q https://download.lammps.org/tars/lammps-{{ LAMMPS_VERSION }}.tar.gz + tar xf lammps-{{ LAMMPS_VERSION }}.tar.gz + cd lammps-{{ LAMMPS_VERSION }} + cmake -S cmake -B build \ + -DCMAKE_INSTALL_PREFIX=/opt/lammps \ + -DBUILD_MPI=yes \ + -DBUILD_OMP=yes + cmake --build build --parallel {{ NPROCS }} --target install + cp -r examples /opt/lammps/examples + cd .. + rm -rf lammps-{{ LAMMPS_VERSION }} lammps-{{ LAMMPS_VERSION }}.tar.gz + +%environment + export OMPI_DIR=/opt/ompi + export PATH="$OMPI_DIR/bin:$PATH" + export LD_LIBRARY_PATH="$OMPI_DIR/lib:$LD_LIBRARY_PATH" + export MANPATH="$OMPI_DIR/share/man:$MANPATH" + + export LAMMPS_DIR=/opt/lammps + export PATH="$LAMMPS_DIR/bin:$PATH" + export LD_LIBRARY_PATH="$LAMMPS_DIR/lib:$LD_LIBRARY_PATH" + export MANPATH="$LAMMPS_DIR/share/man:$MANPATH" + +%runscript + exec /opt/lammps/bin/lmp "$@" diff --git a/_downloads/c7c7f903ce66845641c48c1015bb49c9/lumi-mpich.def b/_downloads/c7c7f903ce66845641c48c1015bb49c9/lumi-mpich.def new file mode 100644 index 0000000..d23bdaf --- /dev/null +++ b/_downloads/c7c7f903ce66845641c48c1015bb49c9/lumi-mpich.def @@ -0,0 +1,39 @@ +bootstrap: docker +from: ubuntu:latest + +%arguments + + NPROCS=4 + MPICH_VERSION=3.1.4 + OSU_MICRO_BENCHMARKS_VERSION=7.4 + +%post + + ### Install MPICH dependencies + + apt-get update + apt-get install -y file g++ gcc gfortran make gdb strace wget ca-certificates --no-install-recommends + + # Build MPICH + + wget -q http://www.mpich.org/static/downloads/{{ MPICH_VERSION }}/mpich-{{ MPICH_VERSION }}.tar.gz + tar xf mpich-{{ MPICH_VERSION }}.tar.gz + cd mpich-{{ MPICH_VERSION }} + ./configure --disable-fortran --enable-fast=all,O3 --prefix=/usr + make -j{{ NPROCS }} + make install + ldconfig + + # Build osu benchmarks + cd /opt + wget -q http://mvapich.cse.ohio-state.edu/download/mvapich/osu-micro-benchmarks-{{ OSU_MICRO_BENCHMARKS_VERSION }}.tar.gz + tar xf osu-micro-benchmarks-{{ OSU_MICRO_BENCHMARKS_VERSION }}.tar.gz + cd osu-micro-benchmarks-{{ OSU_MICRO_BENCHMARKS_VERSION }} + ./configure --prefix=/opt/osu-micro-benchmarks CC=mpicc CFLAGS=-O3 + make -j{{ NPROCS }} + make install + cd .. + rm -rf osu-micro-benchmarks-{{ OSU_MICRO_BENCHMARKS_VERSION }} osu-micro-benchmarks-{{ OSU_MICRO_BENCHMARKS_VERSION }}.tar.gz + +%runscript + /opt/osu-micro-benchmarks/libexec/osu-micro-benchmarks/mpi/pt2pt/osu_bw diff --git a/_downloads/ff3d6a2935fcb472627a13145369a68b/triton-openmpi.def b/_downloads/ff3d6a2935fcb472627a13145369a68b/triton-openmpi.def new file mode 100644 index 0000000..20e7e3e --- /dev/null +++ b/_downloads/ff3d6a2935fcb472627a13145369a68b/triton-openmpi.def @@ -0,0 +1,56 @@ +Bootstrap: docker +From: ubuntu:latest + +%arguments + + NPROCS=4 + OPENMPI_VERSION=4.1.6 + OSU_MICRO_BENCHMARKS_VERSION=7.4 + +%post + + ### Install OpenMPI dependencies + + apt-get update + apt-get install -y wget bash gcc gfortran g++ make file bzip2 ca-certificates libucx-dev + + ### Build OpenMPI + + OPENMPI_VERSION_SHORT=$(echo {{ OPENMPI_VERSION }} | cut -f 1-2 -d '.') + cd /opt + mkdir ompi + wget -q https://download.open-mpi.org/release/open-mpi/v${OPENMPI_VERSION_SHORT}/openmpi-{{ OPENMPI_VERSION }}.tar.bz2 + tar -xvf openmpi-{{ OPENMPI_VERSION }}.tar.bz2 + # Compile and install + cd openmpi-{{ OPENMPI_VERSION }} + ./configure --prefix=/opt/ompi --with-ucx=/usr + make -j{{ NPROCS }} + make install + cd .. + rm -rf openmpi-{{ OPENMPI_VERSION }} openmpi-{{ OPENMPI_VERSION }}.tar.bz2 + + ### Build example application + + export OMPI_DIR=/opt/ompi + export PATH="$OMPI_DIR/bin:$PATH" + export LD_LIBRARY_PATH="$OMPI_DIR/lib:$LD_LIBRARY_PATH" + + # Build osu benchmarks + cd /opt + wget -q http://mvapich.cse.ohio-state.edu/download/mvapich/osu-micro-benchmarks-{{ OSU_MICRO_BENCHMARKS_VERSION }}.tar.gz + tar xf osu-micro-benchmarks-{{ OSU_MICRO_BENCHMARKS_VERSION }}.tar.gz + cd osu-micro-benchmarks-{{ OSU_MICRO_BENCHMARKS_VERSION }} + ./configure --prefix=/opt/osu-micro-benchmarks CC=/opt/ompi/bin/mpicc CFLAGS=-O3 + make -j{{ NPROCS }} + make install + cd .. + rm -rf osu-micro-benchmarks-{{ OSU_MICRO_BENCHMARKS_VERSION }} osu-micro-benchmarks-{{ OSU_MICRO_BENCHMARKS_VERSION }}.tar.gz + +%environment + export OMPI_DIR=/opt/ompi + export PATH="$OMPI_DIR/bin:$PATH" + export LD_LIBRARY_PATH="$OMPI_DIR/lib:$LD_LIBRARY_PATH" + export MANPATH="$OMPI_DIR/share/man:$MANPATH" + +%runscript + /opt/osu-micro-benchmarks/libexec/osu-micro-benchmarks/mpi/pt2pt/osu_bw diff --git a/_images/app_run_example.png b/_images/app_run_example.png new file mode 100644 index 0000000..c1b3e91 Binary files /dev/null and b/_images/app_run_example.png differ diff --git a/_images/apptainer_example.png b/_images/apptainer_example.png new file mode 100644 index 0000000..ccff83e Binary files /dev/null and b/_images/apptainer_example.png differ diff --git a/_images/bind_example.png b/_images/bind_example.png new file mode 100644 index 0000000..45f2130 Binary files /dev/null and b/_images/bind_example.png differ diff --git a/_images/build_example.png b/_images/build_example.png new file mode 100644 index 0000000..c6b2460 Binary files /dev/null and b/_images/build_example.png differ diff --git a/_images/containerized_application.png b/_images/containerized_application.png new file mode 100644 index 0000000..4824c4b Binary files /dev/null and b/_images/containerized_application.png differ diff --git a/_images/default_mounts.png b/_images/default_mounts.png new file mode 100644 index 0000000..47bb43e Binary files /dev/null and b/_images/default_mounts.png differ diff --git a/_images/dockerfile_python_image.png b/_images/dockerfile_python_image.png new file mode 100644 index 0000000..a4497c7 Binary files /dev/null and b/_images/dockerfile_python_image.png differ diff --git a/_images/dockerhub_python.png b/_images/dockerhub_python.png new file mode 100644 index 0000000..a57e7ba Binary files /dev/null and b/_images/dockerhub_python.png differ diff --git a/_images/exec_example.png b/_images/exec_example.png new file mode 100644 index 0000000..6122c96 Binary files /dev/null and b/_images/exec_example.png differ diff --git a/_images/image_explanation.png b/_images/image_explanation.png new file mode 100644 index 0000000..7ceac8a Binary files /dev/null and b/_images/image_explanation.png differ diff --git a/_images/image_explanation_apptainer.png b/_images/image_explanation_apptainer.png new file mode 100644 index 0000000..3ec9567 Binary files /dev/null and b/_images/image_explanation_apptainer.png differ diff --git a/_images/instance_example.png b/_images/instance_example.png new file mode 100644 index 0000000..c426ef6 Binary files /dev/null and b/_images/instance_example.png differ diff --git a/_images/mpi_install_structure.png b/_images/mpi_install_structure.png new file mode 100644 index 0000000..f56bcbb Binary files /dev/null and b/_images/mpi_install_structure.png differ diff --git a/_images/mpi_job_structure.png b/_images/mpi_job_structure.png new file mode 100644 index 0000000..33c7797 Binary files /dev/null and b/_images/mpi_job_structure.png differ diff --git a/_images/mpi_job_structure_bound.png b/_images/mpi_job_structure_bound.png new file mode 100644 index 0000000..e40a2b8 Binary files /dev/null and b/_images/mpi_job_structure_bound.png differ diff --git a/_images/mpi_job_structure_hybrid.png b/_images/mpi_job_structure_hybrid.png new file mode 100644 index 0000000..0933a8e Binary files /dev/null and b/_images/mpi_job_structure_hybrid.png differ diff --git a/_images/normal_application.png b/_images/normal_application.png new file mode 100644 index 0000000..9611847 Binary files /dev/null and b/_images/normal_application.png differ diff --git a/_images/nv_example.png b/_images/nv_example.png new file mode 100644 index 0000000..89479a9 Binary files /dev/null and b/_images/nv_example.png differ diff --git a/_images/pull_example.png b/_images/pull_example.png new file mode 100644 index 0000000..2fb628d Binary files /dev/null and b/_images/pull_example.png differ diff --git a/_images/rocm_example.png b/_images/rocm_example.png new file mode 100644 index 0000000..ad7ed2e Binary files /dev/null and b/_images/rocm_example.png differ diff --git a/_images/run_example.png b/_images/run_example.png new file mode 100644 index 0000000..a009f3e Binary files /dev/null and b/_images/run_example.png differ diff --git a/_images/shell_example.png b/_images/shell_example.png new file mode 100644 index 0000000..5589f39 Binary files /dev/null and b/_images/shell_example.png differ diff --git a/_sources/basics_running_containers.rst.txt b/_sources/basics_running_containers.rst.txt new file mode 100644 index 0000000..f69b602 --- /dev/null +++ b/_sources/basics_running_containers.rst.txt @@ -0,0 +1,182 @@ +Basics of running containers +============================ + +.. objectives:: + + * Learn what methods are available to run a container + + +Different ways you can run your containers +------------------------------------------ + +You can run your container in multiple different ways: + +- You can run the container as a single application +- You can get an interactive terminal in the container +- You can run an application from within the container + + +We'll cover these ways in individual sections below. + + +How to read Apptainer commands? +------------------------------- + +Apptainer's commands can sometimes have multiple flags +which can make it hard to parse the command line. + +A typical apptainer command has: + +1. ``apptainer`` is at the start because we use the + Apptainer client to run the commands. +2. A subcommand (like ``pull``, ``build``, ``exec``, ``run`` etc.) + that tells which Apptainer feature we want to use. +3. Often after the subcommand we have the name of the image we + want to use. +4. At the end we might have additional commands that Apptainer + ignores but are to be digested by the application that the container itself is running. + +For legibility reasons many commands in this lesson are highlighted +in this format: + +.. figure:: img/apptainer_example.png + :width: 100% + + Figure 1: How apptainer-commands are highlighted + + +For the comprehensive list of client commands, see +`Apptainer CLI reference page `__. + + +Obtaining a container from container registry +--------------------------------------------- + +For these examples let's use a +`Python image from Docker Hub `__. + +For now let's just consider it as an application we want +to use and that this application is available in Docker Hub. + +Let's create the container image with the following command: + +.. code-block:: console + + $ apptainer pull python.sif docker://python + +We'll talk about container images and image building later on. +For now it is enough to know that the file ``python.sif`` contains +a Python installation. + +Running the container +--------------------- + +Running the container means that we run some specific program +that the image creator has set to be the default program for this image. + +When we run the container we will execute a so-called entry script +or runscript that contains commands specified by the image creators. + +.. warning:: + + Remember to only run containers from sources that you trust. + +Let's run the Python container image: + +.. code-block:: console + + $ apptainer run python.sif + +.. admonition:: Expected result + :class: dropdown + + We get a Python interpreter running in the container: + + .. code-block:: console + + $ apptainer run python.sif + Python 3.12.3 (main, Apr 10 2024, 14:35:18) [GCC 12.2.0] on linux + Type "help", "copyright", "credits" or "license" for more information. + >>> + + +You should read the command line like this: + +.. figure:: img/run_example.png + :scale: 50% + + Figure 2: A simple run command + +This syntax might seem self-evident, but in more complex use cases we will give +additional flags to various parts of the command. + + +Launching an interactive shell in the container +----------------------------------------------- + +We can launch an interactive shell in a container with +``apptainer shell``-command: + +.. code-block:: console + + $ apptainer shell python.sif + +.. admonition:: Expected result + :class: dropdown + + We get a ``bash`` terminal running in the container: + + .. code-block:: console + + $ apptainer shell python.sif + Apptainer> echo $SHELL + /bin/bash + +You should read the command line like this: + +.. figure:: img/shell_example.png + :scale: 50% + + Figure 3: Launch a shell in a container + + +Running a single program from the container +------------------------------------------- + +We can launch a single program in a container with +``apptainer exec``-command. + +The Python container is based on a Debian Linux distribution. +Let's check the Debian version in the container: + +.. code-block:: console + + $ apptainer exec python.sif cat /etc/debian_version + +.. admonition:: Expected result + :class: dropdown + + With the command we print the contents of the + ``/etc/debian_version``-file: + + .. code-block:: console + + $ apptainer exec python.sif cat /etc/debian_version + 12.5 + +You should read the command line like this: + +.. figure:: img/exec_example.png + :scale: 50% + + Figure 4: Launch a program in a container + + +Review of this session +---------------------- + +.. admonition:: Key points to remember + + - You can run the containers default program/application/set-of-commands with ``apptainer run my_image.sif`` + - You can start an interactive shell in a container with ``apptainer shell my_image.sif`` + - You can execute a single program in a container with ``apptainer exec my_image.sif my_program arg1 arg2`` diff --git a/_sources/binding_folders.rst.txt b/_sources/binding_folders.rst.txt new file mode 100644 index 0000000..ba66c0e --- /dev/null +++ b/_sources/binding_folders.rst.txt @@ -0,0 +1,68 @@ +Binding folders into your container +=================================== + +.. objectives:: + + * Learn how you can bind folders into containers + +When you launch a program in a container, the program runs in a contained +environment. The file system in the container might not have the same +folders structure as the machine that runs the container. + +So, when you want to work on your data, you need to bring it with you into +this contained world inside the container. + +This is done via method called **mount binding**. + +Binding means that a folder from the host system is mapped into a folder +inside the container. + +.. figure:: img/default_mounts.png + + Figure 1: Only some folders are mounted by default + +By default, ``$HOME``, ``$CWD`` (current working directory) +``/tmp`` and +`few other paths `__ +are bound to the image. + +If you want to do additional mappings you need to do it by giving an +extra arguments to the command you're running. + +The following would bind folder ``/scratch`` from the host system to +``/scratch`` in the container: + +.. code-block:: console + + $ apptainer exec --bind /scratch example.sif ls /scratch + +.. figure:: img/bind_example.png + + Figure 2: Binding a directory inside a container + +Setting ``--bind``-argument works for ``apptainer run``- and +``apptainer shell``-commands as well. + +You can also bind directories to different places. This is especially +helpful if, for example. the code in container expects that data +should be in ``/data``: + +.. code-block:: console + + $ apptainer exec --bind /scratch:/data example.sif ls /data + +.. warning:: + + Bind mounts **are the same folders inside and outside** of the image. + + Deleting file from the folder that you bound inside the image will + delete the file completely. + +.. admonition:: Key points to remember + + - By default only some folders are bound inside the container. + - You'll need to manually ``--bind``-folders from outside of + the container if you want to use them inside the container. + - Bound folders are the same folders inside and outside of the + container. + diff --git a/_sources/building_images.rst.txt b/_sources/building_images.rst.txt new file mode 100644 index 0000000..4f6372b --- /dev/null +++ b/_sources/building_images.rst.txt @@ -0,0 +1,447 @@ +Building Apptainer images +========================= + +.. objectives:: + + - Learn how you can build container images + +In this session we'll discuss various ways you can create Apptainer images. + +Pulling an existing image from a container registry +--------------------------------------------------- + +We have already seen how to pull a +`Python image from Docker Hub `__. + +.. code-block:: console + + $ apptainer pull python.sif docker://python + +We could have alternatively used the full registry specification URL: + +.. code-block:: console + + $ apptainer pull python.sif docker://docker.io/library/python:latest + +The format for these registry specifications is: + +``docker://REGISTRY_URL/USER_NAMESPACE/IMAGE_NAME:IMAGE_TAG`` + +Here ``docker://`` means that we use a Docker Hub compatible container +registry. There are other compatible registries such as +`quay `__ and +`GitHub container registry `__. + +You can read the command like this: + +.. figure:: img/pull_example.png + + Figure 1: Pulling an image from a repository + + +Handling temporary layers needed by the build process +----------------------------------------------------- + +When Apptainer creates a ``.sif``-image it needs to first download any layers +it uses for the building. Then it will squash all of these layers to one +``.sif``-image. + +These are stored in a folder specified by an environment variable +``APPTAINER_CACHEDIR``. By default, Apptainer will use +``$HOME/.apptainer/cache``. This can result in you running out of quota +during the image creation process if the home folder quota is not big. + +You can set the cache directory with: + +.. code-block:: console + + $ mkdir apptainer_cache + $ export APPTAINER_CACHEDIR=$PWD/apptainer_cache + +It is adviced to select a location in some filesystem that has enough space available. +For instance a type of "scratch" area on your HPC. + +You can check the cache status with: + +.. code-block:: console + + $ apptainer cache list + +and you can clean the cache with: + +.. code-block:: console + + $ apptainer cache clean + +See `this page `__ +for more documentation. + + +Creating an image using a specification file +-------------------------------------------- + +Let's say we want to create an apptainer image for the following +``summation.py``-script: + +.. code-block:: python + + import argparse + + parser = argparse.ArgumentParser() + parser.add_argument( + "numbers", help="Numbers to sum", type=int, nargs='*' + ) + args = parser.parse_args() + + numbers = args.numbers + + if len(numbers) > 1: + print(f'Sum of numbers was: {sum(numbers)}') + else: + print('You did not give me any numbers to sum!') + + +Let's create a definition file for this image: + +.. code-block:: singularity + + Bootstrap: docker + From: python:latest + + %files + summation.py /opt + + %runscript + echo "Got arguments: $*" + exec python /opt/summation.py "$@" + +In this definition file we specify: + +1. The bootstrapping method we want to use to build the image. +2. The base image we want to use for bootstrapping. +3. Files we want to copy to the image in the ``%files``-block. +4. Commands we want to run when the image is ran in the ``%runscript``-block. + +Now we can built this image with: + +.. code-block:: console + + $ apptainer build my_container.sif my_container_definition.def + +.. figure:: img/build_example.png + + Figure 2: Building an image from a definition file + +After building the image we can test out the image with: + +.. code-block:: console + + $ apptainer run my_container.sif 1 2 + +This will run the default set of commands specified in the `%runscript` block in +the Apptainer definition file. The two arguments we send into the +shell environment of the container, namely the numbers 1 and 2 are used by the +executable in the runscript. + +.. admonition:: Expected result + :class: dropdown + + Building container should result in a container image + ``my_container.sif`` being created. + + Running the container should produce the following output: + + .. code-block:: console + + $ apptainer run my_container.sif 1 2 + Got arguments: 1 2 + Sum of numbers was: 3 + + +.. admonition:: Key points to remember + + - Bootstrap settings are analogous to what you would use with + ``apptainer pull``. + - The application inside the container could be much more complex. + By creating a ``apptainer run``-interface via ``%runscript``-block + you can convert a big and complex installation into what is + basically a single executable. + +Running additional installation commands during image creation +-------------------------------------------------------------- + +More often than not, creating an image involves more than +just using an existing image. + +If you want to run additional installation commands, +you can do them in a ``%post``-block. These commands will +be run once during the building procedure. + +For example, let's modify our definition file so that we get an installation +of `numpy `__-package in the image: + +.. code-block:: singularity + + Bootstrap: docker + From: python:latest + + %files + summation.py /opt + + %runscript + echo "Got arguments: $*" + exec python /opt/summation.py "$@" + + %post + pip install numpy + +After re-building the image we can test the numpy installation with: + +.. code-block:: console + + $ apptainer exec my_container.sif python -c 'import numpy; print(numpy.__version__)' + +.. admonition:: Expected result + :class: dropdown + + During the build process we should see that the numpy-package is + being installed. + + Running the container should produce the following output: + + .. code-block:: console + + $ apptainer exec my_container.sif python -c 'import numpy; print(numpy.__version__)' + 1.26.4 + +.. admonition:: Image building is done as a fake root-user + + Commands that are run in the ``%post`` step and in other setup steps + are run in a state called + `fakeroot `__ where + the user looks like the ``root``-user inside the container when in reality + the user is a normal user. + + This means that use of ``sudo`` is not needed when installing packages via + package managers. + + When converting installation instructions written for normal + non-containerized installations to definition files + one should usually remove ``sudo`` from the front of commands. + +.. warning:: + + Remember that images should not contain any secrets + (passwords, sensitive code or data etc.)! + + Anybody who has access to the image can access all files + in the image. + + +Setting environment variables in the image +------------------------------------------ + +We can also specify that additional environment variables should be set +when the image is being launched with an ``%environment``-block. + +While ``%runscript`` only applies when we ``apptainer run`` the image, +commands specified in the ``%environment``-block will be executed when +the image is launched. + +Let's use this opportunity to set the terminal language options +in the container. Usually containers do not have all available language +settings installed, so setting these environment variables is very common. + +.. code-block:: singularity + + Bootstrap: docker + From: python:latest + + %files + summation.py /opt + + %runscript + echo "Got arguments: $*" + exec python /opt/summation.py "$@" + + %post + pip install numpy + + %environment + export LC_ALL=C + export LANGUAGE=C + export LANG=C + +After re-building the image we can test that the environment values is set with: + +.. code-block:: console + + $ apptainer exec my_container.sif python -c 'import os; print(os.getenv("LANG"))' + + +.. admonition:: Expected result + :class: dropdown + + After rebuilding the container running the container should produce the following output: + + .. code-block:: console + + $ apptainer exec my_container.sif python -c 'import os; print(os.getenv("MYVAR"))' + yes + +You can also set environment variables when running an image by +setting ``APPTAINERENV_MYVAR=myvalue`` outside of the container or +by giving ``--env MYVAR=myvalue`` as a flag to the +``run``/``exec``/``shell``-command. + +For more info on how to set environment variables when running containers, +see `this page `__ +from Apptainer's documentation. + +.. _documentation: + +Adding documentation to your image +---------------------------------- + +If you're planning on sharing your image with other people or you want to +keep tabs on multiple images you can use labels to mark your image with +a ``%labels``-block. + +You can also add a ``%help``-block that will tell users on how to use your +image. + +Let's add these blocks to the definition file: + + +.. code-block:: singularity + + Bootstrap: docker + From: python:latest + + %files + summation.py /opt + + %runscript + echo "Got arguments: $*" + exec python /opt/summation.py "$@" + + %post + pip install numpy + + %environment + export LC_ALL=C + export LANGUAGE=C + export LANG=C + + %labels + Author: CodeRefinery + Version: v0.0.1 + Description: This is an example image + + %help + This container sums up numbers. + + Example: + + apptainer run my_container.sif 1 2 + + +Let's check the help message with: + +.. code-block:: console + + $ apptainer run-help my_container.sif + +.. admonition:: Expected result + :class: dropdown + + The output should look something like this: + + .. code-block:: console + + $ apptainer run-help my_container.sif + This container sums up numbers. + + Example: + + apptainer run my_container.sif 1 2 + + +Examining the container +----------------------- + +Now that we have a container with some software in it we can examine it with + +.. code-block:: console + + $ apptainer inspect my_container.sif + +.. admonition:: Expected result + :class: dropdown + + The output should look something like this: + + .. code-block:: console + + $ apptainer inspect my_container.sif + Author:: CodeRefinery + Description:: This is an example image + Version:: v0.0.1 + org.label-schema.build-arch: amd64 + org.label-schema.build-date: Thursday_25_April_2024_21:45:51_EEST + org.label-schema.schema-version: 1.0 + org.label-schema.usage.apptainer.version: 1.3.0 + org.label-schema.usage.singularity.deffile.bootstrap: docker + org.label-schema.usage.singularity.deffile.from: python:latest + +We can also see the image contents with + +.. code-block:: console + + $ apptainer sif list my_container.sif + +.. admonition:: Expected result + :class: dropdown + + Output of the command should be something like this: + + .. code-block:: console + + $ apptainer sif list my_container.sif + ------------------------------------------------------------------------------ + ID |GROUP |LINK |SIF POSITION (start-end) |TYPE + ------------------------------------------------------------------------------ + 1 |1 |NONE |32176-32385 |Def.FILE + 2 |1 |NONE |32385-34957 |JSON.Generic + 3 |1 |NONE |34957-35407 |JSON.Generic + 4 |1 |NONE |36864-394522624 |FS (Squashfs/-System/amd64) + + +From the output of the previous command we see that at position 1 of the file we have +the definition file used to build the image. We can examine that with + +.. code-block:: console + + $ apptainer sif dump 1 my_container.sif + + +Additional definition file options +---------------------------------- + +There are plenty of other sections that can be used in the definition +file. For a great and comprehensive documentation, see +`Apptainer's documentation for definition files `__. + +These features include: + - Creating multiple callable applications in the image + - Creating services that can be started and stopped + - Creating tests for the image build + + +.. admonition:: Key points to remember + + - Use ``apptainer pull`` to pull existing Docker images. + - Use ``apptainer build`` to build custom images from definition files. + - Do not store secret information in images. + - There are plenty of additional features provided. Check documentation + for more info. diff --git a/_sources/container_images.rst.txt b/_sources/container_images.rst.txt new file mode 100644 index 0000000..bd97d1d --- /dev/null +++ b/_sources/container_images.rst.txt @@ -0,0 +1,128 @@ +Intro to container images +========================= + +.. objectives:: + + * Learn what container image means + +Traditional container images (Docker etc.) +------------------------------------------ + +When containers launch they need a file system with a linux operating system. +This filesystem is provided by a **container image**. + +This naming comes from an analogy with a traditional image or a painting. + +.. figure:: https://upload.wikimedia.org/wikipedia/commons/6/6d/Saint_Jerome_Leonardo_-_image_only_%28Q972196%29.jpg + :width: 60% + + Figure 1: Saint Jerome in the Wilderness by Leonardo da Vinci + +Let's consider the image above. It is an unfinished painting by Leonardo da Vinci. + +From the unfinished nature of this painting you can see the following: + +- Some areas of the background panel are not touched at all (e.g. hands). +- The base background is in some places covered by sketches (e.g the lion) and in most places by the background colors. +- The background colors are sometimes covered in sketches as well (e.g. top left). + +From these things we can gather that the image is constructed from **layers** where +paint or sketches **cover what is hidden underneath**. + +This analogy happens with traditional container images as well (e.g. docker images): +**container images consist of multiple layers where top layers can hide preceding layers**. + +A typical image might look something like this: + +.. figure:: img/image_explanation.png + + Figure 2: Typical container image consists of individual layers + +In practice this overwriting behaviour is done by using a file format called SquashFS, +where file systems are stored in one single layer. + +In a traditional image the image is built in this fashion: + +1. The build starts from a base image. This is often an OS image, but it does not have to + be. It can be some other image that has a OS image as its base image. +2. This layer is started up in a container. +3. Modifications are done. For example, an application is installed. +4. The **difference of what files were modified is stored into a new layer**. +5. This new image with the modifications is now used as a base image. +6. More modifications are done unless there are no more modifications to do. +7. The last layer is **tagged** with some human readable name. +8. When image is published to other users, it is sent to some container registry. + +The file that contains the commands that need to be run to build the image +is called a `Dockerfile `__. +This is true for systems other that Docker as well. + +This way of working with **differences of layers** reduces the space needed to +store the images and the network capacity needed to transfer the images. + +When a container is launched these layers are fetched and organized on top of each +other and when a program tries to find a file, it will go through the layers until it +finds it. This is analogous to light bouncing off from the top layer of paint on a +painting. Paint below the top layer is hidden. + +.. admonition:: Key points to remember + + - Traditional containers are built layer by layer. + - Traditional containers are built from Dockerfiles. + - Traditional container images are transferred via registries using + client tools or as ``.tar``-files. + +Apptainer container images +-------------------------- + +Apptainer works a bit differently than traditional container setups. + +Apptainer stores the container image in one file in +**Singularity image format** or **.sif**. This file is a SquashFS file with +additional metadata included. + +This means that **Apptainer does not store image as multiple layers**. +Instead it writes all of the layers into one single layer. This is analogous +to printing an image of a painting on a piece of paper. The hidden layers +of paint are not replicated and only the topmost layer is visible. + +.. figure:: img/image_explanation_apptainer.png + + Figure 3: Apptainer container image is a single unchanging image layer + +This way of working has some upsides and some downsides. + +Upsides include: + +- The image is more portable. One image can be easily transferred across + systems using normal file copying tools. +- The image is more reproducible. The metadata stored in the file gives + information on when the image was created and what commands were used + to create it. +- The image is easier to archive. One just needs to keep track of a single + file. + +Downsides include: + +- Image creation takes longer as all operations need to be done in one go. + Traditional container images can be built layer by layer. +- Images cannot be stored in traditional registries like Docker Hub. + +Apptainer images can use Docker images as their starting point. +Additional build steps and runtime behaviour can be specified in a +`definition file (.def) `__. + +.. admonition:: Key points to remember + + - Apptainer images are a single image layer which is stored in a .sif-file. + - When built from traditional image, Apptainer images squash all layers to a single one. + - Apptainer images are built from definition file (.def). + - Apptainer images are transferred as normal files. + + +Image sources +------------- + +- Leonardo da Vinci, `CC0 `__, via `Wikimedia Commons `__ + + diff --git a/_sources/first_build.rst.txt b/_sources/first_build.rst.txt new file mode 100644 index 0000000..3832cc5 --- /dev/null +++ b/_sources/first_build.rst.txt @@ -0,0 +1,69 @@ +Building Your First Container +============================= + +.. objectives:: + + * Understand the basic concept and utility of containerization in HPC environments. + * Learn to create an Apptainer container using a definition file. + * Apply this knowledge to build reproducible computing environments. + + In this demo, you will learn how to build your first container using Apptainer, starting from a simple definition file. Containers are crucial for creating reproducible, portable, and scalable environments that are isolated from the underlying infrastructure. This hands-on example will guide you through the process of defining and building a basic container, which is a foundational skill in using containers effectively in high-performance computing. + +.. prerequisites:: + + * No prerequisites for following the demo + + +Building your first container is a significant first step to test the technology and make sure it works in the cluster(s) you use. This example is based on the typical case when you need to install and run a specific tool which cannot be easily installed by your HPC cluster admins. This can happen if certain tools are really tight to some specific system-wide dependencies (e.g. certain versions of libraries, compilers, operating system). + + +For the sake of learning, assume that the three tools ``fortune``, ``cowsay``, and ``lolcat`` cannot be installed by your cluster admins, and have strict requirements that you cannot just install them by yourself without root privileges. + + +.. code-block:: bash + + # Example definition file content for Apptainer + Bootstrap: docker + From: ubuntu:24.04 + + %post + apt-get -y update + apt-get -y install fortune cowsay lolcat + + %environment + export LC_ALL=C + export PATH=/usr/games:$PATH + + %runscript + fortune | cowsay | lolcat + + # Save the above content into a file named 'mydefinition.def' + + +Next we need to build the container image. + +.. code-block:: bash + + # Build an Apptainer container from a definition file + apptainer build mycontainer.sif mydefinition.def + + + +This command constructs a container named 'mycontainer.sif' from the definition file 'mydefinition.def'. The ``.sif`` file format is a portable container format used by Apptainer. This step is essential as it compiles all the necessary components and software specified in your definition file into a single executable container. + +Summary +------- +This example showed you how to build a basic container using Apptainer from a definition file. You've learned a critical skill in containerization, enabling you to create reproducible and portable environments for a wide range of scientific applications. This capability is foundational in leveraging the full potential of HPC resources while ensuring consistency across different computing environments. + + +.. exercise:: Build a simple container and test it + + Build a simple container on your cluster. You do not have to use the example above. Test the following: + + 1. Start a terminal shell on the container and run a command such as ``date`` + 2. Test the `runscript` part for the container above. How do you run it and what is the output? + 3. Add the `%labels` and `%help` block and test them as explained in the "Building Apptainer Images" section + 4. Copy paste all terminal commands and output from the three point above into a text file that you can submit as homework. + + + diff --git a/_sources/gpus.rst.txt b/_sources/gpus.rst.txt new file mode 100644 index 0000000..661e7de --- /dev/null +++ b/_sources/gpus.rst.txt @@ -0,0 +1,140 @@ +Running containers that use GPUs +================================ + +.. objectives:: + + * Learn how you can use GPUs with containers + +If your program uses GPUs, you'll need to make the GPUs visible in +the container. This is done by giving additional flag to the +apptainer command. + +The container itself must have the correct GPU computing libraries +installed inside the image (CUDA toolkit for NVIDIA and ROCm for AMD). +Code inside the image needs to be installed with GPU support as well. +Apptainer will only mount the driver libraries and the GPU devices +that these toolkits need to run the code on GPUs. + +Using NVIDIA's GPUs +******************* + +When using NVIDIA's GPUs that use the CUDA-framework the flag is ``--nv``. + +As an example, let's get a CUDA-enabled PyTorch-image: + +:download:`accelerate_cuda.def `: + +.. literalinclude:: /examples/accelerate-cuda.def + :language: singularity + + +Now when we launch the image, we can give the image GPU access with + +.. code-block:: console + + $ apptainer exec --nv pytorch-cuda.sif python -c 'import torch; print(torch.cuda.is_available())' + +.. figure:: img/nv_example.png + + Figure 1: Enabling NVIDIA's GPUs in containers + +.. admonition:: Expected result + :class: dropdown + + If you run this in a system with an NVIDIA GPU, you should see the following result: + + .. code-block:: console + + $ apptainer exec --nv pytorch-cuda.sif python -c 'import torch; print(torch.cuda.is_available())' + True + + +Using AMD's GPUs +**************** + +When using AMD's GPUs that use the ROCm-framework the flag is ``--rocm``. + +As an example, let's get a ROCm-enabled PyTorch-image: + +.. code-block:: console + + $ apptainer pull pytorch-rocm.sif docker://docker.io/rocm/pytorch:rocm6.1_ubuntu22.04_py3.10_pytorch_2.1.2 + +Now when we launch the image, we can give the image GPU access with + +.. code-block:: console + + $ apptainer exec --rocm pytorch-rocm.sif python -c 'import torch; print(torch.cuda.is_available())' + +.. figure:: img/rocm_example.png + + Figure 2: Enabling AMD's GPUs in containers + + +.. admonition:: Expected result + :class: dropdown + + If you run this in a system with an AMD GPU, you should see the following result: + + .. code-block:: console + + $ apptainer exec --rocm pytorch-rocm.sif python -c 'import torch; print(torch.cuda.is_available())' + True + + +Example container: Model training with accelerate +************************************************* + +`Accelerate `__ +is a library designed for running distributed PyTorch code. + +Let's create a container that can run a simple training example +that can utilizes multiple GPUs. + +Container starts from an existing container with PyTorch installed +and installs a few missing Python packages: + +:download:`accelerate_cuda.def `: + +.. literalinclude:: /examples/accelerate_cuda.def + :language: singularity + +Submission script that launches the container looks like this: + +:download:`run_accelerate_cuda.sh `: + +.. literalinclude:: /examples/run_accelerate_cuda.sh + :language: slurm + +.. tabs:: + + .. tab:: Triton (Aalto) + + To build the image: + + .. code-block:: console + + $ srun --mem=32G --cpus-per-task=4 --time=01:00:00 apptainer build accelerate_cuda.sif accelerate_cuda.def + + To run the example: + + .. code-block:: console + + $ wget https://raw.githubusercontent.com/huggingface/accelerate/refs/heads/main/examples/nlp_example.py + $ sbatch run_accelerate_cuda.sh + $ cat accelerate_cuda.out + Some weights of BertForSequenceClassification were not initialized from the model checkpoint at bert-base-cased and are newly initialized: ['classifier.bias', 'classifier.weight'] + You should probably TRAIN this model on a down-stream task to be able to use it for predictions and inference. + You're using a BertTokenizerFast tokenizer. Please note that with a fast tokenizer, using the `__call__` method is faster than using a method to encode the text followed by a call to the `pad` method to get a padded encoding. + epoch 0: {'accuracy': 0.7598039215686274, 'f1': 0.8032128514056225} + epoch 1: {'accuracy': 0.8480392156862745, 'f1': 0.8931034482758621} + epoch 2: {'accuracy': 0.8406862745098039, 'f1': 0.888507718696398} + +Review of this session +********************** + +.. admonition:: Key points to remember + + - Code inside the container image needs to support GPU calculations. + - Container image should have a working CUDA / ROCm toolkit installed. + - Use ``--nv`` / ``--rocm``-flag to mount the device drivers inside of the image. diff --git a/_sources/index.rst.txt b/_sources/index.rst.txt new file mode 100644 index 0000000..7d64d50 --- /dev/null +++ b/_sources/index.rst.txt @@ -0,0 +1,120 @@ +Containers on HPC with Apptainer +================================ + +.. admonition:: Course instance in May 2024 + + You can follow the dates this course is given on the `course page + `__. + Dates are not yet known and registration is not yet open, though. + + +Improve your cluster workflows! You've had a basic course on working +with a cluster - but what do people *actually* do? This course shows +practical examples and tips which may help you, but aren't usually +covered in either basic or advanced courses. + +We won't go so deep into each topic that you know everything about it, +but you learn what is possible, see some examples, and know where to +follow up on the tools that are right for *you*. The format is +designed to be "fireside chat with experts", a combination of demos, +type-along, and independent exercises. You can engage at different +levels, depending on your interest. + + +.. prereq:: + + * Basic HPC usage course (if you don't have, many of the things we + talk about won't make sense, but you might pick up something + anyway). + * A bit of experience using a HPC cluster (technically optional, + but will allow you to engage with the material at a deeper + level). + * Access to some HPC computer cluster to do most exercises. + (Slurm-based, but most are these days). (If you don't have, you + can't do all exercises - but still might learn something!) + + +.. csv-table:: + :widths: auto + :delim: ; + + 15 min ; :doc:`intro_and_motivation` + 20 min ; :doc:`basics_running_containers` + 15 min ; :doc:`container_images` + 10 min ; Break + 25 min ; :doc:`building_images` + 15 min ; :doc:`binding_folders` + 05 min ; Open discussion and where to go next + + +.. toctree:: + :maxdepth: 1 + :caption: The lesson + + intro_and_motivation.rst + basics_running_containers.rst + container_images.rst + building_images.rst + binding_folders.rst + mpi.rst + gpus.rst + sharing.rst + + +.. toctree:: + :maxdepth: 1 + :caption: Extras + + services_apps.rst + tips_tricks.rst + + + +.. toctree:: + :maxdepth: 1 + :caption: Exercises + + verify_installation.rst + first_build.rst + python_exercise.rst + + + +.. _learner-personas: + +Who is the course for? +---------------------- + +This course is for people using clusters or other larger computing +resources. It's not a basic course, but also not extremely advanced. +It lets you see some examples and know what people actually do, and +then you can follow up with more reading, courses, or direct help +later on. + +Some learner personas: + +- You've just taken a basic HPC course, and while you mostly + understand how the basic pices work, you are left wondering *"How + does this all fit together? How do people combine all of these + tools into an actual whole workflow?"*. + + You care about some real examples and things you can use right now, + but wouldn't mind seeing some advanced or out-of-scope stuff as long + as you don't have to spend too much mental effort on it. + + You'll probably do the more basic exercises and watch the rest as a + demo until you come back to it later (if needed). + +- You've been using the cluster for a while and doing your work just + fine - or so you think. It works well, but you know there must be + some other tricks out there that can make your life (if not work) + even better. + + You'll probably attend and do the more advanced exercises, while + passively watching some of the more basic demos. + + +About the course +---------------- + +This lesson is part of `Tuesday Tools & Techniques for High Performance Computing `_. diff --git a/_sources/intro_and_motivation.rst.txt b/_sources/intro_and_motivation.rst.txt new file mode 100644 index 0000000..1639ff8 --- /dev/null +++ b/_sources/intro_and_motivation.rst.txt @@ -0,0 +1,138 @@ +Intro to containers (on HPC) +============================ + +.. objectives:: + + * Understand the basic logic and terms behind container technology + * Learn about the possible use cases for containers on HPC clusters + +What even is a container? +------------------------- + +Containers take their name from shipping containers: + +.. figure:: https://upload.wikimedia.org/wikipedia/commons/3/36/Shipping_container%2C_Bellarena_-_geograph.org.uk_-_1859736.jpg + + Figure 1: A shipping container in its natural habitat + +This analogue is based on the idea is that containers have a barrier +between the insides of the container and outside of the container. +This makes shipping them between ports easy. + +Based on this analogue one might think that the container is just a +storage format. It is that as well: containers are stored in container +images (more on this in a later chapter). + +Instead it is a way of running **an application in a self-contained +environment with all the tools that this specific application needs**. + +More traditional container launchers like Docker, Podman and Kubernetes +also manage containers' resource usage, networking and various other aspects. +When using Apptainer, we do not need to worry about these features. + +.. admonition:: More technical information on how traditional containers work + :class: dropdown + + Traditional containers use + `linux namespaces `__ + when they implement various features. These features include: + + - **Creating a separate process identifier (PID) namespace:** + This means that process id's are not shared in the container and on + the host. + - **Creating a virtual network for the containers:** + Container runtimes such as docker often create virtual network + interfaces that the containers can use to communicate like actual + virtual machines. + - **Limiting container resources:** + Container runtimes usually limit container resource usage + (CPU usage, RAM usage) via Linux control groups (cgroups). + + Apptainer does none of these as it is meant to be run as a normal + user and not as a superuser. + + Apptainer does use + `user namespaces `__ + for launching the container without giving the user additional privileges. + + +Let's consider the following case: + +1. User installs and runs an application on a their home computer +2. They want to run the exact same application on their HPC cluster +3. The operating system / available software is different on the HPC cluster +4. Even if the program runs, it is necessarily not the **exact same program** as operating system has changed + +.. figure:: img/normal_application.png + + Figure 2: Without containers, your program uses libraries from the host system + +With containers the user would run the exact same container on both systems: + +.. figure:: img/containerized_application.png + + Figure 3: With containers, your program uses libraries from the container image + +The OS that launches the container is often called **the host** and +the container that is launched is called **a guest**. + +.. admonition:: Key points to remember + + Containers are a way of launching applications in a self-contained + environment with their own OS and program libraries. + + The filesystem used by containers is stored in container images. We'll talk + more on container images later. + + Remember that the word container can refer to: + - a running container with it's own environment + - the container image that defines the container environment + + **Host** refers to the OS that launches the container, **guest** + refers to the launched container. + + +What is the intended use case of Apptainer? +------------------------------------------- + +Apptainer is meant for running complex applications in various systems such +as HPC systems in a reproducible and portable way. + +There are many uses, but here are some example: + +- Installing an application that has installation instructions designed for a specific operating system different than the one you are on. +- Creating a self-contained application that can be used as a part of your + workflow in multiple different systems and can easily be shared with colleagues +- Creating a finished application that can be shared with your paper +- Reducing the amount of files needed to install an application by putting + all files in the image (especially useful for Python environments) + + +Apptainer vs. Singularity +------------------------- + +Singularity started as an open source project from Lawrence Berkeley National +Laboratory in 2015. In 2018 a company called Sylabs was founded to provide +commercial support for sites that use it. + +In 2021 the project joined Linux Foundation and was renamed Apptainer. + +Sylabs is still present and they maintain their own fork of the project called +SingulartyCE. + +For more info, see the +`Singularity wikipedia article `__. + +.. admonition:: Key points to remember + + Your site might be running Singularity, SingularityCE or Apptainer. + + In most cases the user interface is completely the same. + + If you're running ``singularity`` you can just rename any + ``apptainer``-commands to ``singularity``. + +Image sources +------------- + +- Shipping container, Bellarena by Rossographer, `CC BY-SA 2.0 `__, via `Wikimedia Commons `__ diff --git a/_sources/mpi.rst.txt b/_sources/mpi.rst.txt new file mode 100644 index 0000000..ecd905e --- /dev/null +++ b/_sources/mpi.rst.txt @@ -0,0 +1,502 @@ +MPI programs and containers +=========================== + +.. objectives:: + + * Learn what complications are involved with MPI containers + * Learn how to generate a MPI container for your HPC system + + +What to consider when creating a container for MPI programs? +------------------------------------------------------------ + +Message Passing Interface (MPI) is a standardized API and a programming +paradigm where programs can use MPI directives to send messages +across thousands of processes. It is commonly used in traditional +HPC computing. + +To handle the scale of the MPI programs the MPI installations +are typically tied to the high-speed interconnect available in +the computational cluster and to the queue system that the cluster +uses. + + +This can create the following problems when an MPI program +is containerized: + +1. Launching of the MPI job can fail if the program does not + communicate with the queue system. +2. The MPI communication performance can be bad if the program + does not utilize the high-speed interconnects correctly. +3. The container can have portability issues when taking it to + a different cluster with different MPI, queue system or + interconnect. + +To solve these problems we first need to know how MPI works. + + +How MPI works +------------- + +The launch process for an MPI program works like this: + +1. A reservation is done in the queue system for some number + of MPI tasks. +2. When the reservation gets the resources, individual MPI + programs are launched by the queue system (``srun``) or + by an MPI launcher (``mpirun``). +3. User's MPI program calls the MPI librarires it was built + against. +4. These libraries ask the queue system how many other MPI + tasks there are. +5. Individual MPI tasks start running the program collectively. + Communication between tasks is done via fast interconnects. + +.. figure:: img/mpi_job_structure.png + :width: 100% + + Figure 1: How MPI programs launch + +To make this work with various different queue systems and +various different interconnects MPI installations often +utilize Process Management Interface (PMI/PMI2/PMIx) when +they connect to the queue system and Unified Communication X +when they connect to the interconnects. + +.. figure:: img/mpi_install_structure.png + :width: 100% + + Figure 2: How MPI installations are usually constructed + + +How to use MPI with a container +------------------------------- + +Most common way of running MPI programs in containers is +to utilize a +`hybrid model `__, +where the container contains the same MPI version as the host system. + +When using this model the MPI launcher will call the MPI +within the container and use it to launch the application. + +.. figure:: img/mpi_job_structure_hybrid.png + :width: 100% + + Figure 3: Hybrid MPI job launch + +Do note that the MPI inside the container does not necessarily +know how to utilize the fast interconnects. We'll talk about +solving this later. + + +Creating a simple MPI container +------------------------------- + +Let's construct an example container that runs a simple +MPI benchmark from +`OSU Micro-Benchmarks `__. +This benchmark suite is useful for testing whether the MPI +installation works and whether the MPI can utilize the fast +interconnect. + +Because different sites have different MPI versions the definition +files differ as well. Pick a definition file for your site. + +.. tabs:: + + .. tab:: Triton (Aalto) + + :download:`triton-openmpi.def `: + + .. literalinclude:: /examples/triton-openmpi.def + :language: singularity + + To build: + + .. code-block:: console + + srun --mem=16G --cpus-per-task=4 --time=01:00:00 apptainer build triton-openmpi.sif triton-openmpi.def + + To run (some extra parameters are needed to prevent launch errors): + + .. code-block:: console + + $ module load openmpi/4.1.6 + $ export PMIX_MCA_gds=hash + $ export UCX_POSIX_USE_PROC_LINK=n + $ export OMPI_MCA_orte_top_session_dir=/tmp/$USER/openmpi + $ srun --partition=batch-milan --mem=2G --nodes=2-2 --ntasks-per-node=1 --time=00:10:00 apptainer run openmpi-triton.sif + srun: job 3521915 queued and waiting for resources + srun: job 3521915 has been allocated resources + + # OSU MPI Bandwidth Test v7.4 + # Datatype: MPI_CHAR. + # Size Bandwidth (MB/s) + 1 3.98 + 2 8.05 + 4 15.91 + 8 32.03 + 16 64.24 + 32 125.47 + 64 245.52 + 128 469.00 + 256 877.69 + 512 1671.24 + 1024 3218.11 + 2048 5726.91 + 4096 8096.24 + 8192 10266.18 + 16384 11242.78 + 32768 11298.70 + 65536 12038.27 + 131072 12196.28 + 262144 12202.05 + 524288 11786.58 + 1048576 12258.48 + 2097152 12179.43 + 4194304 12199.89 + + + .. tab:: Puhti (CSC) + + :download:`puhti-openmpi.def `: + + .. literalinclude:: /examples/puhti-openmpi.def + :language: singularity + + To build: + + .. code-block:: console + + apptainer build puhti-openmpi.sif puhti-openmpi.def + + To run (some extra parameters are needed to prevent error messages): + + .. code-block:: console + + $ module load openmpi/4.1.4 + $ export PMIX_MCA_gds=hash + $ srun --account=project_XXXXXXX --partition=large --mem=2G --nodes=2-2 --ntasks-per-node=1 --time=00:10:00 apptainer run puhti-openmpi.sif + srun: job 23736111 queued and waiting for resources + srun: job 23736111 has been allocated resources + + # OSU MPI Bandwidth Test v7.4 + # Datatype: MPI_CHAR. + # Size Bandwidth (MB/s) + 1 5.17 + 2 10.47 + 4 20.89 + 8 41.63 + 16 82.00 + 32 166.40 + 64 310.73 + 128 477.56 + 256 1162.51 + 512 2250.29 + 1024 3941.94 + 2048 6174.39 + 4096 8029.47 + 8192 10120.93 + 16384 10632.41 + 32768 10892.60 + 65536 11609.92 + 131072 11778.05 + 262144 12015.96 + 524288 11970.93 + 1048576 12008.62 + 2097152 12050.35 + 4194304 12058.36 + + .. tab:: LUMI (CSC) + + :download:`lumi-mpich.def `: + + .. literalinclude:: /examples/lumi-mpich.def + :language: singularity + + Building images in not allowed on LUMI, so you need to + build this on your own laptop or some other machine: + + .. code-block:: console + + apptainer build lumi-mpich.sif lumi-mpich.def + + Afterwards copy the image to your work directory in LUMI. + + To use the fast interconnect you need to install + ``singularity-bindings``-module with EasyBuild: + + .. code-block:: console + + module load LUMI/23.09 EasyBuild-user + eb singularity-bindings-system-cpeGNU-23.09-noglibc.eb -r + + To run the example: + + .. code-block:: console + + $ module load LUMI/23.09 EasyBuild-user singularity-bindings + $ export SINGULARITY_BIND=$SINGULARITY_BIND,/usr/lib64/libnl-3.so.200 + $ srun --account=project_XXXXXXXXX --partition=dev-g --mem=2G --nodes=2-2 --ntasks-per-node=1 --time=00:10:00 singularity run lumi-mpich.sif + srun: job 8108520 queued and waiting for resources + srun: job 8108520 has been allocated resources + + # OSU MPI Bandwidth Test v7.4 + # Datatype: MPI_CHAR. + # Size Bandwidth (MB/s) + 1 2.03 + 2 4.09 + 4 8.17 + 8 16.23 + 16 32.64 + 32 65.57 + 64 130.49 + 128 260.55 + 256 492.28 + 512 983.37 + 1024 1965.42 + 2048 3924.00 + 4096 7823.52 + 8192 14349.54 + 16384 17373.03 + 32768 18896.90 + 65536 20906.04 + 131072 21811.68 + 262144 22228.01 + 524288 22430.80 + 1048576 22537.82 + 2097152 22592.50 + 4194304 22619.96 + + + .. tab:: Sigma2 (Norway) + + Follow `these instructions `__. + + +Utilizing the fast interconnects +-------------------------------- + +In order to get the fast interconnects to work with the hybrid model +one can either: + +1. Install the interconnect drivers into the image and build the MPI to + use them. This is the normal Hybrid approach described in Figure 3. +2. Mount cluster's MPI and other network libraries into the image and use + them instead of the container's MPI while running the MPI program. + This is described in Figure 4. + +.. figure:: img/mpi_job_structure_bound.png + :width: 100% + + Figure 4: Container with bound system MPI and network libraries + + +Below are explanations on how the interconnect libraries were provided. + +.. tabs:: + + .. tab:: Triton (Aalto) + + The interconnect support was provided by the ``libucx-dev``-package that + provides Infiniband drivers. + + :download:`triton-openmpi.def `, line 15: + + .. literalinclude:: /examples/triton-openmpi.def + :# Copy example from imagelanguage: singularity + :lines: 15 + + The OpenMPI installation was then configured to use these drivers: + + :download:`triton-openmpi.def `, line 26: + + .. literalinclude:: /examples/triton-openmpi.def + :language: singularity + :lines: 26 + + .. tab:: Puhti (CSC) + + The interconnect support is provided by installing drivers from + Mellanox's Infiniband driver repository: + + :download:`puhti-openmpi.def `, lines 27-38: + + .. literalinclude:: /examples/puhti-openmpi.def + :language: singularity + :lines: 27-38 + + .. tab:: LUMI (CSC) + + Module ``singularity-bindings`` mounts the system MPI and network drivers + into the container: + + .. code-block:: console + + $ module load LUMI/23.09 EasyBuild-user singularity-bindings + $ export SINGULARITY_BIND=$SINGULARITY_BIND,/usr/lib64/libnl-3.so.200 + $ echo $SINGULARITY_BIND + /opt/cray,/var/spool,/etc/host.conf,/etc/hosts,/etc/nsswitch.conf,/etc/resolv.conf,/etc/ssl/openssl.cnf,/run/cxi,/usr/lib64/libbrotlicommon.so.1,/usr/lib64/libbrotlidec.so.1,/usr/lib64/libcrypto.so.1.1,/usr/lib64/libcurl.so.4,/usr/lib64/libcxi.so.1,/usr/lib64/libgssapi_krb5.so.2,/usr/lib64/libidn2.so.0,/usr/lib64/libjansson.so.4,/usr/lib64/libjitterentropy.so.3,/usr/lib64/libjson-c.so.3,/usr/lib64/libk5crypto.so.3,/usr/lib64/libkeyutils.so.1,/usr/lib64/libkrb5.so.3,/usr/lib64/libkrb5support.so.0,/usr/lib64/liblber-2.4.so.2,/usr/lib64/libldap_r-2.4.so.2,/usr/lib64/libnghttp2.so.14,/usr/lib64/libpcre.so.1,/usr/lib64/libpsl.so.5,/usr/lib64/libsasl2.so.3,/usr/lib64/libssh.so.4,/usr/lib64/libssl.so.1.1,/usr/lib64/libunistring.so.2,/usr/lib64/libzstd.so.1,/lib64/libselinux.so.1,,/usr/lib64/libnl-3.so.200 + $ echo $SINGULARITYENV_LD_LIBRARY_PATH + /opt/cray/pe/mpich/8.1.27/ofi/gnu/9.1/lib-abi-mpich:/opt/cray/pe/lib64:/opt/cray/libfabric/1.15.2.0/lib64:/opt/cray/xpmem/default/lib64:/usr/lib64:/opt/cray/pe/gcc-libs + + .. tab:: Sigma2 (Norway) + + Interconnect support is not explicitly installed. + +ABI compatibility in MPI +------------------------ + +Different MPI installations do not have necessarily have +application binary interface (ABI) compatibility. This means +that software built with certain MPI installation does not +necessarily run with another MPI installation. + +Quite often MPI programs are built with the same version +of MPI that will be used to run the program. However, in +containerized applications the runtime MPI version might change +if an outside MPI is bound into the container. + +This can work as there is some ABI compatibility +within an MPI family (OpenMPI, MPICH). For more info, see +`OpenMPI's page on version compatibility `__ +and +`MPICH's ABI Compatibility Initiative `__. + +There are also projects like +`E4S Container Launcher `__ +and +`WI4MPI (Wrapper Interface for MPI) `__ +that aim to bypass this problem by creating a wrapper interfaces +that the program in the container can be built against. This +wrapper can then use different MPI implementations during +runtime. + +Example on portability: LAMMPS +------------------------------ + +LAMMPS is a classical molecular dynamics simulation code with a focus +on materials modeling. + +Let's build a container with LAMMPS in it: + + +:download:`lammps-openmpi.def `: + +.. literalinclude:: /examples/lammps-openmpi.def + :language: singularity + +Let's also create a submission script that runs a LAMMPS example +where an indent will pushes against a material: + +:download:`run_lammps_indent.sh `: + +.. literalinclude:: /examples/run_lammps_indent.sh + :language: slurm + +Now this exact same container can be run in both Triton / Puhti that have +OpenMPI installed because both clusters use Slurm and InfiniBand +interconnects. + +.. tabs:: + + .. tab:: Triton (Aalto) + + To build the image: + + .. code-block:: console + + $ srun --mem=16G --cpus-per-task=4 --time=01:00:00 apptainer build lammps-openmpi.sif lammps-openmpi.def + + To run the example: + + .. code-block:: console + + $ export PMIX_MCA_gds=hash + $ export UCX_POSIX_USE_PROC_LINK=n + $ export OMPI_MCA_orte_top_session_dir=/tmp/$USER/openmpi + $ sbatch run_lammps_indent.sh + $ tail -n 27 lammps_indent.out + Loop time of 0.752293 on 4 procs for 30000 steps with 420 atoms + + Performance: 10336396.152 tau/day, 39878.072 timesteps/s, 16.749 Matom-step/s + 99.6% CPU use with 4 MPI tasks x 1 OpenMP threads + + MPI task timing breakdown: + Section | min time | avg time | max time |%varavg| %total + --------------------------------------------------------------- + Pair | 0.31927 | 0.37377 | 0.42578 | 7.5 | 49.68 + Neigh | 0.016316 | 0.020162 | 0.023961 | 2.3 | 2.68 + Comm | 0.19882 | 0.25882 | 0.31814 | 10.2 | 34.40 + Output | 0.00033215 | 0.00038609 | 0.00054361 | 0.0 | 0.05 + Modify | 0.044981 | 0.049941 | 0.054024 | 1.7 | 6.64 + Other | | 0.04921 | | | 6.54 + + Nlocal: 105 ave 112 max 98 min + Histogram: 1 0 1 0 0 0 0 1 0 1 + Nghost: 92.5 ave 96 max 89 min + Histogram: 1 0 1 0 0 0 0 1 0 1 + Neighs: 892.25 ave 1003 max 788 min + Histogram: 2 0 0 0 0 0 0 0 1 1 + + Total # of neighbors = 3569 + Ave neighs/atom = 8.497619 + Neighbor list builds = 634 + Dangerous builds = 0 + Total wall time: 0:00:01 + + .. tab:: Puhti (CSC) + + To build the image: + + .. code-block:: console + + $ apptainer build lammps-openmpi.sif lammps-openmpi.def + + To run the example: + + .. code-block:: console + + $ export PMIX_MCA_gds=hash + $ sbatch --account=project_XXXXXXX --partition=large run_lammps_indent.sh + $ tail -n 27 lammps_indent.out + Loop time of 0.527178 on 4 procs for 30000 steps with 420 atoms + + Performance: 14750222.558 tau/day, 56906.723 timesteps/s, 23.901 Matom-step/s + 99.7% CPU use with 4 MPI tasks x 1 OpenMP threads + + MPI task timing breakdown: + Section | min time | avg time | max time |%varavg| %total + --------------------------------------------------------------- + Pair | 0.22956 | 0.26147 | 0.28984 | 5.5 | 49.60 + Neigh | 0.012471 | 0.015646 | 0.018613 | 2.3 | 2.97 + Comm | 0.13816 | 0.17729 | 0.2192 | 9.3 | 33.63 + Output | 0.00023943 | 0.00024399 | 0.00025267 | 0.0 | 0.05 + Modify | 0.03212 | 0.035031 | 0.037378 | 1.2 | 6.65 + Other | | 0.0375 | | | 7.11 + + Nlocal: 105 ave 112 max 98 min + Histogram: 1 0 1 0 0 0 0 1 0 1 + Nghost: 92.5 ave 96 max 89 min + Histogram: 1 0 1 0 0 0 0 1 0 1 + Neighs: 892.25 ave 1003 max 788 min + Histogram: 2 0 0 0 0 0 0 0 1 1 + + Total # of neighbors = 3569 + Ave neighs/atom = 8.497619 + Neighbor list builds = 634 + Dangerous builds = 0 + Total wall time: 0:00:01 + + + +Review of this session +---------------------- + +.. admonition:: Key points to remember + + - MPI version should match the version installed to the cluster + - Cluster MPI module should be loaded for maximum compatibility with job launching + - Care must be taken to make certain that the container utilizes + fast interconnects diff --git a/_sources/python_exercise.rst.txt b/_sources/python_exercise.rst.txt new file mode 100644 index 0000000..942ba86 --- /dev/null +++ b/_sources/python_exercise.rst.txt @@ -0,0 +1,126 @@ +Python environment in a container +================================= + +.. objectives:: + + * Learn how to create a Python environment in an apptainer image + +Background +---------- + +Python environments are nowadays very popular due to the popularity of +Python as a scientific programming language. These environments can sometimes +be problematic for the filesystem as they require thousands of files. + +Exercise 1: Creating Python image with image's pip +-------------------------------------------------- + +.. exercise:: Install Python environment to base python image + + Use the base python image and install following packages to the image: + - python + - numpy + - pandas + + .. solution:: Solution + + Create the following definition file ``python_definition.def``: + + .. code-block:: singularity + + Bootstrap: docker + From: python:latest + + %post + # Python is already installed in the image + pip install numpy pandas + + You can then create the container with: + + .. code-block:: console + + $ apptainer build python_environment.sif python_definition.def + + You can test out the python with: + + .. code-block:: console + + $ apptainer run python_environment.sif python + + + + +Exercise 2: Creating conda/mamba environment in an image +-------------------------------------------------------- + +.. exercise:: Install an environment to an apptainer image using an optimized definition file + + Create an environment with this definition file customized for + environment creation: + + https://github.com/simo-tuomisto/micromamba-apptainer + + Install the following packages to the environment: + - python + - numpy + - pandas + + .. solution:: Solution + + Write the following ``environment.yml``: + + .. code-block:: yaml + + name: base + channels: + - conda-forge + dependencies: + - python + - numpy + - pandas + + Obtain the ``micromamba_apptainer.def`` bootstrap definition file from the repository: + + .. code-block:: singularity + + Bootstrap: docker + From: mambaorg/micromamba:latest + + %files + environment.yml /opt + + %post + micromamba install -q -y -n base -f /opt/environment.yml + + micromamba clean --all --yes + + %labels + EnvironmentFile: /opt/environment.yml + + %help + This container containes a Python environment created + from an environment file. + + To run Python from the environment: + + apptainer run my_environment.sif python + + To see the environment file used to create the environment: + + apptainer run my_environment.sif cat /opt/environment.yml + + To see what packags are in the environment: + + apptainer run micromamba list + + You can then create the container with: + + .. code-block:: console + + $ apptainer build my_environment.sif micromamba_apptainer.def + + You can test out the python with: + + .. code-block:: console + + $ apptainer run my_environment.sif python diff --git a/_sources/services_apps.rst.txt b/_sources/services_apps.rst.txt new file mode 100644 index 0000000..ef590d4 --- /dev/null +++ b/_sources/services_apps.rst.txt @@ -0,0 +1,178 @@ +Services and apps +================= + +What are services? +------------------ + +You can use Apptainer to launch services that run in +the background. Service might be, for example, a database +application that your code uses to fetch subsets from a +larger dataset. + +Creating containers for these kinds of services can +often be quite complicated as they might need specific +folders to be created or specific environment variables +to be set. + +What are apps? +-------------- + +When we're launching a complicated services or making +containers with more than one application we might also +want to specify multiple run scripts and entrypoints to +the container. + +This can be done in Apptainer containers by specifying +multiple apps in the definition file. + +Example: PostgreSQL container +----------------------------- + +The following example uses a +`PostgreSQL image `__ to +set up a PostgreSQL server. Launching the server requires +that certain directory mounts and environment variables are set. + +These have been found by looking at the +`docker-entrypoint.sh `__-script +that would start the image when using Docker. + +In the case of PostgreSQL, we'll most likely +want to use the PostgreSQL client to modify our databases. +We can do this by specifying an app for it. + +Let's look at the definition file: + +.. code-block:: singularity + + Bootstrap: docker + From: postgres:16 + + %environment + export LC_ALL=C + export LANG=C + export LANGUAGE=C + + %startscript + export POSTGRES_USER=$PGUSER + export POSTGRES_PASSWORD=$PGPASSWORD + export PGHOST=$HOSTNAME + export PGPORT=${PGPORT:-19200} + + # Run the entry script for PostgreSQL Docker image + exec docker-entrypoint.sh postgres "$@" + + %help + + This is a postgres container. + + The following data locations need to be mounted into the container: + + - Data location for the postgres: /var/lib/postgresql/data + - Location for the runfiles for postgres: /var/run/postgresql + + The start script needs the following arguments: + + - postgres user name + - postgres user password + + Usage: + + mkdir postgres_data + mkdir postgres_run + + export PGUSER=postgres_user + export PGPASSWORD=postgres_password + apptainer instance start --bind postgres_data:/var/lib/postgresql/data --bind postgres_run:/var/run/postgresql postgres_container.sif postgres_server + + apptainer instance list + + %apprun psql + export POSTGRES_USER=$PGUSER + export POSTGRES_PASSWORD=$PGPASSWORD + export PGHOST=$HOSTNAME + export PGPORT=${PGPORT:-19200} + exec psql "$@" + + %apphelp psql + Run psql-client in image + + PostgreSQL instance needs to be started beforehand + + Usage: + + export PGUSER=postgres_user + export PGPASSWORD=postgres_password + apptainer run --app psql instance://postgres_server -c 'create database test;' + apptainer run --app psql instance://postgres_server -c '\l' + +The definition file has couple of new blocks: + +- ``%startscript``: This block defines what commands will be run when we start up the service. +- ``%apprun``: This block allows us to specify individual applications in our image. In this + case we have an application called ``psql`` for the PostgreSQL client. This block specifies + how we run this specific application. +- ``%apphelp``: Each app in a container can have it's own help section as well as other + setup sections. See documentation for all possibilities. + +For more information on how to specify multiple apps in a container, see +`this documentation page `__. + +After building the image we can start the database with: + +.. code-block:: console + + $ mkdir postgres_data + $ mkdir postgres_run + $ export POSTGRES_USER=postgres_user + $ export POSTGRES_PASSWORD=postgres_password + $ apptainer instance start --bind postgres_data:/var/lib/postgresql/data --bind postgres_run:/var/run/postgresql postgres_container.sif postgres_server + + +.. figure:: img/instance_example.png + + Figure 1: Starting container as an instance + + +Now that we have started the instance we can check that the instance is running with: + +.. code-block:: console + + $ apptainer instance list + +Let's use the ``psql``-app that we have specified. We can use it to make a +connection to the server and to create a new database. Let's also list the +newly created database: + +.. code-block:: console + + $ export PGUSER=postgres_user + $ export PGPASSWORD=postgres_password + $ apptainer run --app psql instance://postgres_server -c 'create database test;' + $ apptainer run --app psql instance://postgres_server -c '\l' + +.. figure:: img/app_run_example.png + + Figure 2: Running an app from a container + + +You'll notice that we did not start a new container. Instead ran the application in +the running instance by specifying ``instance://postgres_server`` instead of the +``.sif``-image. You'll also note that we did not need to specify the bind-mounts +again: once the instance is started, bind mounts are made and they are there until +the instance is stopped. + +We can then shut down the server with: + +.. code-block:: console + + $ apptainer instance stop postgres_server + +.. admonition:: Key points to remember + + - You can start containers as instances. + - You can use ``%startscript``-block to specify how an instance should start. + - You can create multiple apps in a container with ``%app*``-blocks + - Started instances with bind mounts have them until instance is stopped. + This is very useful if you plan on running multiple commands against a + single container. diff --git a/_sources/sharing.rst.txt b/_sources/sharing.rst.txt new file mode 100644 index 0000000..64c4453 --- /dev/null +++ b/_sources/sharing.rst.txt @@ -0,0 +1,452 @@ +Sharing reproducible containers +=============================== + +.. objectives:: + + - Know about **good practices** for creating reproducible containers + - Know about some **popular services** to share container definition files and images + +In this lesson we will go through a handful of guidelines and tips that will help you to create reproducible containers which can be shared today and hopefully years into the future. + +We will encourage you to + +- :ref:`Reuse ` +- :ref:`Be specific ` +- :ref:`Separate concerns ` +- :ref:`Document ` +- :ref:`Use version control and public registries ` + +And finally we will give you an exercise to practice your new skills. + +.. _reuse_label: +Reuse +----- + +As we have learned, building a container means that you pack the OS and all +the applications you need into a file. We have also learned that typically we +don't do everything from scratch, we **build upon base containers**. + +This means that when building containers we try to: + +- Use available base containers +- Add customisation on top of that + +An :doc:`example ` was using an official python image for our python container: + +.. code-block:: singularity + + Bootstrap: docker + From: python:latest + + %files + summation.py /opt + + %runscript + echo "Got arguments: $*" + exec python /opt/summation.py "$@" + + %post + pip install numpy + + +Here we use a `python base image `_ and in addition we install some more +software: numpy (and we copy our custom python script into the image). + +Building upon base-images is used extensively: The python image is not just python, it is again based on an another image, which itself is based on another image, and so on. + +To find the image dependency, you will need to do a bit of detective work, finding the image in a registry, and inspecting its Dockerfile which hopefully is linked from the registry. If there is no Dockerfile linked from the registry page, you may be out of luck. + +Example image dependency ++++++++++++++++++++++++++ + +Let's check the `Dockerhub python registry `_. We can click on the link of the latest bookworm tag (see DockerHub python tab below) which leads us to its `Dockerfile on Github `_ (as seen in the Dockerfile python tab). + +.. tabs:: + + .. tab:: DockerHub python + + .. figure:: img/dockerhub_python.png + + .. tab:: Dockerfile python + + .. figure:: img/dockerfile_python_image.png + +Inspecting this Dockerfile, we see that it again is based on a another image, namely ``buildpack-deps:bookworm``. + +We can do the same exercise for the image ``buildpack-deps:bookworm`` by finding the image in a registry like Dockerhub, navigating to the Dockerfile linked from that registry, and so on. + + +After all that, this is the image dependency tree we find for the original python docker base image: + +.. code-block:: + + --> From: python:latest + --> FROM: buildpack-deps:bookworm + --> FROM buildpack-deps:bookworm-scm + --> FROM buildpack-deps:bookworm-curl + --> FROM debian:bookworm + --> FROM scratch + + + +.. admonition:: Take-away message + + Check if there is a suitable official base image for the applications you need, and build upon that. + + + +Popular base images ++++++++++++++++++++ + +There probably exists a base image for your need, almost whatever it is. If you +web-search e.g. "best docker containers" you will find useful lists of popular +ones. Here is a customised selection of such a list - with some images we find +very useful: + +- `Alpine `_ (slim Linux OS) + +- `BusyBox `_ (slim Linux OS with many common Linux utilities) + +- `Nginx `_ (web server) + +- `Ubuntu `_ (Linux OS) + +- `Python `_ + +- `PostGreSQL `_ (database) + +- `Node `_ (web development) + +- `MySQL `_ (database) + +- `Jupyter datascience-notebook `_ + +Once you have found a suitable base image, you must think about what version to +chose. You will see that each image has a selection of different versions, so +which should you chose? We will explore this in the next section. + + +.. _be_specific_label: + +Be specific +----------- + +One of the main objectives of using images is that the users gets exactly what +they expect, and everything should just work. The container is after all +self-contained! + +During development you might want to have "latest" versions of software. But +"latest" is a moving target: "latest" today is not the same as "latest" in 2 +years. And now you can get into problems! Maybe the latest version of your +base image is not compatible with the other software the image has included. +Or which you are including. This can spoil the party massively! + + +.. admonition:: Take-away message + + When sharing/publishing a container, try to be as specific as you can! Always specify software versions. + + +Taking our python image as an example, a more future-proof definition file would specify the base image version as well as the numpy version. Compare these two: + +.. tabs:: + + .. tab:: With specific versions + + .. code-block:: singularity + :emphasize-lines: 2, 12 + + Bootstrap: docker + From: python:3.12.7-bookworm + + %files + summation.py /opt + + %runscript + echo "Got arguments: $*" + exec python /opt/summation.py "$@" + + %post + pip install numpy==1.26.0 + + .. tab:: Versions are not specified + + .. code-block:: singularity + :emphasize-lines: 2, 12 + + Bootstrap: docker + From: python:latest + + %files + summation.py /opt + + %runscript + echo "Got arguments: $*" + exec python /opt/summation.py "$@" + + %post + pip install numpy + + +Further below we have an exercise where we can practice recognizing future +problems in container definition files. + + +.. _separate_label: + +Separate concerns +----------------- + +Purpose +++++++++++ + +When creating you image definition file - have a think about what the image should contain based on what purpose it has. Do not be tempted to add software just because it is convenient for general use. + +For instance: an image that is used to run some specific scientific analysis on a specific input type of data may not need your favourite text editor inside. Or that extra python package just in case. + +Slim the image down to just what it needs for the purpose it fulfills. The benefit will be at least two-fold: the image will be lighter meaning it will be quicker to download and have smaller carbon-footprint. But in addition there is less software to potentially get into software dependency problems with. Another benefit: it will be clearer for the user what is the purpose of the image, and how to use it. + +.. admonition:: Stay to the point + + - Try to make your image as specific as possible + - Only add software that is needed for the specific purpose of the container + +Data ++++++++ + +The main purpose of a software image is exactly that - to provide software, not datasets. There are several reasons why it is not a good idea to include (potentially large) datasets, here are a few: + +- The image could become very heavy +- The data may better be stored in a suited data registry +- The data may be different from user to user +- The data may be sensitive and should only reside in a private and secure computing environment + +Instead of shipping the data with the image, let the user bind mount it into the container. Check out the :doc:`Binding folders into your container lesson ` for details. + +Compare the two apptainer definition files and how to run the resulting ``my_container.sif`` container. The right tab also exemplifies bind-mounting a folder for output data, which is useful in order to access the resulting output data directly from the host server. + +.. tabs:: + + .. tab:: Image including data + + .. code-block:: singularity + :emphasize-lines: 6,10,16 + + Bootstrap: docker + From: python:3.9-slim + + %files + process_data.py /app/process_data.py + input_data /app/input_data + + %post + mkdir /app/output_data + chmod 777 /app/output_data + + %runscript + python /app/process_data.py /app/input_data /app/output_data + + %help + Usage: apptainer run --writable-tmpfs this_container.sif + + .. tab:: Image not including data - using bind-mounts + + .. code-block:: singularity + :emphasize-lines: 9,15 + + Bootstrap: docker + From: python:3.9-slim + + %files + process_data.py /app/process_data.py + + %post + mkdir /app/output_data + mkdir /app/input_data + + %runscript + python /app/process_data.py /app/input_data /app/output_data + + %help + Usage: apptainer run --bind /path/to/host/input:/app/input_data,/path/to/host/output:/app/output_data this_container.sif + + +That said, there may be reasons why some particular data is better copied into the container. For instance some reference data that stays unchanged and that is needed for all analysis. + +.. admonition:: Data key practices + + - Avoid copying data into the container unless there are obvious benefits + + +.. _document_label: + +Document your image +----------------------------------- +In the example above you can see that some documentation is added in the image itself under the ``%help`` block. This is not only important for sharing, but also for yourself to help remember how to use the container. See more details in the :ref:`Adding documentation to your image `. + + +.. admonition:: Documentation key practices + + Always add documentation to your image. + + - Minimally how to use the container via the ``%help`` block + - In addition author, version, description via the ``%label`` block + + +.. _version_control_label: + +Use version control and public registries +----------------------------------------- + +.. admonition:: Key practices + + - **Track the changes to the definition** file with version control. In practice: Put the definition file on GitHub or GitLab. + - Make the container image findable by others. In practice: Put the image on a **public registry**. + - **Make sure one can find and inspect the definition file** from the registry. In practice: Link the repo to the public registry. + +In principle a definition file is enough to build a container image and in +theory we would not need to share pre-built images. But in practice it is very +**useful to share the pre-built image as well**. This is because: + +- Building a container image can take time and resources. +- If we were not careful specifying versions, the image might not build again + in the same way. +- Some dependencies might not be available anymore. + +There are many popular services to share container images and almost every +big-tech company offers one: + +- `Docker Hub `__: Default Docker registry with public/private repositories and CI/CD integration. +- `Google Container Registry (GCR) `__: GCP service, tightly integrated with Google Cloud services and Kubernetes. +- `Azure Container Registry (ACR) `__: Fully managed, integrated with Azure services like AKS and DevOps. +- `Quay.io `__: Red Hat service, security scanning, OpenShift/Kubernetes integration, public/private repositories. +- `JFrog Artifactory `__: Universal artifact repository supporting Docker and other formats, advanced security features. +- `Harbor `__: Open-source registry, role-based access control, vulnerability scanning, and image signing. +- `DigitalOcean Container Registry `__: Integrated with DigitalOcean Kubernetes. +- `GitLab Container Registry `__: Built into GitLab, works seamlessly with GitLab CI/CD pipelines. + +What many projects do (however, note the warning below): + +- Track their container definition files in a public repository on GitHub or GitLab. +- From these repositories, they build the container images and push them to a public registry (above list). + + +.. warning:: + + A public registry that is free today might not be free tomorrow. Make sure + you have a backup plan for your images and make sure the image can still be + found 5 years from now if the service provider changes their pricing model. + +.. admonition:: Recommendation to "guarantee" long-term availability + + - There are no guarantees, however: + - One of the most stable services is `Zenodo `__ which + is an excellent place to publish your container image as supporting + material for a publication and also get a DOI for it. It is unlikely to + change pricing for academic use. + - Make sure to also publish the definition file with it. + + +It is possible to host both the definition file and the image on GitHub: + + - You don't need to host it yourself. + - The image stays close to its sources and is not on a different service. + - Anybody can inspect the recipe and how it was built. + - Every time you make a change to the recipe, it builds a new image. + - We can practice/demonstrate this in the exercise below. + + +Exercises +--------- + +.. exercise:: Exercise Sharing-1: Time-travel with containers + + Imagine the following situation: A researcher has written and published their research code which + requires a number of libraries and system dependencies. They ran their code + on a Linux computer (Ubuntu). One very nice thing they did was to publish + also a container image with all dependencies included, as well as the + definition file (below) to create the container image. + + Now we travel 3 years into the future and want to reuse their work and adapt + it for our data. The container registry where they uploaded the container + image however no longer exists. But luckily (!) we still have the definition + file (below). From this we should be able to create a new container image. + + - Can you anticipate problems using the definition file here 3 years after its + creation? Which possible problems can you point out? + - Discuss possible take-aways for creating more reusable containers. + + .. tabs:: + + .. tab:: Python project using virtual environment + + .. literalinclude:: sharing/bad-example-python.def + :language: singularity + :linenos: + + .. solution:: + + - Line 2: "ubuntu:latest" will mean something different 3 years in future. + - Lines 11-12: The compiler gcc and the library libgomp1 will have evolved. + - Line 30: The container uses requirements.txt to build the virtual environment but we don't see + here what libraries the code depends on. + - Line 33: Data is copied in from the hard disk of the person who created it. Hopefully we can find the data somewhere. + - Line 35: The library fancylib has been built outside the container and copied in but we don't see here how it was done. + - Python version will be different then and hopefully the code still runs then. + - Singularity/Apptainer will have also evolved by then. Hopefully this definition file then still works. + - No help text. + - No contact address to ask more questions about this file. + - (Can you find more? Please contribute more points.) + + .. literalinclude:: sharing/bad-example-python.def + :language: singularity + :linenos: + :emphasize-lines: 2, 11-12, 30, 33, 35 + + .. tab:: C++ project + + This definition files has potential problems 3 years later. Further + down on this page we show a better and real version. + + .. literalinclude:: sharing/bad-example-cxx.def + :language: singularity + :linenos: + + .. solution:: + + - Line 2: "ubuntu:latest" will mean something different 3 years in future. + - Lines 9: The libraries will have evolved. + - Line 11: We clone a Git repository recursively and that repository might evolve until we build the container image the next time. + here what libraries the code depends on. + - Line 18: The library fancylib has been built outside the container and copied in but we don't see here how it was done. + - Singularity/Apptainer will have also evolved by then. Hopefully this definition file then still works. + - No help text. + - No contact address to ask more questions about this file. + - (Can you find more? Please contribute more points.) + + .. literalinclude:: sharing/bad-example-cxx.def + :language: singularity + :linenos: + :emphasize-lines: 2, 9, 11, 18 + + +.. exercise:: Exercise Sharing-2: Building a container on GitHub + + You can build a container on GitHub (using GitHub Actions) or GitLab (using + GitLab CI) and host the image on GitHub/GitLab. This has the following + advantages: + + - You don't need to host it yourself. + - The image stays close to its sources and is not on a different service. + - Anybody can inspect the recipe and how it was built. + - Every time you make a change to the recipe, it builds a new image. + + If you want to try this out: + + - Take `this repository `_ as starting point and inspiration. + - We don't need to focus too much on what this container does, but rather `how it is built `_. + - To build a new version, one needs to send a pull request which updates + the file ``VERSION`` and modifies the definition file. + - Using this approach, try to build a very simple container definition + directly on GitHub where the goal is to have both the definition file + and the image file in the same place. diff --git a/_sources/tips_tricks.rst.txt b/_sources/tips_tricks.rst.txt new file mode 100644 index 0000000..d935313 --- /dev/null +++ b/_sources/tips_tricks.rst.txt @@ -0,0 +1,92 @@ +Tips, tricks and frequently asked questions +=========================================== + +I'm having problems when building a container (e.g. ``fakeroot``-errors) +------------------------------------------------------------------------ + +Sometimes when the host system and the guest container have operating systems +from different eras (e.g. Ubuntu 16.04 is really old), you might want to +use the +`pre-built Apptainer binaries `__. +These can be installed without any privileges. + +The reason for this errors is that a critical piece of software called GLIBC +might be too new in the host system. For more info, see the third point in +`Apptainer's fakeroot documentation `__. + + +Where should I install my software? +----------------------------------- + +Quite often in Docker images software is installed under ``root``-user's +home folder (``/root``). This is **the wrong approach**. Installing software +there with the assumption that the container will be run by ``root``-user +can cause permission headaches. + +Folders under ``/home`` are also bad as that is commonly mounted by Apptainer +and thus the bind mount hides software installed there. + +You should install manual installations of software to, for example, +``/opt`` or ``/usr/local``. See +`Filesystem Hierarchy Standard `__ +for explanation on how different folders are organized. + + +I have sensitive code that I would need to have in the container +---------------------------------------------------------------- + +Instead of installing your sensitive application to the image +you can instead mount the application directory inside the container. + +If your program requires compilations or installations, you can +install dependencies into the container image and then install software +in a bound folder or on a +`persistent overlay `__. + +If you still decide to put sensitive code in your image, +remember that it is visible to everyone who has access to the image. + + +I have an existing container, but I would want to do small modifications to the code +------------------------------------------------------------------------------------ + +If you want to do you're own modifications to the code +you can either use +`persistent overlays `__ +or you can use the following trick: + +1. Copy the code that you want to modify from the container to a folder outside + of the container: + + .. code-block:: console + + $ apptainer exec my_container.sif cp -r /path/to/code/src src + +2. Modify the code outside of the container +3. Bind mount modified code from outside of the container back into the container + + .. code-block:: console + + $ apptainer run --bind src:/path/to/code/src my_container.sif + + +My container starts to become huge +---------------------------------- + +Remember to clean up any unnecessary source code or software in your +``%post``-block. If your program does not need e.g. development headers +once it has been installed, you can remove them. + +You can also try +`multi-stage builds `__ +where one container is used to build a software, which is then copied +to another container that has only those packages required to run the software. + + +I would want to install my conda environment in a container +----------------------------------------------------------- + +See +`this repository `__ +for an example definition file that can be used to bootstrap +conda environment into a Apptainer container image. diff --git a/_sources/verify_installation.rst.txt b/_sources/verify_installation.rst.txt new file mode 100644 index 0000000..0066eb2 --- /dev/null +++ b/_sources/verify_installation.rst.txt @@ -0,0 +1,56 @@ +Verify Apptainer Installation +============================= + +.. objectives:: + + * Understand the importance of verifying tool installation on HPC systems. + * Learn how to check the installation and version of Apptainer on an HPC cluster. + * Gain practical skills in verifying software prerequisites for scientific computing environments. + + This demo guides you through the process of verifying whether Apptainer is installed on your HPC cluster and checking its version. This is a critical first step in ensuring that the necessary tools are correctly configured before moving on to more complex containerization tasks. Knowing the version of Apptainer is essential as it may affect compatibility with container recipes or other tools used in your workflows. + +.. prerequisites:: + + * No prerequisites for following the demo + +The first step in utilizing containers on any high-performance computing (HPC) cluster involves ensuring that the container management software, in this case, Apptainer, is properly installed. This demo is crucial as it confirms the foundational tool's availability, which is necessary for all subsequent container-related operations. + +This demo will not only verify the presence of Apptainer on your system but will also teach you how to check its version. Knowing the installed version is important as it helps in troubleshooting and in ensuring compatibility with various container definitions and configurations used in scientific applications. + + +.. code-block:: bash + + # Check if Apptainer is installed and determine its version + apptainer --version + + +This command checks if Apptainer is installed and displays the version number. This information is useful for understanding which features and functionalities are available to you, as different versions may have different capabilities. + +Summary +------- +In this lesson, you learned how to verify the installation of Apptainer on your HPC cluster and how to check its version. This is a foundational skill that ensures you can proceed with confidence in using Apptainer for more advanced tasks in container management. + +.. exercise:: Configure Apptainer + + Explore the online Apptainer documentation and search for the bash environment variables that apptainer uses. + + 1. Do you have any apptainer variables set in your shell environment? + 2. How do you set the variables for the CACHEDIR and TMPDIR so that they are pointing to a disk where you have enough free space? (e.g. your work folder) + + .. solution:: Solution + + 1. Apptainer uses the following environemnt variables: + 2. The following code creates subfolders in your work directory and makes sure that apptainer will use those folders to store temporary files + + + .. code-block:: bash + + mkdir $WRKDIR/apptainercache/ + mkdir $WRKDIR/apptainertemp/ + export APPTAINER_CACHEDIR="$WRKDIR/apptainercache/" + export APPTAINER_TMPDIR="$WRKDIR/apptainertemp/" + + + + + diff --git a/_static/_sphinx_javascript_frameworks_compat.js b/_static/_sphinx_javascript_frameworks_compat.js new file mode 100644 index 0000000..8549469 --- /dev/null +++ b/_static/_sphinx_javascript_frameworks_compat.js @@ -0,0 +1,134 @@ +/* + * _sphinx_javascript_frameworks_compat.js + * ~~~~~~~~~~ + * + * Compatability shim for jQuery and underscores.js. + * + * WILL BE REMOVED IN Sphinx 6.0 + * xref RemovedInSphinx60Warning + * + */ + +/** + * select a different prefix for underscore + */ +$u = _.noConflict(); + + +/** + * 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; +} diff --git a/_static/basic.css b/_static/basic.css new file mode 100644 index 0000000..4e9a9f1 --- /dev/null +++ b/_static/basic.css @@ -0,0 +1,900 @@ +/* + * basic.css + * ~~~~~~~~~ + * + * Sphinx stylesheet -- basic theme. + * + * :copyright: Copyright 2007-2022 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 p.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: 360px; + 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; +} + +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, .figure.align-left, object.align-left { + clear: left; + float: left; + margin-right: 1em; +} + +img.align-right, figure.align-right, .figure.align-right, object.align-right { + clear: right; + float: right; + margin-left: 1em; +} + +img.align-center, figure.align-center, .figure.align-center, object.align-center { + display: block; + margin-left: auto; + margin-right: auto; +} + +img.align-default, figure.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, +aside.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; +} +nav.contents, +aside.topic, +div.admonition, div.topic, blockquote { + clear: left; +} + +/* -- topics ---------------------------------------------------------------- */ +nav.contents, +aside.topic, +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, +aside.sidebar > :last-child, +nav.contents > :last-child, +aside.topic > :last-child, +div.topic > :last-child, +div.admonition > :last-child { + margin-bottom: 0; +} + +div.sidebar::after, +aside.sidebar::after, +nav.contents::after, +aside.topic::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; +} + +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, figure { + margin: 0.5em; + padding: 0.5em; +} + +div.figure p.caption, figcaption { + padding: 0.3em; +} + +div.figure p.caption span.caption-number, +figcaption span.caption-number { + font-style: italic; +} + +div.figure p.caption span.caption-text, +figcaption 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; +} + +/* -- object description styles --------------------------------------------- */ + +.sig { + font-family: 'Consolas', 'Menlo', 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', monospace; +} + +.sig-name, code.descname { + background-color: transparent; + font-weight: bold; +} + +.sig-name { + font-size: 1.1em; +} + +code.descname { + font-size: 1.2em; +} + +.sig-prename, code.descclassname { + background-color: transparent; +} + +.optional { + font-size: 1.3em; +} + +.sig-paren { + font-size: larger; +} + +.sig-param.n { + font-style: italic; +} + +/* C++ specific styling */ + +.sig-inline.c-texpr, +.sig-inline.cpp-texpr { + font-family: unset; +} + +.sig.c .k, .sig.c .kt, +.sig.cpp .k, .sig.cpp .kt { + color: #0033B3; +} + +.sig.c .m, +.sig.cpp .m { + color: #1750EB; +} + +.sig.c .s, .sig.c .sc, +.sig.cpp .s, .sig.cpp .sc { + color: #067D17; +} + + +/* -- 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; +} +aside.footnote > span, +div.citation > span { + float: left; +} +aside.footnote > span:last-of-type, +div.citation > span:last-of-type { + padding-right: 0.5em; +} +aside.footnote > p { + margin-left: 2em; +} +div.citation > p { + margin-left: 4em; +} +aside.footnote > p:last-of-type, +div.citation > p:last-of-type { + margin-bottom: 0em; +} +aside.footnote > p:last-of-type:after, +div.citation > p:last-of-type: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 > 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; +} + +.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 0.5em; + content: ":"; + display: inline-block; +} + +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; + white-space: nowrap; +} + +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.highlight span.gp { /* gp: Generic.Prompt */ + user-select: none; + -webkit-user-select: text; /* Safari fallback only */ + -webkit-user-select: none; /* Chrome/Safari */ + -moz-user-select: none; /* Firefox */ + -ms-user-select: none; /* IE10+ */ +} + +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.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/_static/check-solid.svg b/_static/check-solid.svg new file mode 100644 index 0000000..92fad4b --- /dev/null +++ b/_static/check-solid.svg @@ -0,0 +1,4 @@ + + + + diff --git a/_static/clipboard.min.js b/_static/clipboard.min.js new file mode 100644 index 0000000..54b3c46 --- /dev/null +++ b/_static/clipboard.min.js @@ -0,0 +1,7 @@ +/*! + * clipboard.js v2.0.8 + * https://clipboardjs.com/ + * + * Licensed MIT © Zeno Rocha + */ +!function(t,e){"object"==typeof exports&&"object"==typeof module?module.exports=e():"function"==typeof define&&define.amd?define([],e):"object"==typeof exports?exports.ClipboardJS=e():t.ClipboardJS=e()}(this,function(){return n={686:function(t,e,n){"use strict";n.d(e,{default:function(){return o}});var e=n(279),i=n.n(e),e=n(370),u=n.n(e),e=n(817),c=n.n(e);function a(t){try{return document.execCommand(t)}catch(t){return}}var f=function(t){t=c()(t);return a("cut"),t};var l=function(t){var e,n,o,r=1 + + + + diff --git a/_static/copybutton.css b/_static/copybutton.css new file mode 100644 index 0000000..40eafe5 --- /dev/null +++ b/_static/copybutton.css @@ -0,0 +1,93 @@ +/* Copy buttons */ +button.copybtn { + position: absolute; + display: flex; + top: .3em; + right: .3em; + width: 1.7em; + height: 1.7em; + opacity: 0; + transition: opacity 0.3s, border .3s, background-color .3s; + user-select: none; + padding: 0; + border: none; + outline: none; + border-radius: 0.4em; + /* The colors that GitHub uses */ + border: #1b1f2426 1px solid; + background-color: #f6f8fa; + color: #57606a; +} + +button.copybtn.success { + border-color: #22863a; + color: #22863a; +} + +button.copybtn svg { + stroke: currentColor; + width: 1.5em; + height: 1.5em; + padding: 0.1em; +} + +div.highlight { + position: relative; +} + +.highlight:hover button.copybtn { + opacity: 1; +} + +.highlight button.copybtn:hover { + background-color: rgb(235, 235, 235); +} + +.highlight button.copybtn:active { + background-color: rgb(187, 187, 187); +} + +/** + * A minimal CSS-only tooltip copied from: + * https://codepen.io/mildrenben/pen/rVBrpK + * + * To use, write HTML like the following: + * + *

Short

+ */ + .o-tooltip--left { + position: relative; + } + + .o-tooltip--left:after { + opacity: 0; + visibility: hidden; + position: absolute; + content: attr(data-tooltip); + padding: .2em; + font-size: .8em; + left: -.2em; + background: grey; + color: white; + white-space: nowrap; + z-index: 2; + border-radius: 2px; + transform: translateX(-102%) translateY(0); + transition: opacity 0.2s cubic-bezier(0.64, 0.09, 0.08, 1), transform 0.2s cubic-bezier(0.64, 0.09, 0.08, 1); +} + +.o-tooltip--left:hover:after { + display: block; + opacity: 1; + visibility: visible; + transform: translateX(-100%) translateY(0); + transition: opacity 0.2s cubic-bezier(0.64, 0.09, 0.08, 1), transform 0.2s cubic-bezier(0.64, 0.09, 0.08, 1); + transition-delay: .5s; +} + +/* By default the copy button shouldn't show up when printing a page */ +@media print { + button.copybtn { + display: none; + } +} diff --git a/_static/copybutton.js b/_static/copybutton.js new file mode 100644 index 0000000..3ad5c7c --- /dev/null +++ b/_static/copybutton.js @@ -0,0 +1,241 @@ +// Localization support +const messages = { + 'en': { + 'copy': 'Copy', + 'copy_to_clipboard': 'Copy to clipboard', + 'copy_success': 'Copied!', + 'copy_failure': 'Failed to copy', + }, + 'es' : { + 'copy': 'Copiar', + 'copy_to_clipboard': 'Copiar al portapapeles', + 'copy_success': '¡Copiado!', + 'copy_failure': 'Error al copiar', + }, + 'de' : { + 'copy': 'Kopieren', + 'copy_to_clipboard': 'In die Zwischenablage kopieren', + 'copy_success': 'Kopiert!', + 'copy_failure': 'Fehler beim Kopieren', + }, + 'fr' : { + 'copy': 'Copier', + 'copy_to_clipboard': 'Copié dans le presse-papier', + 'copy_success': 'Copié !', + 'copy_failure': 'Échec de la copie', + }, + 'ru': { + 'copy': 'Скопировать', + 'copy_to_clipboard': 'Скопировать в буфер', + 'copy_success': 'Скопировано!', + 'copy_failure': 'Не удалось скопировать', + }, + 'zh-CN': { + 'copy': '复制', + 'copy_to_clipboard': '复制到剪贴板', + 'copy_success': '复制成功!', + 'copy_failure': '复制失败', + }, + 'it' : { + 'copy': 'Copiare', + 'copy_to_clipboard': 'Copiato negli appunti', + 'copy_success': 'Copiato!', + 'copy_failure': 'Errore durante la copia', + } +} + +let locale = 'en' +if( document.documentElement.lang !== undefined + && messages[document.documentElement.lang] !== undefined ) { + locale = document.documentElement.lang +} + +let doc_url_root = DOCUMENTATION_OPTIONS.URL_ROOT; +if (doc_url_root == '#') { + doc_url_root = ''; +} + +/** + * SVG files for our copy buttons + */ +let iconCheck = ` + ${messages[locale]['copy_success']} + + +` + +// If the user specified their own SVG use that, otherwise use the default +let iconCopy = ``; +if (!iconCopy) { + iconCopy = ` + ${messages[locale]['copy_to_clipboard']} + + + +` +} + +/** + * Set up copy/paste for code blocks + */ + +const runWhenDOMLoaded = cb => { + if (document.readyState != 'loading') { + cb() + } else if (document.addEventListener) { + document.addEventListener('DOMContentLoaded', cb) + } else { + document.attachEvent('onreadystatechange', function() { + if (document.readyState == 'complete') cb() + }) + } +} + +const codeCellId = index => `codecell${index}` + +// Clears selected text since ClipboardJS will select the text when copying +const clearSelection = () => { + if (window.getSelection) { + window.getSelection().removeAllRanges() + } else if (document.selection) { + document.selection.empty() + } +} + +// Changes tooltip text for two seconds, then changes it back +const temporarilyChangeTooltip = (el, oldText, newText) => { + el.setAttribute('data-tooltip', newText) + el.classList.add('success') + setTimeout(() => el.setAttribute('data-tooltip', oldText), 2000) + setTimeout(() => el.classList.remove('success'), 2000) +} + +// Changes the copy button icon for two seconds, then changes it back +const temporarilyChangeIcon = (el) => { + el.innerHTML = iconCheck; + setTimeout(() => {el.innerHTML = iconCopy}, 2000) +} + +const addCopyButtonToCodeCells = () => { + // If ClipboardJS hasn't loaded, wait a bit and try again. This + // happens because we load ClipboardJS asynchronously. + if (window.ClipboardJS === undefined) { + setTimeout(addCopyButtonToCodeCells, 250) + return + } + + // Add copybuttons to all of our code cells + const COPYBUTTON_SELECTOR = 'div.highlight pre'; + const codeCells = document.querySelectorAll(COPYBUTTON_SELECTOR) + codeCells.forEach((codeCell, index) => { + const id = codeCellId(index) + codeCell.setAttribute('id', id) + + const clipboardButton = id => + `` + codeCell.insertAdjacentHTML('afterend', clipboardButton(id)) + }) + +function escapeRegExp(string) { + return string.replace(/[.*+?^${}()|[\]\\]/g, '\\$&'); // $& means the whole matched string +} + +/** + * Removes excluded text from a Node. + * + * @param {Node} target Node to filter. + * @param {string} exclude CSS selector of nodes to exclude. + * @returns {DOMString} Text from `target` with text removed. + */ +function filterText(target, exclude) { + const clone = target.cloneNode(true); // clone as to not modify the live DOM + if (exclude) { + // remove excluded nodes + clone.querySelectorAll(exclude).forEach(node => node.remove()); + } + return clone.innerText; +} + +// Callback when a copy button is clicked. Will be passed the node that was clicked +// should then grab the text and replace pieces of text that shouldn't be used in output +function formatCopyText(textContent, copybuttonPromptText, isRegexp = false, onlyCopyPromptLines = true, removePrompts = true, copyEmptyLines = true, lineContinuationChar = "", hereDocDelim = "") { + var regexp; + var match; + + // Do we check for line continuation characters and "HERE-documents"? + var useLineCont = !!lineContinuationChar + var useHereDoc = !!hereDocDelim + + // create regexp to capture prompt and remaining line + if (isRegexp) { + regexp = new RegExp('^(' + copybuttonPromptText + ')(.*)') + } else { + regexp = new RegExp('^(' + escapeRegExp(copybuttonPromptText) + ')(.*)') + } + + const outputLines = []; + var promptFound = false; + var gotLineCont = false; + var gotHereDoc = false; + const lineGotPrompt = []; + for (const line of textContent.split('\n')) { + match = line.match(regexp) + if (match || gotLineCont || gotHereDoc) { + promptFound = regexp.test(line) + lineGotPrompt.push(promptFound) + if (removePrompts && promptFound) { + outputLines.push(match[2]) + } else { + outputLines.push(line) + } + gotLineCont = line.endsWith(lineContinuationChar) & useLineCont + if (line.includes(hereDocDelim) & useHereDoc) + gotHereDoc = !gotHereDoc + } else if (!onlyCopyPromptLines) { + outputLines.push(line) + } else if (copyEmptyLines && line.trim() === '') { + outputLines.push(line) + } + } + + // If no lines with the prompt were found then just use original lines + if (lineGotPrompt.some(v => v === true)) { + textContent = outputLines.join('\n'); + } + + // Remove a trailing newline to avoid auto-running when pasting + if (textContent.endsWith("\n")) { + textContent = textContent.slice(0, -1) + } + return textContent +} + + +var copyTargetText = (trigger) => { + var target = document.querySelector(trigger.attributes['data-clipboard-target'].value); + + // get filtered text + let exclude = '.linenos, .gp'; + + let text = filterText(target, exclude); + return formatCopyText(text, '>>> |\\.\\.\\. |\\$ |In \\[\\d*\\]: | {2,5}\\.\\.\\.: | {5,8}: ', true, true, true, true, '', '') +} + + // Initialize with a callback so we can modify the text before copy + const clipboard = new ClipboardJS('.copybtn', {text: copyTargetText}) + + // Update UI with error/success messages + clipboard.on('success', event => { + clearSelection() + temporarilyChangeTooltip(event.trigger, messages[locale]['copy'], messages[locale]['copy_success']) + temporarilyChangeIcon(event.trigger) + }) + + clipboard.on('error', event => { + temporarilyChangeTooltip(event.trigger, messages[locale]['copy'], messages[locale]['copy_failure']) + }) +} + +runWhenDOMLoaded(addCopyButtonToCodeCells) \ No newline at end of file diff --git a/_static/copybutton_funcs.js b/_static/copybutton_funcs.js new file mode 100644 index 0000000..dbe1aaa --- /dev/null +++ b/_static/copybutton_funcs.js @@ -0,0 +1,73 @@ +function escapeRegExp(string) { + return string.replace(/[.*+?^${}()|[\]\\]/g, '\\$&'); // $& means the whole matched string +} + +/** + * Removes excluded text from a Node. + * + * @param {Node} target Node to filter. + * @param {string} exclude CSS selector of nodes to exclude. + * @returns {DOMString} Text from `target` with text removed. + */ +export function filterText(target, exclude) { + const clone = target.cloneNode(true); // clone as to not modify the live DOM + if (exclude) { + // remove excluded nodes + clone.querySelectorAll(exclude).forEach(node => node.remove()); + } + return clone.innerText; +} + +// Callback when a copy button is clicked. Will be passed the node that was clicked +// should then grab the text and replace pieces of text that shouldn't be used in output +export function formatCopyText(textContent, copybuttonPromptText, isRegexp = false, onlyCopyPromptLines = true, removePrompts = true, copyEmptyLines = true, lineContinuationChar = "", hereDocDelim = "") { + var regexp; + var match; + + // Do we check for line continuation characters and "HERE-documents"? + var useLineCont = !!lineContinuationChar + var useHereDoc = !!hereDocDelim + + // create regexp to capture prompt and remaining line + if (isRegexp) { + regexp = new RegExp('^(' + copybuttonPromptText + ')(.*)') + } else { + regexp = new RegExp('^(' + escapeRegExp(copybuttonPromptText) + ')(.*)') + } + + const outputLines = []; + var promptFound = false; + var gotLineCont = false; + var gotHereDoc = false; + const lineGotPrompt = []; + for (const line of textContent.split('\n')) { + match = line.match(regexp) + if (match || gotLineCont || gotHereDoc) { + promptFound = regexp.test(line) + lineGotPrompt.push(promptFound) + if (removePrompts && promptFound) { + outputLines.push(match[2]) + } else { + outputLines.push(line) + } + gotLineCont = line.endsWith(lineContinuationChar) & useLineCont + if (line.includes(hereDocDelim) & useHereDoc) + gotHereDoc = !gotHereDoc + } else if (!onlyCopyPromptLines) { + outputLines.push(line) + } else if (copyEmptyLines && line.trim() === '') { + outputLines.push(line) + } + } + + // If no lines with the prompt were found then just use original lines + if (lineGotPrompt.some(v => v === true)) { + textContent = outputLines.join('\n'); + } + + // Remove a trailing newline to avoid auto-running when pasting + if (textContent.endsWith("\n")) { + textContent = textContent.slice(0, -1) + } + return textContent +} diff --git a/_static/css/badge_only.css b/_static/css/badge_only.css new file mode 100644 index 0000000..c718cee --- /dev/null +++ b/_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/_static/css/fonts/Roboto-Slab-Bold.woff b/_static/css/fonts/Roboto-Slab-Bold.woff new file mode 100644 index 0000000..6cb6000 Binary files /dev/null and b/_static/css/fonts/Roboto-Slab-Bold.woff differ diff --git a/_static/css/fonts/Roboto-Slab-Bold.woff2 b/_static/css/fonts/Roboto-Slab-Bold.woff2 new file mode 100644 index 0000000..7059e23 Binary files /dev/null and b/_static/css/fonts/Roboto-Slab-Bold.woff2 differ diff --git a/_static/css/fonts/Roboto-Slab-Regular.woff b/_static/css/fonts/Roboto-Slab-Regular.woff new file mode 100644 index 0000000..f815f63 Binary files /dev/null and b/_static/css/fonts/Roboto-Slab-Regular.woff differ diff --git a/_static/css/fonts/Roboto-Slab-Regular.woff2 b/_static/css/fonts/Roboto-Slab-Regular.woff2 new file mode 100644 index 0000000..f2c76e5 Binary files /dev/null and b/_static/css/fonts/Roboto-Slab-Regular.woff2 differ diff --git a/_static/css/fonts/fontawesome-webfont.eot b/_static/css/fonts/fontawesome-webfont.eot new file mode 100644 index 0000000..e9f60ca Binary files /dev/null and b/_static/css/fonts/fontawesome-webfont.eot differ diff --git a/_static/css/fonts/fontawesome-webfont.svg b/_static/css/fonts/fontawesome-webfont.svg new file mode 100644 index 0000000..855c845 --- /dev/null +++ b/_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/_static/css/fonts/fontawesome-webfont.ttf b/_static/css/fonts/fontawesome-webfont.ttf new file mode 100644 index 0000000..35acda2 Binary files /dev/null and b/_static/css/fonts/fontawesome-webfont.ttf differ diff --git a/_static/css/fonts/fontawesome-webfont.woff b/_static/css/fonts/fontawesome-webfont.woff new file mode 100644 index 0000000..400014a Binary files /dev/null and b/_static/css/fonts/fontawesome-webfont.woff differ diff --git a/_static/css/fonts/fontawesome-webfont.woff2 b/_static/css/fonts/fontawesome-webfont.woff2 new file mode 100644 index 0000000..4d13fc6 Binary files /dev/null and b/_static/css/fonts/fontawesome-webfont.woff2 differ diff --git a/_static/css/fonts/lato-bold-italic.woff b/_static/css/fonts/lato-bold-italic.woff new file mode 100644 index 0000000..88ad05b Binary files /dev/null and b/_static/css/fonts/lato-bold-italic.woff differ diff --git a/_static/css/fonts/lato-bold-italic.woff2 b/_static/css/fonts/lato-bold-italic.woff2 new file mode 100644 index 0000000..c4e3d80 Binary files /dev/null and b/_static/css/fonts/lato-bold-italic.woff2 differ diff --git a/_static/css/fonts/lato-bold.woff b/_static/css/fonts/lato-bold.woff new file mode 100644 index 0000000..c6dff51 Binary files /dev/null and b/_static/css/fonts/lato-bold.woff differ diff --git a/_static/css/fonts/lato-bold.woff2 b/_static/css/fonts/lato-bold.woff2 new file mode 100644 index 0000000..bb19504 Binary files /dev/null and b/_static/css/fonts/lato-bold.woff2 differ diff --git a/_static/css/fonts/lato-normal-italic.woff b/_static/css/fonts/lato-normal-italic.woff new file mode 100644 index 0000000..76114bc Binary files /dev/null and b/_static/css/fonts/lato-normal-italic.woff differ diff --git a/_static/css/fonts/lato-normal-italic.woff2 b/_static/css/fonts/lato-normal-italic.woff2 new file mode 100644 index 0000000..3404f37 Binary files /dev/null and b/_static/css/fonts/lato-normal-italic.woff2 differ diff --git a/_static/css/fonts/lato-normal.woff b/_static/css/fonts/lato-normal.woff new file mode 100644 index 0000000..ae1307f Binary files /dev/null and b/_static/css/fonts/lato-normal.woff differ diff --git a/_static/css/fonts/lato-normal.woff2 b/_static/css/fonts/lato-normal.woff2 new file mode 100644 index 0000000..3bf9843 Binary files /dev/null and b/_static/css/fonts/lato-normal.woff2 differ diff --git a/_static/css/theme.css b/_static/css/theme.css new file mode 100644 index 0000000..19a446a --- /dev/null +++ b/_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/_static/doctools.js b/_static/doctools.js new file mode 100644 index 0000000..527b876 --- /dev/null +++ b/_static/doctools.js @@ -0,0 +1,156 @@ +/* + * doctools.js + * ~~~~~~~~~~~ + * + * Base JavaScript utilities for all Sphinx HTML documentation. + * + * :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ +"use strict"; + +const BLACKLISTED_KEY_CONTROL_ELEMENTS = new Set([ + "TEXTAREA", + "INPUT", + "SELECT", + "BUTTON", +]); + +const _ready = (callback) => { + if (document.readyState !== "loading") { + callback(); + } else { + document.addEventListener("DOMContentLoaded", callback); + } +}; + +/** + * Small JavaScript module for the documentation. + */ +const Documentation = { + init: () => { + Documentation.initDomainIndexTable(); + Documentation.initOnKeyListeners(); + }, + + /** + * i18n support + */ + TRANSLATIONS: {}, + PLURAL_EXPR: (n) => (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: (string) => { + const translated = Documentation.TRANSLATIONS[string]; + switch (typeof translated) { + case "undefined": + return string; // no translation + case "string": + return translated; // translation exists + default: + return translated[0]; // (singular, plural) translation tuple exists + } + }, + + ngettext: (singular, plural, n) => { + const translated = Documentation.TRANSLATIONS[singular]; + if (typeof translated !== "undefined") + return translated[Documentation.PLURAL_EXPR(n)]; + return n === 1 ? singular : plural; + }, + + addTranslations: (catalog) => { + Object.assign(Documentation.TRANSLATIONS, catalog.messages); + Documentation.PLURAL_EXPR = new Function( + "n", + `return (${catalog.plural_expr})` + ); + Documentation.LOCALE = catalog.locale; + }, + + /** + * helper function to focus on search bar + */ + focusSearchBar: () => { + document.querySelectorAll("input[name=q]")[0]?.focus(); + }, + + /** + * Initialise the domain index toggle buttons + */ + initDomainIndexTable: () => { + const toggler = (el) => { + const idNumber = el.id.substr(7); + const toggledRows = document.querySelectorAll(`tr.cg-${idNumber}`); + if (el.src.substr(-9) === "minus.png") { + el.src = `${el.src.substr(0, el.src.length - 9)}plus.png`; + toggledRows.forEach((el) => (el.style.display = "none")); + } else { + el.src = `${el.src.substr(0, el.src.length - 8)}minus.png`; + toggledRows.forEach((el) => (el.style.display = "")); + } + }; + + const togglerElements = document.querySelectorAll("img.toggler"); + togglerElements.forEach((el) => + el.addEventListener("click", (event) => toggler(event.currentTarget)) + ); + togglerElements.forEach((el) => (el.style.display = "")); + if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) togglerElements.forEach(toggler); + }, + + initOnKeyListeners: () => { + // only install a listener if it is really needed + if ( + !DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS && + !DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS + ) + return; + + document.addEventListener("keydown", (event) => { + // bail for input elements + if (BLACKLISTED_KEY_CONTROL_ELEMENTS.has(document.activeElement.tagName)) return; + // bail with special keys + if (event.altKey || event.ctrlKey || event.metaKey) return; + + if (!event.shiftKey) { + switch (event.key) { + case "ArrowLeft": + if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) break; + + const prevLink = document.querySelector('link[rel="prev"]'); + if (prevLink && prevLink.href) { + window.location.href = prevLink.href; + event.preventDefault(); + } + break; + case "ArrowRight": + if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) break; + + const nextLink = document.querySelector('link[rel="next"]'); + if (nextLink && nextLink.href) { + window.location.href = nextLink.href; + event.preventDefault(); + } + break; + } + } + + // some keyboard layouts may need Shift to get / + switch (event.key) { + case "/": + if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS) break; + Documentation.focusSearchBar(); + event.preventDefault(); + } + }); + }, +}; + +// quick alias for translations +const _ = Documentation.gettext; + +_ready(Documentation.init); diff --git a/_static/documentation_options.js b/_static/documentation_options.js new file mode 100644 index 0000000..c066c69 --- /dev/null +++ b/_static/documentation_options.js @@ -0,0 +1,14 @@ +var DOCUMENTATION_OPTIONS = { + URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'), + VERSION: '', + LANGUAGE: 'en', + COLLAPSE_INDEX: false, + BUILDER: 'dirhtml', + FILE_SUFFIX: '.html', + LINK_SUFFIX: '.html', + HAS_SOURCE: true, + SOURCELINK_SUFFIX: '.txt', + NAVIGATION_WITH_KEYS: false, + SHOW_SEARCH_SUMMARY: true, + ENABLE_SEARCH_SHORTCUTS: true, +}; \ No newline at end of file diff --git a/_static/file.png b/_static/file.png new file mode 100644 index 0000000..a858a41 Binary files /dev/null and b/_static/file.png differ diff --git a/_static/jquery-3.6.0.js b/_static/jquery-3.6.0.js new file mode 100644 index 0000000..fc6c299 --- /dev/null +++ b/_static/jquery-3.6.0.js @@ -0,0 +1,10881 @@ +/*! + * jQuery JavaScript Library v3.6.0 + * https://jquery.com/ + * + * Includes Sizzle.js + * https://sizzlejs.com/ + * + * Copyright OpenJS Foundation and other contributors + * Released under the MIT license + * https://jquery.org/license + * + * Date: 2021-03-02T17:08Z + */ +( 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. + // Support: QtWeb <=3.8.5, WebKit <=534.34, wkhtmltopdf tool <=0.12.5 + // Plus for old WebKit, typeof returns "function" for HTML collections + // (e.g., `typeof document.getElementsByTagName("div") === "function"`). (gh-4756) + return typeof obj === "function" && typeof obj.nodeType !== "number" && + typeof obj.item !== "function"; + }; + + +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.6.0", + + // 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.6 + * https://sizzlejs.com/ + * + * Copyright JS Foundation and other contributors + * Released under the MIT license + * https://js.foundation/ + * + * Date: 2021-02-16 + */ +( 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 && elem.namespaceURI, + docElem = elem && ( 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 primary Deferred + primary = 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 ) ) { + primary.resolveWith( resolveContexts, resolveValues ); + } + }; + }; + + // Single- and empty arguments are adopted like Promise.resolve + if ( remaining <= 1 ) { + adoptValue( singleValue, primary.done( updateFunc( i ) ).resolve, primary.reject, + !remaining ); + + // Use .then() to unwrap secondary thenables (cf. gh-3000) + if ( primary.state() === "pending" || + isFunction( resolveValues[ i ] && resolveValues[ i ].then ) ) { + + return primary.then(); + } + } + + // Multiple arguments are aggregated like Promise.all array elements + while ( i-- ) { + adoptValue( resolveValues[ i ], updateFunc( i ), primary.reject ); + } + + return primary.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 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(); + + // Support: Chrome 86+ + // In Chrome, if an element having a focusout handler is blurred by + // clicking outside of it, it invokes the handler synchronously. If + // that handler calls `.remove()` on the element, the data is cleared, + // leaving `result` undefined. We need to guard against this. + return result && 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: true +}, 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; + }, + + // Suppress native focus or blur as it's already being fired + // in leverageNative. + _default: function() { + 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! + // + // Support: Firefox 70+ + // Only Firefox includes border widths + // in computed dimensions. (gh-4529) + 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;border-collapse:separate"; + tr.style.cssText = "border:1px solid"; + + // Support: Chrome 86+ + // Height set through cssText does not get applied. + // Computed height then comes back as 0. + tr.style.height = "1px"; + trChild.style.height = "9px"; + + // Support: Android 8 Chrome 86+ + // In our bodyBackground.html iframe, + // display for all div elements is set to "inline", + // which causes a problem only in Android 8 Chrome 86. + // Ensuring the div is display: block + // gets around this issue. + trChild.style.display = "block"; + + documentElement + .appendChild( table ) + .appendChild( tr ) + .appendChild( trChild ); + + trStyle = window.getComputedStyle( tr ); + reliableTrDimensionsVal = ( parseInt( trStyle.height, 10 ) + + parseInt( trStyle.borderTopWidth, 10 ) + + parseInt( trStyle.borderBottomWidth, 10 ) ) === tr.offsetHeight; + + 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, parserErrorElem; + 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 ) {} + + parserErrorElem = xml && xml.getElementsByTagName( "parsererror" )[ 0 ]; + if ( !xml || parserErrorElem ) { + jQuery.error( "Invalid XML: " + ( + parserErrorElem ? + jQuery.map( parserErrorElem.childNodes, function( el ) { + return el.textContent; + } ).join( "\n" ) : + 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 but not if jsonp + if ( !isSuccess && + jQuery.inArray( "script", s.dataTypes ) > -1 && + jQuery.inArray( "json", s.dataTypes ) < 0 ) { + 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( " + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Basics of running containers

+
+

Objectives

+
    +

  • Learn what methods are available to run a container

    • +
+
+
+

Different ways you can run your containers

+

You can run your container in multiple different ways:

+
    +

  • You can run the container as a single application

    • +

  • You can get an interactive terminal in the container

    • +

  • You can run an application from within the container

    • +
+

We’ll cover these ways in individual sections below.

+
+
+

How to read Apptainer commands?

+

Apptainer’s commands can sometimes have multiple flags +which can make it hard to parse the command line.

+

A typical apptainer command has:

+
    +

  1. apptainer is at the start because we use the +Apptainer client to run the commands.

    2. +

  2. A subcommand (like pull, build, exec, run etc.) +that tells which Apptainer feature we want to use.

    3. +

  3. Often after the subcommand we have the name of the image we +want to use.

    4. +

  4. At the end we might have additional commands that Apptainer +ignores but are to be digested by the application that the container itself is running.

    5. +
+

For legibility reasons many commands in this lesson are highlighted +in this format:

+
+../_images/apptainer_example.png +
+

Figure 1: How apptainer-commands are highlighted

+
+
+

For the comprehensive list of client commands, see +Apptainer CLI reference page.

+
+
+

Obtaining a container from container registry

+

For these examples let’s use a +Python image from Docker Hub.

+

For now let’s just consider it as an application we want +to use and that this application is available in Docker Hub.

+

Let’s create the container image with the following command:

+
$ apptainer pull python.sif docker://python
+
+
+

We’ll talk about container images and image building later on. +For now it is enough to know that the file python.sif contains +a Python installation.

+
+
+

Running the container

+

Running the container means that we run some specific program +that the image creator has set to be the default program for this image.

+

When we run the container we will execute a so-called entry script +or runscript that contains commands specified by the image creators.

+
+

Warning

+

Remember to only run containers from sources that you trust.

+
+

Let’s run the Python container image:

+
$ apptainer run python.sif
+
+
+
+

Expected result

+

We get a Python interpreter running in the container:

+
$ apptainer run python.sif
+Python 3.12.3 (main, Apr 10 2024, 14:35:18) [GCC 12.2.0] on linux
+Type "help", "copyright", "credits" or "license" for more information.
+>>>
+
+
+
+

You should read the command line like this:

+
+../_images/run_example.png +
+

Figure 2: A simple run command

+
+
+

This syntax might seem self-evident, but in more complex use cases we will give +additional flags to various parts of the command.

+
+
+

Launching an interactive shell in the container

+

We can launch an interactive shell in a container with +apptainer shell-command:

+
$ apptainer shell python.sif
+
+
+
+

Expected result

+

We get a bash terminal running in the container:

+
$ apptainer shell python.sif
+Apptainer> echo $SHELL
+/bin/bash
+
+
+
+

You should read the command line like this:

+
+../_images/shell_example.png +
+

Figure 3: Launch a shell in a container

+
+
+
+
+

Running a single program from the container

+

We can launch a single program in a container with +apptainer exec-command.

+

The Python container is based on a Debian Linux distribution. +Let’s check the Debian version in the container:

+
$ apptainer exec python.sif cat /etc/debian_version
+
+
+
+

Expected result

+

With the command we print the contents of the +/etc/debian_version-file:

+
$ apptainer exec python.sif cat /etc/debian_version
+12.5
+
+
+
+

You should read the command line like this:

+
+../_images/exec_example.png +
+

Figure 4: Launch a program in a container

+
+
+
+
+

Review of this session

+
+

Key points to remember

+
    +

  • You can run the containers default program/application/set-of-commands with apptainer run my_image.sif

    • +

  • You can start an interactive shell in a container with apptainer shell my_image.sif

    • +

  • You can execute a single program in a container with apptainer exec my_image.sif my_program arg1 arg2

    • +
+
+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/binding_folders/index.html b/binding_folders/index.html new file mode 100644 index 0000000..4a45686 --- /dev/null +++ b/binding_folders/index.html @@ -0,0 +1,206 @@ + + + + + + + Binding folders into your container — Container on HPC with Apptainer documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Binding folders into your container

+
+

Objectives

+
    +

  • Learn how you can bind folders into containers

    • +
+
+

When you launch a program in a container, the program runs in a contained +environment. The file system in the container might not have the same +folders structure as the machine that runs the container.

+

So, when you want to work on your data, you need to bring it with you into +this contained world inside the container.

+

This is done via method called mount binding.

+

Binding means that a folder from the host system is mapped into a folder +inside the container.

+
+../_images/default_mounts.png +
+

Figure 1: Only some folders are mounted by default

+
+
+

By default, $HOME, $CWD (current working directory) +/tmp and +few other paths +are bound to the image.

+

If you want to do additional mappings you need to do it by giving an +extra arguments to the command you’re running.

+

The following would bind folder /scratch from the host system to +/scratch in the container:

+
$ apptainer exec --bind /scratch example.sif ls /scratch
+
+
+
+../_images/bind_example.png +
+

Figure 2: Binding a directory inside a container

+
+
+

Setting --bind-argument works for apptainer run- and +apptainer shell-commands as well.

+

You can also bind directories to different places. This is especially +helpful if, for example. the code in container expects that data +should be in /data:

+
$ apptainer exec --bind /scratch:/data example.sif ls /data
+
+
+
+

Warning

+

Bind mounts are the same folders inside and outside of the image.

+

Deleting file from the folder that you bound inside the image will +delete the file completely.

+
+
+

Key points to remember

+
    +

  • By default only some folders are bound inside the container.

    • +

  • You’ll need to manually --bind-folders from outside of +the container if you want to use them inside the container.

    • +

  • Bound folders are the same folders inside and outside of the +container.

    • +
+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/branch/maikens_comments/.buildinfo b/branch/maikens_comments/.buildinfo new file mode 100644 index 0000000..1a296ff --- /dev/null +++ b/branch/maikens_comments/.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: df55cf7a91f7fdbecf0348b70949546e +tags: d77d1c0d9ca2f4c8421862c7c5a0d620 diff --git a/branch/maikens_comments/.nojekyll b/branch/maikens_comments/.nojekyll new file mode 100644 index 0000000..e69de29 diff --git a/branch/maikens_comments/_images/app_run_example.png b/branch/maikens_comments/_images/app_run_example.png new file mode 100644 index 0000000..c1b3e91 Binary files /dev/null and b/branch/maikens_comments/_images/app_run_example.png differ diff --git a/branch/maikens_comments/_images/apptainer_example.png b/branch/maikens_comments/_images/apptainer_example.png new file mode 100644 index 0000000..ccff83e Binary files /dev/null and b/branch/maikens_comments/_images/apptainer_example.png differ diff --git a/branch/maikens_comments/_images/bind_example.png b/branch/maikens_comments/_images/bind_example.png new file mode 100644 index 0000000..45f2130 Binary files /dev/null and b/branch/maikens_comments/_images/bind_example.png differ diff --git a/branch/maikens_comments/_images/build_example.png b/branch/maikens_comments/_images/build_example.png new file mode 100644 index 0000000..c6b2460 Binary files /dev/null and b/branch/maikens_comments/_images/build_example.png differ diff --git a/branch/maikens_comments/_images/containerized_application.png b/branch/maikens_comments/_images/containerized_application.png new file mode 100644 index 0000000..4824c4b Binary files /dev/null and b/branch/maikens_comments/_images/containerized_application.png differ diff --git a/branch/maikens_comments/_images/default_mounts.png b/branch/maikens_comments/_images/default_mounts.png new file mode 100644 index 0000000..47bb43e Binary files /dev/null and b/branch/maikens_comments/_images/default_mounts.png differ diff --git a/branch/maikens_comments/_images/exec_example.png b/branch/maikens_comments/_images/exec_example.png new file mode 100644 index 0000000..6122c96 Binary files /dev/null and b/branch/maikens_comments/_images/exec_example.png differ diff --git a/branch/maikens_comments/_images/image_explanation.png b/branch/maikens_comments/_images/image_explanation.png new file mode 100644 index 0000000..7ceac8a Binary files /dev/null and b/branch/maikens_comments/_images/image_explanation.png differ diff --git a/branch/maikens_comments/_images/image_explanation_apptainer.png b/branch/maikens_comments/_images/image_explanation_apptainer.png new file mode 100644 index 0000000..3ec9567 Binary files /dev/null and b/branch/maikens_comments/_images/image_explanation_apptainer.png differ diff --git a/branch/maikens_comments/_images/instance_example.png b/branch/maikens_comments/_images/instance_example.png new file mode 100644 index 0000000..c426ef6 Binary files /dev/null and b/branch/maikens_comments/_images/instance_example.png differ diff --git a/branch/maikens_comments/_images/normal_application.png b/branch/maikens_comments/_images/normal_application.png new file mode 100644 index 0000000..9611847 Binary files /dev/null and b/branch/maikens_comments/_images/normal_application.png differ diff --git a/branch/maikens_comments/_images/nv_example.png b/branch/maikens_comments/_images/nv_example.png new file mode 100644 index 0000000..89479a9 Binary files /dev/null and b/branch/maikens_comments/_images/nv_example.png differ diff --git a/branch/maikens_comments/_images/pull_example.png b/branch/maikens_comments/_images/pull_example.png new file mode 100644 index 0000000..2fb628d Binary files /dev/null and b/branch/maikens_comments/_images/pull_example.png differ diff --git a/branch/maikens_comments/_images/rocm_example.png b/branch/maikens_comments/_images/rocm_example.png new file mode 100644 index 0000000..ad7ed2e Binary files /dev/null and b/branch/maikens_comments/_images/rocm_example.png differ diff --git a/branch/maikens_comments/_images/run_example.png b/branch/maikens_comments/_images/run_example.png new file mode 100644 index 0000000..a009f3e Binary files /dev/null and b/branch/maikens_comments/_images/run_example.png differ diff --git a/branch/maikens_comments/_images/shell_example.png b/branch/maikens_comments/_images/shell_example.png new file mode 100644 index 0000000..5589f39 Binary files /dev/null and b/branch/maikens_comments/_images/shell_example.png differ diff --git a/branch/maikens_comments/_sources/advanced_recipe.rst.txt b/branch/maikens_comments/_sources/advanced_recipe.rst.txt new file mode 100644 index 0000000..9575efe --- /dev/null +++ b/branch/maikens_comments/_sources/advanced_recipe.rst.txt @@ -0,0 +1,62 @@ +Advanced Container Recipes +========================== + +.. objectives:: + + * Understand the complexities of building advanced scientific software stacks within containers. + * Learn to construct detailed Apptainer definition files that encapsulate comprehensive scientific environments. + * Develop proficiency in crafting container recipes that ensure reproducibility and consistency across different HPC systems. + + This demo will walk you through the process of creating advanced container recipes using Apptainer, aimed at constructing robust scientific software environments. These environments often require multiple, intricately linked software tools and libraries that must be correctly configured to work together seamlessly. + +.. prerequisites:: + + * Access to an HPC system with Apptainer installed. + * Basic to intermediate knowledge of Linux, shell scripting, and scientific software installation. + * Understanding of dependency management and environment configuration for scientific computing. + +Building a scientific software stack in a container can be challenging due to dependencies and the need for specific configurations. By using advanced container recipes, researchers can encapsulate these environments, making them portable and reproducible. This is particularly important in scientific research, where precise control over software versions and settings is crucial for validating experimental results. + +First, we'll outline a container recipe that includes a typical setup for a bioinformatics analysis environment, featuring tools like BLAST, Python, and R. + +.. code-block:: bash + + # Example Apptainer definition file for a bioinformatics stack + Bootstrap: library + From: ubuntu:20.04 + + %post + apt-get update && apt-get install -y wget build-essential python3 python3-pip r-base + pip3 install numpy scipy pandas biopython + wget ftp://ftp.ncbi.nlm.nih.gov/blast/executables/blast+/LATEST/ncbi-blast-2.10.1+-x64-linux.tar.gz + tar -xzf ncbi-blast-2.10.1+-x64-linux.tar.gz -C /usr/local/bin --strip-components=1 + echo 'export PATH=/usr/local/bin:$PATH' >> ~/.bashrc + + %environment + export PATH=/usr/local/bin:$PATH + + %runscript + echo "Environment for bioinformatics analysis ready. Tools available: BLAST, Python, R." + exec /bin/bash + + +.. code-block:: bash + + # Build the container for the bioinformatics stack + apptainer build bioinfo_container.sif bioinfo.def + + +This block constructs the ``bioinfo_container.sif`` from the ``bioinfo.def`` file. It installs critical tools for bioinformatics, including BLAST for sequence analysis, and a suite of Python and R libraries commonly used in data analysis and visualization. + +.. code-block:: bash + + # Run the container, providing an interactive shell + apptainer shell bioinfo_container.sif + + +This command provides an interactive shell within the ``bioinfo_container.sif``, allowing users to execute the installed tools and perform analyses as if they were running on a native environment. This setup is ideal for ensuring that all users, regardless of their host system configuration, can reproduce the scientific computations. + +Summary +------- +In this tutorial, you've learned how to create advanced container recipes using Apptainer to build a comprehensive scientific software stack. This skill is invaluable for researchers who need to ensure the reproducibility of their experiments and for IT administrators tasked with maintaining consistent + diff --git a/branch/maikens_comments/_sources/apptainer_gpus.rst.txt b/branch/maikens_comments/_sources/apptainer_gpus.rst.txt new file mode 100644 index 0000000..02af281 --- /dev/null +++ b/branch/maikens_comments/_sources/apptainer_gpus.rst.txt @@ -0,0 +1,64 @@ +Using GPUs with Apptainer +========================= + +.. objectives:: + + * Understand how to access and utilize GPU resources within an Apptainer container. + * Learn to configure an Apptainer container for running applications that require GPU computation. + * Develop skills to integrate GPU-based processing within containerized scientific workflows. + + This demo will guide you through the process of configuring and running an Apptainer container that utilizes GPUs, which is essential for high-performance computing tasks that require significant computational power, such as deep learning and large-scale data processing. Utilizing GPUs within containers can dramatically increase the efficiency and speed of these computations. + +.. prerequisites:: + + * Access to an HPC system with NVIDIA GPUs installed. + * Apptainer installed on the HPC system. + * Basic understanding of containerization and GPU computing principles. + +GPUs are powerful tools for accelerating computational workloads, particularly those involving parallel processing tasks. However, accessing GPU resources within a containerized environment presents unique challenges, such as ensuring proper drivers are installed and accessible to the container. This demo will show you how to overcome these challenges to harness the full potential of GPU computing in an HPC setting. + +First, we will create an Apptainer definition file that sets up an environment capable of utilizing NVIDIA GPUs. + +.. code-block:: bash + + # Example Apptainer definition file for using NVIDIA GPUs + Bootstrap: library + From: nvcr.io/nvidia/cuda:11.0-base + + %post + apt-get update && apt-get install -y cuda-samples-11-0 + + %test + cd /usr/local/cuda-11.0/samples/1_Utilities/deviceQuery + make + ./deviceQuery + + %environment + export PATH=/usr/local/nvidia/bin:/usr/local/cuda/bin:${PATH} + export LD_LIBRARY_PATH=/usr/local/nvidia/lib:/usr/local/nvidia/lib64 + + %runscript + echo "Running CUDA device query..." + ./deviceQuery + + +.. code-block:: bash + + # Build the GPU-enabled container + apptainer build cuda_container.sif cuda.def + + +This block constructs the ``cuda_container.sif`` container from the ``cuda.def`` definition file, which includes the CUDA base image from NVIDIA's container registry. This setup ensures that the container will have access to the necessary CUDA libraries and tools to utilize GPU resources. + +.. code-block:: bash + + # Run the container with GPU support + apptainer exec --nv cuda_container.sif /bin/bash + + +This command executes the container with the ``--nv`` flag, which enables NVIDIA GPU support within the container. This flag is crucial as it allows the container to access the host's GPU resources, essential for running GPU-accelerated applications. + + +Summary +------- +In this tutorial, you have learned how to configure and use an Apptainer container to access and utilize GPU resources for high-performance computational tasks. This capability is particularly valuable in scientific computing, where the processing power of GPUs can be leveraged to accelerate research and development workflows. By integrating GPU support into your containers, you enhance their functionality and applicability in a wide range of HPC scenarios. diff --git a/branch/maikens_comments/_sources/basics_running_containers.rst.txt b/branch/maikens_comments/_sources/basics_running_containers.rst.txt new file mode 100644 index 0000000..f69b602 --- /dev/null +++ b/branch/maikens_comments/_sources/basics_running_containers.rst.txt @@ -0,0 +1,182 @@ +Basics of running containers +============================ + +.. objectives:: + + * Learn what methods are available to run a container + + +Different ways you can run your containers +------------------------------------------ + +You can run your container in multiple different ways: + +- You can run the container as a single application +- You can get an interactive terminal in the container +- You can run an application from within the container + + +We'll cover these ways in individual sections below. + + +How to read Apptainer commands? +------------------------------- + +Apptainer's commands can sometimes have multiple flags +which can make it hard to parse the command line. + +A typical apptainer command has: + +1. ``apptainer`` is at the start because we use the + Apptainer client to run the commands. +2. A subcommand (like ``pull``, ``build``, ``exec``, ``run`` etc.) + that tells which Apptainer feature we want to use. +3. Often after the subcommand we have the name of the image we + want to use. +4. At the end we might have additional commands that Apptainer + ignores but are to be digested by the application that the container itself is running. + +For legibility reasons many commands in this lesson are highlighted +in this format: + +.. figure:: img/apptainer_example.png + :width: 100% + + Figure 1: How apptainer-commands are highlighted + + +For the comprehensive list of client commands, see +`Apptainer CLI reference page `__. + + +Obtaining a container from container registry +--------------------------------------------- + +For these examples let's use a +`Python image from Docker Hub `__. + +For now let's just consider it as an application we want +to use and that this application is available in Docker Hub. + +Let's create the container image with the following command: + +.. code-block:: console + + $ apptainer pull python.sif docker://python + +We'll talk about container images and image building later on. +For now it is enough to know that the file ``python.sif`` contains +a Python installation. + +Running the container +--------------------- + +Running the container means that we run some specific program +that the image creator has set to be the default program for this image. + +When we run the container we will execute a so-called entry script +or runscript that contains commands specified by the image creators. + +.. warning:: + + Remember to only run containers from sources that you trust. + +Let's run the Python container image: + +.. code-block:: console + + $ apptainer run python.sif + +.. admonition:: Expected result + :class: dropdown + + We get a Python interpreter running in the container: + + .. code-block:: console + + $ apptainer run python.sif + Python 3.12.3 (main, Apr 10 2024, 14:35:18) [GCC 12.2.0] on linux + Type "help", "copyright", "credits" or "license" for more information. + >>> + + +You should read the command line like this: + +.. figure:: img/run_example.png + :scale: 50% + + Figure 2: A simple run command + +This syntax might seem self-evident, but in more complex use cases we will give +additional flags to various parts of the command. + + +Launching an interactive shell in the container +----------------------------------------------- + +We can launch an interactive shell in a container with +``apptainer shell``-command: + +.. code-block:: console + + $ apptainer shell python.sif + +.. admonition:: Expected result + :class: dropdown + + We get a ``bash`` terminal running in the container: + + .. code-block:: console + + $ apptainer shell python.sif + Apptainer> echo $SHELL + /bin/bash + +You should read the command line like this: + +.. figure:: img/shell_example.png + :scale: 50% + + Figure 3: Launch a shell in a container + + +Running a single program from the container +------------------------------------------- + +We can launch a single program in a container with +``apptainer exec``-command. + +The Python container is based on a Debian Linux distribution. +Let's check the Debian version in the container: + +.. code-block:: console + + $ apptainer exec python.sif cat /etc/debian_version + +.. admonition:: Expected result + :class: dropdown + + With the command we print the contents of the + ``/etc/debian_version``-file: + + .. code-block:: console + + $ apptainer exec python.sif cat /etc/debian_version + 12.5 + +You should read the command line like this: + +.. figure:: img/exec_example.png + :scale: 50% + + Figure 4: Launch a program in a container + + +Review of this session +---------------------- + +.. admonition:: Key points to remember + + - You can run the containers default program/application/set-of-commands with ``apptainer run my_image.sif`` + - You can start an interactive shell in a container with ``apptainer shell my_image.sif`` + - You can execute a single program in a container with ``apptainer exec my_image.sif my_program arg1 arg2`` diff --git a/branch/maikens_comments/_sources/binding_folders.rst.txt b/branch/maikens_comments/_sources/binding_folders.rst.txt new file mode 100644 index 0000000..ba66c0e --- /dev/null +++ b/branch/maikens_comments/_sources/binding_folders.rst.txt @@ -0,0 +1,68 @@ +Binding folders into your container +=================================== + +.. objectives:: + + * Learn how you can bind folders into containers + +When you launch a program in a container, the program runs in a contained +environment. The file system in the container might not have the same +folders structure as the machine that runs the container. + +So, when you want to work on your data, you need to bring it with you into +this contained world inside the container. + +This is done via method called **mount binding**. + +Binding means that a folder from the host system is mapped into a folder +inside the container. + +.. figure:: img/default_mounts.png + + Figure 1: Only some folders are mounted by default + +By default, ``$HOME``, ``$CWD`` (current working directory) +``/tmp`` and +`few other paths `__ +are bound to the image. + +If you want to do additional mappings you need to do it by giving an +extra arguments to the command you're running. + +The following would bind folder ``/scratch`` from the host system to +``/scratch`` in the container: + +.. code-block:: console + + $ apptainer exec --bind /scratch example.sif ls /scratch + +.. figure:: img/bind_example.png + + Figure 2: Binding a directory inside a container + +Setting ``--bind``-argument works for ``apptainer run``- and +``apptainer shell``-commands as well. + +You can also bind directories to different places. This is especially +helpful if, for example. the code in container expects that data +should be in ``/data``: + +.. code-block:: console + + $ apptainer exec --bind /scratch:/data example.sif ls /data + +.. warning:: + + Bind mounts **are the same folders inside and outside** of the image. + + Deleting file from the folder that you bound inside the image will + delete the file completely. + +.. admonition:: Key points to remember + + - By default only some folders are bound inside the container. + - You'll need to manually ``--bind``-folders from outside of + the container if you want to use them inside the container. + - Bound folders are the same folders inside and outside of the + container. + diff --git a/branch/maikens_comments/_sources/building_images.rst.txt b/branch/maikens_comments/_sources/building_images.rst.txt new file mode 100644 index 0000000..0b163cd --- /dev/null +++ b/branch/maikens_comments/_sources/building_images.rst.txt @@ -0,0 +1,446 @@ +Building Apptainer images +========================= + +.. objectives:: + + - Learn how you can build container images + +In this session we'll discuss various ways you can create Apptainer images. + +Pulling an existing image from a container registry +--------------------------------------------------- + +We have already seen how to pull a +`Python image from Docker Hub `__. + +.. code-block:: console + + $ apptainer pull python.sif docker://python + +We could have alternatively used the full registry specification URL: + +.. code-block:: console + + $ apptainer pull python.sif docker://docker.io/library/python:latest + +The format for these registry specifications is: + +``docker://REGISTRY_URL/USER_NAMESPACE/IMAGE_NAME:IMAGE_TAG`` + +Here ``docker://`` means that we use a Docker Hub compatible container +registry. There are other compatible registries such as +`quay `__ and +`GitHub container registry `__. + +You can read the command like this: + +.. figure:: img/pull_example.png + + Figure 1: Pulling an image from a repository + + +Handling temporary layers needed by the build process +----------------------------------------------------- + +When Apptainer creates a ``.sif``-image it needs to first download any layers +it uses for the building. Then it will squash all of these layers to one +``.sif``-image. + +These are stored in a folder specified by an environment variable +``APPTAINER_CACHEDIR``. By default, Apptainer will use +``$HOME/.apptainer/cache``. This can result in you running out of quota +during the image creation process if the home folder quota is not big. + +You can set the cache directory with: + +.. code-block:: console + + $ mkdir apptainer_cache + $ export APPTAINER_CACHEDIR=$PWD/apptainer_cache + +It is adviced to select a location in some filesystem that has enough space available. +For instance a type of "scratch" area on your HPC. + +You can check the cache status with: + +.. code-block:: console + + $ apptainer cache list + +and you can clean the cache with: + +.. code-block:: console + + $ apptainer cache clean + +See `this page `__ +for more documentation. + + +Creating an image using a specification file +-------------------------------------------- + +Let's say we want to create an apptainer image for the following +``summation.py``-script: + +.. code-block:: python + + import argparse + + parser = argparse.ArgumentParser() + parser.add_argument( + "numbers", help="Numbers to sum", type=int, nargs='*' + ) + args = parser.parse_args() + + numbers = args.numbers + + if len(numbers) > 1: + print(f'Sum of numbers was: {sum(numbers)}') + else: + print('You did not give me any numbers to sum!') + + +Let's create a definition file for this image: + +.. code-block:: singularity + + Bootstrap: docker + From: python:latest + + %files + summation.py /opt + + %runscript + echo "Got arguments: $*" + exec python /opt/summation.py "$@" + +In this definition file we specify: + +1. The bootstrapping method we want to use to build the image. +2. The base image we want to use for bootstrapping. +3. Files we want to copy to the image in the ``%files``-block. +4. Commands we want to run when the image is ran in the ``%runscript``-block. + +Now we can built this image with: + +.. code-block:: console + + $ apptainer build my_container.sif my_container_definition.def + +.. figure:: img/build_example.png + + Figure 2: Building an image from a definition file + +After building the image we can test out the image with: + +.. code-block:: console + + $ apptainer run my_container.sif 1 2 + +This will run the default set of commands specified in the `%runscript` block in +the Apptainer definition file. The two arguments we send into the +shell environment of the container, namely the numbers 1 and 2 are used by the +executable in the runscript. + +.. admonition:: Expected result + :class: dropdown + + Building container should result in a container image + ``my_container.sif`` being created. + + Running the container should produce the following output: + + .. code-block:: console + + $ apptainer run my_container.sif 1 2 + Got arguments: 1 2 + Sum of numbers was: 3 + + +.. admonition:: Key points to remember + + - Bootstrap settings are analogous to what you would use with + ``apptainer pull``. + - The application inside the container could be much more complex. + By creating a ``apptainer run``-interface via ``%runscript``-block + you can convert a big and complex installation into what is + basically a single executable. + +Running additional installation commands during image creation +-------------------------------------------------------------- + +More often than not, creating an image involves more than +just using an existing image. + +If you want to run additional installation commands, +you can do them in a ``%post``-block. These commands will +be run once during the building procedure. + +For example, let's modify our definition file so that we get an installation +of `numpy `__-package in the image: + +.. code-block:: singularity + + Bootstrap: docker + From: python:latest + + %files + summation.py /opt + + %runscript + echo "Got arguments: $*" + exec python /opt/summation.py "$@" + + %post + pip install numpy + +After re-building the image we can test the numpy installation with: + +.. code-block:: console + + $ apptainer exec my_container.sif python -c 'import numpy; print(numpy.__version__)' + +.. admonition:: Expected result + :class: dropdown + + During the build process we should see that the numpy-package is + being installed. + + Running the container should produce the following output: + + .. code-block:: console + + $ apptainer exec my_container.sif python -c 'import numpy; print(numpy.__version__)' + 1.26.4 + +.. admonition:: Image building is done as a fake root-user + + Commands that are run in the ``%post`` step and in other setup steps + are run in a state called + `fakeroot `__ where + the user looks like the ``root``-user inside the container when in reality + the user is a normal user. + + This means that use of ``sudo`` is not needed when installing packages via + package managers. + + When converting installation instructions written for normal + non-containerized installations to definition files + one should usually remove ``sudo`` from the front of commands. + +.. warning:: + + Remember that images should not contain any secrets + (passwords, sensitive code or data etc.)! + + Anybody who has access to the image can access all files + in the image. + + +Setting environment variables in the image +------------------------------------------ + +We can also specify that additional environment variables should be set +when the image is being launched with an ``%environment``-block. + +While ``%runscript`` only applies when we ``apptainer run`` the image, +commands specified in the ``%environment``-block will be executed when +the image is launched. + +Let's use this opportunity to set the terminal language options +in the container. Usually containers do not have all available language +settings installed, so setting these environment variables is very common. + +.. code-block:: singularity + + Bootstrap: docker + From: python:latest + + %files + summation.py /opt + + %runscript + echo "Got arguments: $*" + exec python /opt/summation.py "$@" + + %post + pip install numpy + + %environment + export LC_ALL=C + export LANGUAGE=C + export LANG=C + +After re-building the image we can test that the environment values is set with: + +.. code-block:: console + + $ apptainer exec my_container.sif python -c 'import os; print(os.getenv("LANG"))' + + +.. admonition:: Expected result + :class: dropdown + + After rebuilding the container running the container should produce the following output: + + .. code-block:: console + + $ apptainer exec my_container.sif python -c 'import os; print(os.getenv("MYVAR"))' + yes + +You can also set environment variables when running an image by +setting ``APPTAINERENV_MYVAR=myvalue`` outside of the container or +by giving ``--env MYVAR=myvalue`` as a flag to the +``run``/``exec``/``shell``-command. + +For more info on how to set environment variables when running containers, +see `this page `__ +from Apptainer's documentation. + + +Adding documentation to your image +---------------------------------- + +If you're planning on sharing your image with other people or you want to +keep tabs on multiple images you can use labels to mark your image with +a ``%labels``-block. + +You can also add a ``%help``-block that will tell users on how to use your +image. + +Let's add these blocks to the definition file: + + +.. code-block:: singularity + + Bootstrap: docker + From: python:latest + + %files + summation.py /opt + + %runscript + echo "Got arguments: $*" + exec python /opt/summation.py "$@" + + %post + pip install numpy + + %environment + export LC_ALL=C + export LANGUAGE=C + export LANG=C + + %labels + Author: CodeRefinery + Version: v0.0.1 + Description: This is an example image + + %help + This container sums up numbers. + + Example: + + apptainer run my_container.sif 1 2 + + +Let's check the help message with: + +.. code-block:: console + + $ apptainer run-help my_container.sif + +.. admonition:: Expected result + :class: dropdown + + The output should look something like this: + + .. code-block:: console + + $ apptainer run-help my_container.sif + This container sums up numbers. + + Example: + + apptainer run my_container.sif 1 2 + + +Examining the container +----------------------- + +Now that we have a container with some software in it we can examine it with + +.. code-block:: console + + $ apptainer inspect my_container.sif + +.. admonition:: Expected result + :class: dropdown + + The output should look something like this: + + .. code-block:: console + + $ apptainer inspect my_container.sif + Author:: CodeRefinery + Description:: This is an example image + Version:: v0.0.1 + org.label-schema.build-arch: amd64 + org.label-schema.build-date: Thursday_25_April_2024_21:45:51_EEST + org.label-schema.schema-version: 1.0 + org.label-schema.usage.apptainer.version: 1.3.0 + org.label-schema.usage.singularity.deffile.bootstrap: docker + org.label-schema.usage.singularity.deffile.from: python:latest + +We can also see the image contents with + +.. code-block:: console + + $ apptainer sif list my_container.sif + +.. admonition:: Expected result + :class: dropdown + + Output of the command should be something like this: + + .. code-block:: console + + $ apptainer sif list my_container.sif + ------------------------------------------------------------------------------ + ID |GROUP |LINK |SIF POSITION (start-end) |TYPE + ------------------------------------------------------------------------------ + 1 |1 |NONE |32176-32385 |Def.FILE + 2 |1 |NONE |32385-34957 |JSON.Generic + 3 |1 |NONE |34957-35407 |JSON.Generic + 4 |1 |NONE |36864-394522624 |FS (Squashfs/-System/amd64) + + +From the output of the previous command we see that at position 1 of the file we have +the definition file used to build the image. We can examine that with + +.. code-block:: console + + $ apptainer sif dump 1 my_container.sif + + +Additional definition file options +---------------------------------- + +There are plenty of other sections that can be used in the definition +file. For a great and comprehensive documentation, see +`Apptainer's documentation for definition files `__. + +These features include: + - Creating multiple callable applications in the image + - Creating services that can be started and stopped + - Creating tests for the image build + + +.. admonition:: Key points to remember + + - Use ``apptainer pull`` to pull existing Docker images. + - Use ``apptainer build`` to build custom images from definition files. + - Do not store secret information in images. + - There are plenty of additional features provided. Check documentation + for more info. diff --git a/branch/maikens_comments/_sources/conda.rst.txt b/branch/maikens_comments/_sources/conda.rst.txt new file mode 100644 index 0000000..fd6d889 --- /dev/null +++ b/branch/maikens_comments/_sources/conda.rst.txt @@ -0,0 +1,60 @@ +Reproducibility with Python +=========================== + +.. objectives:: + + * Understand the role of Conda environments in ensuring reproducibility in scientific computing. + * Learn how to set up a Conda environment within an Apptainer container. + * Develop skills to create and manage Python environments that are consistent across various computing platforms. + + This demo demonstrates the creation of a Conda environment within an Apptainer container to enhance reproducibility in scientific computing. Conda is a popular package management system that simplifies package installation and environment management. This is crucial in scientific research where experiments often require specific versions of software and libraries to ensure consistent results. + +.. prerequisites:: + + * Access to an HPC system with Apptainer installed. + * Basic knowledge of Python, Conda, and container technologies. + +Reproducibility is a cornerstone of scientific research, ensuring that results are consistent over time and across different platforms. By using Conda within Apptainer containers, researchers can encapsulate their computational environment, making their workflows portable and reproducible. + +First, we'll define a container with a Conda environment set up for a typical scientific Python stack. + +.. code-block:: bash + + # Example Apptainer definition file for setting up a Conda environment + Bootstrap: library + From: continuumio/miniconda3 + + %post + conda create -n scienv python=3.8 numpy scipy matplotlib ipython -y + echo "source activate scienv" >> ~/.bashrc + + %environment + export PATH=/opt/conda/envs/scienv/bin:$PATH + + %runscript + echo "Activating Conda environment and launching IPython..." + source activate scienv + ipython + + +.. code-block:: bash + + # Build the container that includes the Conda environment + apptainer build conda_container.sif conda.def + + +This block builds the ``conda_container.sif`` from the ``conda.def`` definition file, which uses the Miniconda image to install a Conda environment named ``scienv`` with several essential scientific computing packages like NumPy, SciPy, and Matplotlib. + + +.. code-block:: bash + + # Run the container, initiating the Conda environment + apptainer exec conda_container.sif /bin/bash -c "source ~/.bashrc && ipython" + + +This command starts a shell that activates the Conda environment and launches IPython, a powerful interactive shell for Python. This setup allows users to interactively compute and visualize data within the consistent environment provided by the container. + +Summary +------- +In this tutorial, you've learned how to create a reproducible Python computing environment using Conda within an Apptainer container. This approach is invaluable for scientific researchers who need to ensure that their computational experiments are consistent and reproducible, regardless of the underlying hardware or software environment. By leveraging Conda and Apptainer, you can significantly enhance the portability and reliability of your scientific workflows. + diff --git a/branch/maikens_comments/_sources/container_images.rst.txt b/branch/maikens_comments/_sources/container_images.rst.txt new file mode 100644 index 0000000..bd97d1d --- /dev/null +++ b/branch/maikens_comments/_sources/container_images.rst.txt @@ -0,0 +1,128 @@ +Intro to container images +========================= + +.. objectives:: + + * Learn what container image means + +Traditional container images (Docker etc.) +------------------------------------------ + +When containers launch they need a file system with a linux operating system. +This filesystem is provided by a **container image**. + +This naming comes from an analogy with a traditional image or a painting. + +.. figure:: https://upload.wikimedia.org/wikipedia/commons/6/6d/Saint_Jerome_Leonardo_-_image_only_%28Q972196%29.jpg + :width: 60% + + Figure 1: Saint Jerome in the Wilderness by Leonardo da Vinci + +Let's consider the image above. It is an unfinished painting by Leonardo da Vinci. + +From the unfinished nature of this painting you can see the following: + +- Some areas of the background panel are not touched at all (e.g. hands). +- The base background is in some places covered by sketches (e.g the lion) and in most places by the background colors. +- The background colors are sometimes covered in sketches as well (e.g. top left). + +From these things we can gather that the image is constructed from **layers** where +paint or sketches **cover what is hidden underneath**. + +This analogy happens with traditional container images as well (e.g. docker images): +**container images consist of multiple layers where top layers can hide preceding layers**. + +A typical image might look something like this: + +.. figure:: img/image_explanation.png + + Figure 2: Typical container image consists of individual layers + +In practice this overwriting behaviour is done by using a file format called SquashFS, +where file systems are stored in one single layer. + +In a traditional image the image is built in this fashion: + +1. The build starts from a base image. This is often an OS image, but it does not have to + be. It can be some other image that has a OS image as its base image. +2. This layer is started up in a container. +3. Modifications are done. For example, an application is installed. +4. The **difference of what files were modified is stored into a new layer**. +5. This new image with the modifications is now used as a base image. +6. More modifications are done unless there are no more modifications to do. +7. The last layer is **tagged** with some human readable name. +8. When image is published to other users, it is sent to some container registry. + +The file that contains the commands that need to be run to build the image +is called a `Dockerfile `__. +This is true for systems other that Docker as well. + +This way of working with **differences of layers** reduces the space needed to +store the images and the network capacity needed to transfer the images. + +When a container is launched these layers are fetched and organized on top of each +other and when a program tries to find a file, it will go through the layers until it +finds it. This is analogous to light bouncing off from the top layer of paint on a +painting. Paint below the top layer is hidden. + +.. admonition:: Key points to remember + + - Traditional containers are built layer by layer. + - Traditional containers are built from Dockerfiles. + - Traditional container images are transferred via registries using + client tools or as ``.tar``-files. + +Apptainer container images +-------------------------- + +Apptainer works a bit differently than traditional container setups. + +Apptainer stores the container image in one file in +**Singularity image format** or **.sif**. This file is a SquashFS file with +additional metadata included. + +This means that **Apptainer does not store image as multiple layers**. +Instead it writes all of the layers into one single layer. This is analogous +to printing an image of a painting on a piece of paper. The hidden layers +of paint are not replicated and only the topmost layer is visible. + +.. figure:: img/image_explanation_apptainer.png + + Figure 3: Apptainer container image is a single unchanging image layer + +This way of working has some upsides and some downsides. + +Upsides include: + +- The image is more portable. One image can be easily transferred across + systems using normal file copying tools. +- The image is more reproducible. The metadata stored in the file gives + information on when the image was created and what commands were used + to create it. +- The image is easier to archive. One just needs to keep track of a single + file. + +Downsides include: + +- Image creation takes longer as all operations need to be done in one go. + Traditional container images can be built layer by layer. +- Images cannot be stored in traditional registries like Docker Hub. + +Apptainer images can use Docker images as their starting point. +Additional build steps and runtime behaviour can be specified in a +`definition file (.def) `__. + +.. admonition:: Key points to remember + + - Apptainer images are a single image layer which is stored in a .sif-file. + - When built from traditional image, Apptainer images squash all layers to a single one. + - Apptainer images are built from definition file (.def). + - Apptainer images are transferred as normal files. + + +Image sources +------------- + +- Leonardo da Vinci, `CC0 `__, via `Wikimedia Commons `__ + + diff --git a/branch/maikens_comments/_sources/debugging.rst.txt b/branch/maikens_comments/_sources/debugging.rst.txt new file mode 100644 index 0000000..d268cbb --- /dev/null +++ b/branch/maikens_comments/_sources/debugging.rst.txt @@ -0,0 +1,66 @@ +Debugging Containers +==================== + +.. objectives:: + + * Understand the importance of being able to debug applications within container environments. + * Learn to enter an Apptainer container using a shell for debugging purposes. + * Develop practical troubleshooting skills for containerized applications in an HPC setting. + + This demo will instruct on how to access an Apptainer container with a shell interface to perform debugging and troubleshooting tasks. Debugging within containers is crucial because it allows developers and administrators to directly interact with the running environment and resolve issues that may not be apparent from outside the container. + +.. prerequisites:: + + * Access to an HPC system with Apptainer installed. + * A container with a misbehaving application or one prepared for debugging. + * Basic familiarity with command-line interface operations and debugging tools. + +Containers encapsulate dependencies and environments but can sometimes obscure problems from the host system. By entering the container itself, you can use standard debugging tools and inspect the state of the application as it runs within its isolated environment. + +First, we'll set up a simple container that includes tools and an application setup conducive to debugging. Then, we'll demonstrate how to enter this container to troubleshoot issues. + +.. code-block:: bash + + # Example Apptainer definition file for a debuggable environment + Bootstrap: library + From: ubuntu:20.04 + + %post + apt-get update && apt-get install -y python3 python3-pip gdb vim + pip3 install flask + echo "from flask import Flask" > /app.py + echo "app = Flask(__name__)" >> /app.py + echo "@app.route('/')" >> /app.py + echo "def hello():" >> /app.py + echo " raise Exception('Intentional Error for Debugging')" >> /app.py + echo "if __name__ == '__main__':" >> /app.py + echo " app.run(host='0.0.0.0', port=5000, debug=True)" >> /app.py + + %environment + export FLASK_APP=/app.py + + %runscript + echo "Running Flask app with intentional errors for debugging..." + python3 /app.py + + +.. code-block:: bash + + # Build the container for debugging + apptainer build debug_container.sif debug.def + + +This block constructs the ``debug_container.sif`` from the ``debug.def`` file, which sets up a Flask application programmed to raise an exception. This setup is useful for demonstrating how to handle errors within a live application. + +.. code-block:: bash + + # Enter the container with a shell to start debugging + apptainer shell debug_container.sif + + +This command launches a shell within the ``debug_container.sif``, allowing you to interact directly with the container's environment. Inside the container, you can run the application, use tools like ``gdb`` or ``vim`` to inspect and modify files, or check logs to diagnose issues. + +Summary +------- +In this tutorial, you've learned how to enter an Apptainer container with a shell for the purpose of debugging applications. This skill is essential for software development and system administration in containerized environments, particularly in HPC where applications may behave differently due to complex interactions with underlying hardware and software layers. By mastering container debugging, you can significantly improve the reliability and performance of your applications. + diff --git a/branch/maikens_comments/_sources/env_scripts.rst.txt b/branch/maikens_comments/_sources/env_scripts.rst.txt new file mode 100644 index 0000000..99680d2 --- /dev/null +++ b/branch/maikens_comments/_sources/env_scripts.rst.txt @@ -0,0 +1,58 @@ +Environment Variables and Scripts +================================= + +.. objectives:: + + * Understand the role of environment variables in configuring software behavior inside containers. + * Learn to set and export environment variables within an Apptainer container. + * Develop the ability to customize the behavior of applications running in containers through environmental configuration. + + This demo will show you how to set and manipulate environment variables inside an Apptainer container. Environment variables are a critical component in software development and deployment, allowing you to modify the behavior of applications without changing code. They are especially useful in containerized environments where they can be used to control and customize settings across different deployments seamlessly. + +.. prerequisites:: + + * Access to an HPC system with Apptainer installed. + * Basic familiarity with shell scripting and command line operations. + +Setting environment variables inside a container is an essential skill for software developers and system administrators. These variables can dictate operational parameters such as database connections, logging levels, and other configurable settings that an application might need to operate correctly in different environments. In this demo, you will learn how to set these variables within an Apptainer container, ensuring your applications behave as expected under various conditions. + +First, we will create a simple Apptainer definition file that includes the necessary commands to set environment variables. Then, we will build and run the container to see how these variables affect the application's behavior. + +.. code-block:: bash + + # Example Apptainer definition file setting environment variables + Bootstrap: library + From: ubuntu:20.04 + + %post + apt-get update && apt-get install -y vim + echo 'export MY_VAR="Hello from Apptainer!"' >> /etc/profile + + %environment + export PATH="/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:$PATH" + export ANOTHER_VAR="Another example variable" + + %runscript + echo "MY_VAR is set to $MY_VAR" + echo "ANOTHER_VAR is set to $ANOTHER_VAR" + + +.. code-block:: bash + + # Build the container with environment variables + apptainer build env_container.sif env.def + + +This block creates the ``env_container.sif`` container from the ``env.def`` file. It sets up an Ubuntu-based environment and installs Vim as an example application. The ``%post`` section modifies the system profile to permanently set an environment variable, while ``%environment`` sets it specifically for when the container is run. + +.. code-block:: bash + + # Run the container to see environment variables in action + apptainer run env_container.sif + + +This final command executes the container, running the script defined in ``%runscript``. It outputs the values of the environment variables set during the build phase and the runtime environment, demonstrating how these can be manipulated within the container. + +Summary +------- +In this tutorial, you've learned how to set and export environment variables within an Apptainer container to influence the behavior of contained software applications. This skill is vital for managing software configurations in a reproducible and scalable manner across various computing environments. By using environment variables effectively, you can ensure that your applications perform consistently no matter where they are deployed. diff --git a/branch/maikens_comments/_sources/first_build.rst.txt b/branch/maikens_comments/_sources/first_build.rst.txt new file mode 100644 index 0000000..a6bab10 --- /dev/null +++ b/branch/maikens_comments/_sources/first_build.rst.txt @@ -0,0 +1,66 @@ +Building Your First Container +============================= + +.. objectives:: + + * Understand the basic concept and utility of containerization in HPC environments. + * Learn to create an Apptainer container using a definition file. + * Apply this knowledge to build reproducible computing environments. + + In this demo, you will learn how to build your first container using Apptainer, starting from a simple definition file. Containers are crucial for creating reproducible, portable, and scalable environments that are isolated from the underlying infrastructure. This hands-on example will guide you through the process of defining and building a basic container, which is a foundational skill in using containers effectively in high-performance computing. + +.. prerequisites:: + + * No prerequisites for following the demo + + +Building your first container is a significant first step to test the technology and make sure it works in the cluster(s) you use. This example is based on the typical case when you need to install and run a specific tool which cannot be easily installed by your HPC cluster admins. This can happen if certain tools are really tight to some specific system-wide dependencies (e.g. certain versions of libraries, compilers, operating system). + + +For the sake of learning, assume that the three tools ``fortune``, ``cowsay``, and ``lolcat`` cannot be installed by your cluster admins, and have strict requirements that you cannot just install them by yourself without root privileges. + + +.. code-block:: bash + + # Example definition file content for Apptainer + Bootstrap: docker + From: ubuntu:20.04 + + %post + apt-get -y update + apt-get -y install fortune cowsay lolcat + + %environment + export LC_ALL=C + export PATH=/usr/games:$PATH + + %runscript + fortune | cowsay | lolcat + + # Save the above content into a file named 'mydefinition.def' + + +Next we need to build the container image. + +.. code-block:: bash + + # Build an Apptainer container from a definition file + apptainer build mycontainer.sif mydefinition.def + + + +This command constructs a container named 'mycontainer.sif' from the definition file 'mydefinition.def'. The ``.sif`` file format is a portable container format used by Apptainer. This step is essential as it compiles all the necessary components and software specified in your definition file into a single executable container. + +Summary +------- +This example showed you how to build a basic container using Apptainer from a definition file. You've learned a critical skill in containerization, enabling you to create reproducible and portable environments for a wide range of scientific applications. This capability is foundational in leveraging the full potential of HPC resources while ensuring consistency across different computing environments. + + +.. exercise:: Build a simple container and test it + + Build a simple container on your cluster. You do not have to use the example above. Test the following: + 1. Start a terminal shell on the container and run a command such as ``date`` + 2. Test the `runscript` part for the container above. How do you run it and what is the output? + + + diff --git a/branch/maikens_comments/_sources/gpus.rst.txt b/branch/maikens_comments/_sources/gpus.rst.txt new file mode 100644 index 0000000..a082681 --- /dev/null +++ b/branch/maikens_comments/_sources/gpus.rst.txt @@ -0,0 +1,92 @@ +Running containers that use GPUs +================================ + +.. objectives:: + + * Learn how you can use GPUs with containers + +If your program uses GPUs, you'll need to make the GPUs visible in +the container. This is done by giving additional flag to the +apptainer command. + +The container itself must have the correct GPU computing libraries +installed inside the image (CUDA toolkit for NVIDIA and ROCm for AMD). +Code inside the image needs to be installed with GPU support as well. +Apptainer will only mount the driver libraries and the GPU devices +that these toolkits need to run the code on GPUs. + +Using NVIDIA's GPUs +******************* + +When using NVIDIA's GPUs that use the CUDA-framework the flag is ``--nv``. + +As an example, let's get a CUDA-enabled PyTorch-image: + +.. code-block:: console + + $ apptainer pull pytorch-cuda.sif docker://docker.io/pytorch/pytorch:2.2.2-cuda12.1-cudnn8-runtime + +Now when we launch the image, we can give the image GPU access with + +.. code-block:: console + + $ apptainer exec --nv pytorch-cuda.sif python -c 'import torch; print(torch.cuda.is_available())' + +.. figure:: img/nv_example.png + + Figure 1: Enabling NVIDIA's GPUs in containers + +.. admonition:: Expected result + :class: dropdown + + If you run this in a system with an NVIDIA GPU, you should see the following result: + + .. code-block:: console + + $ apptainer exec --nv pytorch-cuda.sif python -c 'import torch; print(torch.cuda.is_available())' + True + +.. admonition:: Key points to remember + + - Code inside the container image needs to support GPU calculations. + - Container image should have a working CUDA toolkit installed. + - Use ``--nv``-flag to mount the device drivers inside of the image. + + +Using AMD's GPUs +**************** + +When using AMD's GPUs that use the ROCm-framework the flag is ``--rocm``. + +As an example, let's get a ROCm-enabled PyTorch-image: + +.. code-block:: console + + $ apptainer pull pytorch-rocm.sif docker://docker.io/rocm/pytorch:rocm6.1_ubuntu22.04_py3.10_pytorch_2.1.2 + +Now when we launch the image, we can give the image GPU access with + +.. code-block:: console + + $ apptainer exec --rocm pytorch-rocm.sif python -c 'import torch; print(torch.cuda.is_available())' + +.. figure:: img/rocm_example.png + + Figure 2: Enabling AMD's GPUs in containers + + +.. admonition:: Expected result + :class: dropdown + + If you run this in a system with an AMD GPU, you should see the following result: + + .. code-block:: console + + $ apptainer exec --rocm pytorch-rocm.sif python -c 'import torch; print(torch.cuda.is_available())' + True + +.. admonition:: Key points to remember + + - Code inside the container image needs to support GPU calculations. + - Container image should have a working ROCm toolkit installed. + - Use ``--rocm``-flag to mount the device drivers inside of the image. diff --git a/branch/maikens_comments/_sources/index.rst.txt b/branch/maikens_comments/_sources/index.rst.txt new file mode 100644 index 0000000..f58fef7 --- /dev/null +++ b/branch/maikens_comments/_sources/index.rst.txt @@ -0,0 +1,137 @@ +Containers on HPC with Apptainer +================================ + +.. warning:: + + This is under construction. + +.. admonition:: Course instance in May 2024 + + You can follow the dates this course is given on the `course page + `__. + Dates are not yet known and registration is not yet open, though. + + +Improve your cluster workflows! You've had a basic course on working +with a cluster - but what do people *actually* do? This course shows +practical examples and tips which may help you, but aren't usually +covered in either basic or advanced courses. + +We won't go so deep into each topic that you know everything about it, +but you learn what is possible, see some examples, and know where to +follow up on the tools that are right for *you*. The format is +designed to be "fireside chat with experts", a combination of demos, +type-along, and independent exercises. You can engage at different +levels, depending on your interest. + + +.. prereq:: + + * Basic HPC usage course (if you don't have, many of the things we + talk about won't make sense, but you might pick up something + anyway). + * A bit of experience using a HPC cluster (technically optional, + but will allow you to engage with the material at a deeper + level). + * Access to some HPC computer cluster to do most exercises. + (Slurm-based, but most are these days). (If you don't have, you + can't do all exercises - but still might learn something!) + + +.. csv-table:: + :widths: auto + :delim: ; + + 15 min ; :doc:`intro_and_motivation` + 20 min ; :doc:`basics_running_containers` + 15 min ; :doc:`container_images` + 10 min ; Break + 25 min ; :doc:`building_images` + 15 min ; :doc:`binding_folders` + 05 min ; Open discussion and where to go next + + +.. toctree:: + :maxdepth: 1 + :caption: The lesson + + intro_and_motivation.rst + basics_running_containers.rst + container_images.rst + building_images.rst + binding_folders.rst + + +.. toctree:: + :maxdepth: 1 + :caption: Extras + + gpus.rst + services_apps.rst + tips_tricks.rst + + + +.. toctree:: + :maxdepth: 1 + :caption: Exercises + + verify_installation.rst + first_build.rst + + + +.. _learner-personas: + +Who is the course for? +---------------------- + +This course is for people using clusters or other larger computing +resources. It's not a basic course, but also not extremely advanced. +It lets you see some examples and know what people actually do, and +then you can follow up with more reading, courses, or direct help +later on. + +Some learner personas: + +- You've just taken a basic HPC course, and while you mostly + understand how the basic pices work, you are left wondering *"How + does this all fit together? How do people combine all of these + tools into an actual whole workflow?"*. + + You care about some real examples and things you can use right now, + but wouldn't mind seeing some advanced or out-of-scope stuff as long + as you don't have to spend too much mental effort on it. + + You'll probably do the more basic exercises and watch the rest as a + demo until you come back to it later (if needed). + +- You've been using the cluster for a while and doing your work just + fine - or so you think. It works well, but you know there must be + some other tricks out there that can make your life (if not work) + even better. + + You'll probably attend and do the more advanced exercises, while + passively watching some of the more basic demos. + + +About the course +---------------- + + + + + + + +See also +-------- + + + + + +Credits +------- + +This course is a collaboration between ~10 different instructors. diff --git a/branch/maikens_comments/_sources/inspecting.rst.txt b/branch/maikens_comments/_sources/inspecting.rst.txt new file mode 100644 index 0000000..322fa16 --- /dev/null +++ b/branch/maikens_comments/_sources/inspecting.rst.txt @@ -0,0 +1,62 @@ +Inspecting Containers +===================== + +.. objectives:: + + * Understand the importance of inspecting containers to verify configurations and settings. + * Learn to use Apptainer's inspect command to view metadata, files, and environment settings within a container. + * Develop skills to assess and troubleshoot container configurations in HPC environments. + + This demo demonstrates how to use the ``inspect`` command in Apptainer to examine various aspects of a container. Inspecting a container is crucial for ensuring that it has been configured correctly, verifying that all necessary dependencies are included, and understanding how the container interacts with its environment. This capability is especially important in complex HPC setups where precise control over the computational environment is needed to ensure reproducibility and security. + +.. prerequisites:: + + * Access to an HPC system with Apptainer installed. + * A container already built and available for inspection. + +The ability to inspect a container provides transparency into the containerized environment, which is invaluable for debugging, compliance checks, and enhancing security. In this demo, you will inspect an existing container to reveal its configuration details. + +First, we will provide an example of a simple container definition file used to build a container, which we will then inspect. + +.. code-block:: bash + + # Example Apptainer definition file for inspection demo + Bootstrap: library + From: ubuntu:20.04 + + %post + apt-get update && apt-get install -y vim + echo 'export TEST_VAR="This is a test environment variable"' >> /etc/environment + + %environment + export MY_APP_VERSION="1.0" + echo "Environment ready." + + %labels + AUTHOR "John Doe" + VERSION "1.0" + DESCRIPTION "This is a sample container for inspection purposes." + + + +.. code-block:: bash + + # Build the container for inspection + apptainer build inspect_container.sif inspect.def + + +This block builds the ``inspect_container.sif`` from the ``inspect.def`` file, which includes a simple environment setup and labels for metadata. This setup prepares the container for detailed inspection. + +.. code-block:: bash + + # Inspect the container to view metadata, environment variables, and runscript + apptainer inspect --labels --environment --runscript inspect_container.sif + + + +This command uses Apptainer's inspect functionality to show the container's labels, environment variables, and the script that runs when the container is executed. These details are critical for understanding how the container is configured and for verifying its contents. + +Summary +------- +In this tutorial, you've learned how to inspect an Apptainer container to understand its internal configurations, including metadata, environment settings, and operational scripts. This knowledge is essential for managing and troubleshooting containers effectively, especially in research and development environments where precision and reproducibility are paramount. + diff --git a/branch/maikens_comments/_sources/instructor-guide.rst.txt b/branch/maikens_comments/_sources/instructor-guide.rst.txt new file mode 100644 index 0000000..89553fb --- /dev/null +++ b/branch/maikens_comments/_sources/instructor-guide.rst.txt @@ -0,0 +1,37 @@ +Instructor's guide +================== + +Why we teach this lesson +------------------------ + + + +Intended learning outcomes +-------------------------- + + + +Timing +------ + + + +Preparing exercises +------------------- + +e.g. what to do the day before to set up common repositories. + + + +Other practical aspects +----------------------- + + + +Interesting questions you might get +----------------------------------- + + + +Typical pitfalls +---------------- diff --git a/branch/maikens_comments/_sources/intro_and_motivation.rst.txt b/branch/maikens_comments/_sources/intro_and_motivation.rst.txt new file mode 100644 index 0000000..55294d0 --- /dev/null +++ b/branch/maikens_comments/_sources/intro_and_motivation.rst.txt @@ -0,0 +1,132 @@ +Intro to containers (on HPC) +============================ + +.. objectives:: + + * Understand the basic logic and terms behind container technology + * Learn about the possible use cases for containers on HPC clusters + +What even is a container? +------------------------- + +Containers take their name from shipping containers: + +.. figure:: https://upload.wikimedia.org/wikipedia/commons/3/36/Shipping_container%2C_Bellarena_-_geograph.org.uk_-_1859736.jpg + + Figure 1: A shipping container in its natural habitat + +This analogue is based on the idea is that containers have a barrier +between the insides of the container and outside of the container. +This makes shipping them between ports easy. + +Based on this analogue one might think that the container is just a +storage format. It is that as well: containers are stored in container +images (more on this in a later chapter). + +Instead it is a way of running **an application in a self-contained +environment with all the tools that this specific application needs**. + +More traditional container launchers like Docker, Podman and Kubernetes +also manage containers' resource usage, networking and various other aspects. +When using Apptainer, we do not need to worry about these features. + +.. admonition:: More technical information on how traditional containers work + :class: dropdown + + Traditional containers use + `linux namespaces `__ + when they implement various features. These features include: + + - **Creating a separate process identifier (PID) namespace:** + This means that process id's are not shared in the container and on + the host. + - **Creating a virtual network for the containers:** + Container runtimes such as docker often create virtual network + interfaces that the containers can use to communicate like actual + virtual machines. + - **Limiting container resources:** + Container runtimes usually limit container resource usage + (CPU usage, RAM usage) via Linux control groups (cgroups). + + Apptainer does none of these as it is meant to be run as a normal + user and not as a superuser. + + Apptainer does use + `user namespaces `__ + for launching the container without giving the user additional privileges. + + +Let's consider the following case: + +1. User installs and runs an application on a their home computer +2. They want to run the exact same application on their HPC cluster +3. The operating system / available software is different on the HPC cluster +4. Even if the program runs, it is necessarily not the **exact same program** as operating system has changed + +.. figure:: img/normal_application.png + + Figure 2: Without containers, your program uses libraries from the host system + +With containers the user would run the exact same container on both systems: + +.. figure:: img/containerized_application.png + + Figure 3: With containers, your program uses libraries from the container image + +.. admonition:: Key points to remember + + Containers are a way of launching applications in a self-contained + environment with their own OS and program libraries. + + The filesystem used by containers is stored in container images. We'll talk + more on container images later. + + Remember that the word container can refer to: + - a running container with it's own environment + - the container image that defines the container environment + + +What is the intended use case of Apptainer? +------------------------------------------- + +Apptainer is meant for running complex applications in various systems such +as HPC systems in a reproducible and portable way. + +There are many uses, but here are some example: + +- Installing an application that has installation instructions designed for a specific operating system different than the one you are on. +- Creating a self-contained application that can be used as a part of your + workflow in multiple different systems and can easily be shared with colleagues +- Creating a finished application that can be shared with your paper +- Reducing the amount of files needed to install an application by putting + all files in the image (especially useful for Python environments) + + +Apptainer vs. Singularity +------------------------- + +Singularity started as an open source project from Lawrence Berkeley National +Laboratory in 2015. In 2018 a company called Sylabs was founded to provide +commercial support for sites that use it. + +In 2021 the project joined Linux Foundation and was renamed Apptainer. + +Sylabs is still present and they maintain their own fork of the project called +SingulartyCE. + +For more info, see the +`Singularity wikipedia article `__. + +.. admonition:: Key points to remember + + Your site might be running Singularity, SingularityCE or Apptainer. + + In most cases the user interface is completely the same. + + If you're running ``singularity`` you can just rename any + ``apptainer``-commands to ``singularity``. + +Image sources +------------- + +- Shipping container, Bellarena by Rossographer, `CC BY-SA 2.0 `__, via `Wikimedia Commons `__ diff --git a/branch/maikens_comments/_sources/mpi_demo.rst.txt b/branch/maikens_comments/_sources/mpi_demo.rst.txt new file mode 100644 index 0000000..e9c0c49 --- /dev/null +++ b/branch/maikens_comments/_sources/mpi_demo.rst.txt @@ -0,0 +1,68 @@ +Running Parallel Jobs +===================== + +.. objectives:: + + * Understand the integration of MPI with containerized environments. + * Learn to execute a script that runs parallel computational jobs using MPI inside an Apptainer container. + * Acquire skills to leverage HPC resources for parallel computing within containerized applications. + + This demo demonstrates how to run parallel computational jobs inside an Apptainer container using the Message Passing Interface (MPI). Parallel computing is essential in HPC for solving complex and large-scale problems efficiently. By running these jobs inside containers, you can enhance portability and reproducibility of your computations across different HPC systems. This example will guide you through setting up an MPI environment inside a container and executing a parallel job script. + +.. prerequisites:: + + * Access to an HPC system with Apptainer installed. + * Basic knowledge of parallel computing and MPI. + * User permissions to run jobs on the HPC cluster. + +Containers can encapsulate all the necessary software and libraries, providing a consistent runtime environment for applications. This is particularly beneficial for parallel computing where environmental consistency can significantly affect computational results. In this demo, you will use Apptainer to encapsulate the MPI environment and ensure that your parallel jobs can be executed seamlessly on any HPC system. + +First, you will create a definition file for an Apptainer container that includes MPI libraries and a simple MPI script. Then, you will build the container and run a parallel job using MPI. + +.. code-block:: bash + + # Apptainer definition file for MPI environment + Bootstrap: library + From: ubuntu:20.04 + + %post + apt-get update && apt-get install -y mpich + echo "Hello from MPI" > /mpi_test.c + echo "#include " >> /mpi_test.c + echo "int main(int argc, char* argv[]) {" >> /mpi_test.c + echo " MPI_Init(&argc, &argv);" >> /mpi_test.c + echo " int rank;" >> /mpi_test.c + echo " MPI_Comm_rank(MPI_COMM_WORLD, &rank);" >> /mpi_test.c + echo " printf(\"Rank %d: Hello MPI World!\\n\", rank);" >> /mpi_test.c + echo " MPI_Finalize();" >> /mpi_test.c + echo " return 0;" >> /mpi_test.c + echo "}" >> /mpi_test.c + mpicc /mpi_test.c -o /mpi_hello + + %environment + export PATH=/usr/local/bin:$PATH + + %runscript + mpirun -np 4 /mpi_hello + + +.. code-block:: bash + + # Build the MPI container + apptainer build mpi_container.sif mpi.def + + +This block creates the container ``mpi_container.sif`` from the definition file ``mpi.def``. It includes installing MPICH, a popular MPI implementation, and compiling a simple MPI program that will be executed within the container. + +.. code-block:: bash + + # Run the MPI container job + apptainer exec --nv mpi_container.sif mpirun -np 4 /mpi_hello + + +This command runs the MPI program inside the container across four processes. The ``--nv`` option allows the container to access the host's Nvidia GPU resources if available, which is useful for MPI jobs that may benefit from GPU acceleration. + +Summary +------- +You have successfully learned how to set up and execute parallel computational jobs using MPI inside an Apptainer container. This ability is critical for ensuring that your scientific computing tasks are both scalable and reproducible, regardless of the underlying HPC infrastructure. By encapsulating the MPI environment inside a container, you maintain consistency and control over the software dependencies, significantly enhancing the reliability of your computational results. + diff --git a/branch/maikens_comments/_sources/networking.rst.txt b/branch/maikens_comments/_sources/networking.rst.txt new file mode 100644 index 0000000..436218f --- /dev/null +++ b/branch/maikens_comments/_sources/networking.rst.txt @@ -0,0 +1,57 @@ +Networking in Containers +======================== + +.. objectives:: + + * Understand the impact of network configurations on containerized applications in HPC environments. + * Learn to configure and test network settings within an Apptainer container. + * Acquire the ability to ensure network connectivity and proper configuration for applications running inside containers. + + This demo focuses on the configuration and testing of network settings within an Apptainer container. Networking is a critical component of containerized applications, particularly when these applications need to communicate with external resources or other applications within a cluster. Proper network configuration helps ensure that containers are both secure and functional, aligning with the network policies of the HPC environment. + +.. prerequisites:: + + * Access to an HPC system with Apptainer installed. + * Basic knowledge of networking concepts such as IP addressing, DNS, and port mapping. + * Permissions to modify network settings on the host, if necessary. + +Networking within containers can be complex due to the isolation provided by the container environment. This isolation, while beneficial for security and resource management, can complicate network communication unless properly configured. In this demo, you'll learn how to set up and verify network configurations that allow your containerized applications to communicate effectively and securely. + +First, let's define a container that includes networking tools for testing connectivity and configurations. + +.. code-block:: bash + + # Create an Apptainer definition file with network tools + Bootstrap: library + From: ubuntu:20.04 + + %post + apt-get update && apt-get install -y iproute2 net-tools inetutils-ping + + %runscript + echo "Checking network configuration..." + ifconfig + echo "Pinging google.com to test DNS resolution and internet connectivity..." + ping -c 4 google.com + + +.. code-block:: bash + + # Build the container with networking capabilities + apptainer build net_container.sif net.def + + +This block compiles the ``net_container.sif`` container from the ``net.def`` file, which includes necessary tools such as ``ifconfig`` for checking IP addresses, ``net-tools`` for various network operations, and ``ping`` to test connectivity. + +.. code-block:: bash + + # Run the container to test network settings + apptainer exec net_container.sif /bin/bash + + +This command launches the container, allowing you to interact with the shell and manually execute commands to inspect and test the network settings as defined in the ``%runscript`` section. You can verify the network interface configurations and test internet connectivity via DNS resolution. + +Summary +------- +In this tutorial, you've learned how to configure and test network settings within an Apptainer container. Understanding and managing network configurations is essential for the deployment of containerized applications in HPC environments, especially those that require external network communication or are part of a larger distributed system. By ensuring that your containers are properly configured to handle network traffic, you enhance their utility and integration into broader computing frameworks. + diff --git a/branch/maikens_comments/_sources/overlay.rst.txt b/branch/maikens_comments/_sources/overlay.rst.txt new file mode 100644 index 0000000..01ef235 --- /dev/null +++ b/branch/maikens_comments/_sources/overlay.rst.txt @@ -0,0 +1,62 @@ +Overlay File Systems +==================== + +.. objectives:: + + * Understand the concept and utility of overlay file systems in container technology. + * Learn how to use overlay file systems to modify contents within an Apptainer container at runtime. + * Develop the ability to dynamically alter container environments, enhancing flexibility for computational tasks. + + This demo explains the use of overlay file systems with Apptainer containers. Overlay file systems allow modifications to a container's file system during runtime without altering the base image. This capability is crucial for scenarios where temporary changes are needed for a session or when permissions restrict modifications to the container's base image. + +.. prerequisites:: + + * Access to an HPC system with Apptainer installed. + * A basic container already available for modification. + * Understanding of file system structures and permissions. + +Overlay file systems in containers are particularly useful in multi-user environments like HPC systems, where users may need to experiment with different configurations without affecting the original container setup. By using overlays, users can ensure that their modifications are temporary and do not impact other users. + +First, we'll set up a simple container with a base configuration, and then demonstrate how to use an overlay to modify its contents at runtime. + +.. code-block:: bash + + # Example Apptainer definition file for a basic container + Bootstrap: library + From: ubuntu:20.04 + + %post + apt-get update && apt-get install -y curl + mkdir /app + echo "Hello from the base container!" > /app/message.txt + + %runscript + cat /app/message.txt + + + +.. code-block:: bash + + # Build the base container + apptainer build base_container.sif base.def + + +This block constructs the ``base_container.sif`` from the ``base.def`` definition file, which includes installing basic utilities and creating an initial message file in the ``/app`` directory. + +.. code-block:: bash + + # Create a temporary overlay directory on the host + mkdir -p /home/user/my_overlay/upper /home/user/my_overlay/work + + # Example command to run the container with an overlay + apptainer run --overlay /home/user/my_overlay/upper:/home/user/my_overlay/work:rw base_container.sif + + +This command runs ``base_container.sif`` with an overlay file system. The overlay consists of an upper directory (``/home/user/my_overlay/upper``) where changes are written, and a work directory (``/home/user/my_overlay/work``) that is used by the overlay file system to manage these changes. + +Inside the container, you can modify ``/app/message.txt`` or add new files. These changes will appear in the upper directory on the host, demonstrating how overlays allow for runtime modifications without altering the original container image. + +Summary +------- +In this tutorial, you've learned how to use overlay file systems with Apptainer to dynamically modify container contents at runtime. This technique is invaluable for testing, development, and computational experiments in HPC environments, allowing users to tailor their environments temporarily without impacting the stability and integrity of the base container. This flexibility greatly enhances the usability and adaptability of containerized applications in research and production settings. + diff --git a/branch/maikens_comments/_sources/quick-reference.rst.txt b/branch/maikens_comments/_sources/quick-reference.rst.txt new file mode 100644 index 0000000..492da1e --- /dev/null +++ b/branch/maikens_comments/_sources/quick-reference.rst.txt @@ -0,0 +1,2 @@ +Quick Reference +=============== diff --git a/branch/maikens_comments/_sources/readonlydirs.rst.txt b/branch/maikens_comments/_sources/readonlydirs.rst.txt new file mode 100644 index 0000000..6836113 --- /dev/null +++ b/branch/maikens_comments/_sources/readonlydirs.rst.txt @@ -0,0 +1,64 @@ +Container Security Features +=========================== + +.. objectives:: + + * Understand Apptainer's security model and its implications for HPC environments. + * Learn how to bind host directories to a container as read-only to prevent unauthorized changes. + * Develop the ability to securely configure containers to protect sensitive data and maintain system integrity. + + This demo explores the security features of Apptainer, with a focus on how to bind host directories as read-only within a container. Apptainer's ability to integrate securely into HPC systems makes it an invaluable tool for managing containerized applications in a multi-user environment. By making directories read-only, you can prevent unintended or malicious modifications to the host system from within the container, thus enhancing the security and stability of your computational infrastructure. + +.. prerequisites:: + + * Access to an HPC system with Apptainer installed. + * Basic knowledge of Linux filesystem permissions and container security concerns. + +Containers can significantly streamline the deployment and management of applications, but they also introduce new security challenges. Apptainer's security features, such as read-only bindings, are designed to mitigate these risks by strictly controlling how containers interact with the host filesystem. + +In this demo, we will create a container that includes tools for inspecting its environment, and then demonstrate the security implications of read-only host directory bindings. + +First, we will prepare a simple environment inside the container that attempts to write to a bound directory, showing the effect of the read-only property. + +.. code-block:: bash + + # Create an example host directory and a simple text file + mkdir /home/user/example_dir + echo "This is a host file" > /home/user/example_dir/hostfile.txt + + +.. code-block:: bash + + # Example Apptainer definition file with security settings + Bootstrap: library + From: ubuntu:20.04 + + %post + apt-get update && apt-get install -y nano + + %runscript + echo "Trying to modify the host file from within the container..." + nano /home/user/example_dir/hostfile.txt + + + +.. code-block:: bash + + # Build the container with basic tools + apptainer build security_container.sif security.def + + +This block builds the ``security_container.sif`` from the definition file ``security.def``, which includes installing Nano, a simple text editor, to demonstrate file editing within the container. + +.. code-block:: bash + + # Run the container with a read-only bind to the host directory + apptainer exec --bind /home/user/example_dir:/home/user/example_dir:ro security_container.sif /bin/bash + + +This command runs the container and binds the ``/home/user/example_dir`` directory from the host as read-only inside the container. When you try to modify ``hostfile.txt`` using Nano from within the container, you will see that the system prevents any changes, illustrating the effectiveness of read-only bindings for protecting host resources. + +Summary +------- +In this tutorial, you've explored key security features of Apptainer, focusing on read-only bindings of host directories. This technique is crucial for preventing unauthorized changes to the host filesystem from within containers, thereby safeguarding the integrity of both the host and the containerized applications. By implementing these security measures, you can enhance the overall resilience and stability of your HPC infrastructure against both unintentional errors and malicious attacks. + diff --git a/branch/maikens_comments/_sources/resources.rst.txt b/branch/maikens_comments/_sources/resources.rst.txt new file mode 100644 index 0000000..5d41f31 --- /dev/null +++ b/branch/maikens_comments/_sources/resources.rst.txt @@ -0,0 +1,70 @@ +Resource Limits +=============== + +.. objectives:: + + * Understand the importance of managing resource usage within containerized environments on a shared HPC cluster. + * Learn to set specific CPU and memory limits on an Apptainer container. + * Develop skills to optimize container performance while preventing resource contention among users. + + This demo demonstrates how to set resource limits on an Apptainer container, which is essential in a shared HPC environment to ensure fair usage and prevent any single user or job from monopolizing system resources. Managing these limits helps maintain system stability and improves overall cluster performance, especially during peak usage times. + +.. prerequisites:: + + * Access to an HPC system with Apptainer installed. + * Basic understanding of system resources like CPU cores and memory. + * Permissions to run resource-limited jobs on the HPC cluster. + +Resource limits on containers are crucial in multi-user environments where careful resource management is needed to avoid performance degradation. This tutorial will show you how to configure these settings, which can help in running multiple containerized applications concurrently without impacting each other's performance. + +First, we'll set up a simple Apptainer definition file that runs a resource-intensive task, and then apply CPU and memory limits to this container. + +.. code-block:: bash + + # Example Apptainer definition file for a resource-intensive task + Bootstrap: library + From: ubuntu:20.04 + + %post + apt-get update && apt-get install -y stress + + %runscript + echo "Starting stress test..." + stress --cpu 8 --io 4 --vm 2 --vm-bytes 256M --timeout 30s + + + +.. code-block:: bash + + # Build the container for the stress test + apptainer build stress_container.sif stress.def + + +This block builds the ``stress_container.sif`` from the ``stress.def`` file. It includes the ``stress`` tool, which is used to generate a controlled load on the system's resources to demonstrate the effects of CPU and memory limits. + +.. code-block:: bash + + # Run the container with specific CPU and memory limits + apptainer exec --apply-cgroups /path/to/cgroup_settings.json stress_container.sif + + +This command runs the ``stress_container.sif`` container with resource limits specified in a cgroups configuration file. This file (``cgroup_settings.json``) should contain JSON-formatted settings that define the CPU and memory limits for the container, like the following: + +.. code-block:: json + + { + "cpu": { + "shares": 512 + }, + "memory": { + "limit_in_bytes": "500M" + } + } + + +These settings restrict the container to using only a fraction of available CPU resources (``shares: 512``) and limit its memory usage to 500 MB. Adjust these values based on your cluster's policies and the specific requirements of your workload. + +Summary +------- +In this tutorial, you've learned how to set resource limits for an Apptainer container using cgroups. This approach is vital for managing resource allocation on shared HPC clusters, ensuring that all users and applications can operate effectively without resource contention. By implementing these limits, you can optimize the performance and reliability of containerized applications in a shared environment. + diff --git a/branch/maikens_comments/_sources/services_apps.rst.txt b/branch/maikens_comments/_sources/services_apps.rst.txt new file mode 100644 index 0000000..ef590d4 --- /dev/null +++ b/branch/maikens_comments/_sources/services_apps.rst.txt @@ -0,0 +1,178 @@ +Services and apps +================= + +What are services? +------------------ + +You can use Apptainer to launch services that run in +the background. Service might be, for example, a database +application that your code uses to fetch subsets from a +larger dataset. + +Creating containers for these kinds of services can +often be quite complicated as they might need specific +folders to be created or specific environment variables +to be set. + +What are apps? +-------------- + +When we're launching a complicated services or making +containers with more than one application we might also +want to specify multiple run scripts and entrypoints to +the container. + +This can be done in Apptainer containers by specifying +multiple apps in the definition file. + +Example: PostgreSQL container +----------------------------- + +The following example uses a +`PostgreSQL image `__ to +set up a PostgreSQL server. Launching the server requires +that certain directory mounts and environment variables are set. + +These have been found by looking at the +`docker-entrypoint.sh `__-script +that would start the image when using Docker. + +In the case of PostgreSQL, we'll most likely +want to use the PostgreSQL client to modify our databases. +We can do this by specifying an app for it. + +Let's look at the definition file: + +.. code-block:: singularity + + Bootstrap: docker + From: postgres:16 + + %environment + export LC_ALL=C + export LANG=C + export LANGUAGE=C + + %startscript + export POSTGRES_USER=$PGUSER + export POSTGRES_PASSWORD=$PGPASSWORD + export PGHOST=$HOSTNAME + export PGPORT=${PGPORT:-19200} + + # Run the entry script for PostgreSQL Docker image + exec docker-entrypoint.sh postgres "$@" + + %help + + This is a postgres container. + + The following data locations need to be mounted into the container: + + - Data location for the postgres: /var/lib/postgresql/data + - Location for the runfiles for postgres: /var/run/postgresql + + The start script needs the following arguments: + + - postgres user name + - postgres user password + + Usage: + + mkdir postgres_data + mkdir postgres_run + + export PGUSER=postgres_user + export PGPASSWORD=postgres_password + apptainer instance start --bind postgres_data:/var/lib/postgresql/data --bind postgres_run:/var/run/postgresql postgres_container.sif postgres_server + + apptainer instance list + + %apprun psql + export POSTGRES_USER=$PGUSER + export POSTGRES_PASSWORD=$PGPASSWORD + export PGHOST=$HOSTNAME + export PGPORT=${PGPORT:-19200} + exec psql "$@" + + %apphelp psql + Run psql-client in image + + PostgreSQL instance needs to be started beforehand + + Usage: + + export PGUSER=postgres_user + export PGPASSWORD=postgres_password + apptainer run --app psql instance://postgres_server -c 'create database test;' + apptainer run --app psql instance://postgres_server -c '\l' + +The definition file has couple of new blocks: + +- ``%startscript``: This block defines what commands will be run when we start up the service. +- ``%apprun``: This block allows us to specify individual applications in our image. In this + case we have an application called ``psql`` for the PostgreSQL client. This block specifies + how we run this specific application. +- ``%apphelp``: Each app in a container can have it's own help section as well as other + setup sections. See documentation for all possibilities. + +For more information on how to specify multiple apps in a container, see +`this documentation page `__. + +After building the image we can start the database with: + +.. code-block:: console + + $ mkdir postgres_data + $ mkdir postgres_run + $ export POSTGRES_USER=postgres_user + $ export POSTGRES_PASSWORD=postgres_password + $ apptainer instance start --bind postgres_data:/var/lib/postgresql/data --bind postgres_run:/var/run/postgresql postgres_container.sif postgres_server + + +.. figure:: img/instance_example.png + + Figure 1: Starting container as an instance + + +Now that we have started the instance we can check that the instance is running with: + +.. code-block:: console + + $ apptainer instance list + +Let's use the ``psql``-app that we have specified. We can use it to make a +connection to the server and to create a new database. Let's also list the +newly created database: + +.. code-block:: console + + $ export PGUSER=postgres_user + $ export PGPASSWORD=postgres_password + $ apptainer run --app psql instance://postgres_server -c 'create database test;' + $ apptainer run --app psql instance://postgres_server -c '\l' + +.. figure:: img/app_run_example.png + + Figure 2: Running an app from a container + + +You'll notice that we did not start a new container. Instead ran the application in +the running instance by specifying ``instance://postgres_server`` instead of the +``.sif``-image. You'll also note that we did not need to specify the bind-mounts +again: once the instance is started, bind mounts are made and they are there until +the instance is stopped. + +We can then shut down the server with: + +.. code-block:: console + + $ apptainer instance stop postgres_server + +.. admonition:: Key points to remember + + - You can start containers as instances. + - You can use ``%startscript``-block to specify how an instance should start. + - You can create multiple apps in a container with ``%app*``-blocks + - Started instances with bind mounts have them until instance is stopped. + This is very useful if you plan on running multiple commands against a + single container. diff --git a/branch/maikens_comments/_sources/storage.rst.txt b/branch/maikens_comments/_sources/storage.rst.txt new file mode 100644 index 0000000..d56574e --- /dev/null +++ b/branch/maikens_comments/_sources/storage.rst.txt @@ -0,0 +1,60 @@ +Persistent Storage +================== + +.. objectives:: + + * Understand the importance of persistent storage in containerized environments. + * Learn how to configure persistent storage for an Apptainer container to maintain data state between runs. + * Develop the ability to effectively manage data persistence, enhancing the usability and flexibility of container deployments in HPC settings. + + This demo explains how to set up and use persistent storage with Apptainer containers. Persistent storage is crucial for applications that need to maintain data or state between runs, such as databases or applications that generate ongoing logs or results. This capability is essential for ensuring data is not lost when a container is stopped or restarted, which is especially important in research environments where data integrity and continuity are paramount. + +.. prerequisites:: + + * Access to an HPC system with Apptainer installed. + * Basic knowledge of filesystems and permissions on Linux. + +Container technology typically encapsulates application environments and dependencies, but by default, any changes made inside the container can be lost when the container is stopped or destroyed. To prevent this, Apptainer allows you to bind host directories to the container, enabling the container to read from and write to persistent storage on the host system. + +First, we will demonstrate creating a simple application that writes data to a file inside a container, then show how this data can be preserved using a host directory bound to the container. + +.. code-block:: bash + + # Create a directory on the host to serve as persistent storage + mkdir -p /home/user/persistent_data + + # Example Apptainer definition file to use persistent storage + Bootstrap: library + From: ubuntu:20.04 + + %post + apt-get update && apt-get install -y nano + echo "Hello from Apptainer!" > /data/hello.txt + + %runscript + echo "Modifying the data file..." + echo "Another line added to the file." >> /data/hello.txt + cat /data/hello.txt + + + +.. code-block:: bash + + # Build the container that interacts with persistent data + apptainer build data_container.sif data.def + + +This block builds the ``data_container.sif`` from the ``data.def`` file, which includes a simple script to modify and display a data file stored in ``/data``. + +.. code-block:: bash + + # Run the container with the persistent storage directory bound + apptainer run --bind /home/user/persistent_data:/data data_container.sif + + +This command mounts the ``/home/user/persistent_data`` directory from the host to the ``/data`` directory inside the container. This setup allows the container to read from and write to the persistent storage, ensuring that changes to the data file are maintained even after the container is stopped. + +Summary +------- +In this tutorial, you've learned how to configure and use persistent storage with an Apptainer container. This practice is critical for applications that require data continuity, ensuring that valuable research data is not lost across container runs. By leveraging persistent storage, you can enhance the robustness and reliability of your containerized applications within the HPC environment. + diff --git a/branch/maikens_comments/_sources/template.rst.txt b/branch/maikens_comments/_sources/template.rst.txt new file mode 100644 index 0000000..0f158f2 --- /dev/null +++ b/branch/maikens_comments/_sources/template.rst.txt @@ -0,0 +1,47 @@ +Lesson name +=========== + +.. objectives:: + + * High-level point 1 + * High-level point 2 + * High-level point 3 + + Description of how the lesson goes: How is it divided between + discussion, demo, type-along, and exercise? How might different + people experience this differently? + +.. prerequisites:: + + * Prerequisite 1 + * Prerequisite 2 (possibly including link to how to learn) + + What happens if you don't have the prerequisites: is doing the + lesson as a demo OK? Is there no time to set up now? Can you do + the type-alongs? + +First sentence that summarizes the lesson, suitable for preview text. +A first paragraph really motivating why you would need the material +presented on this page, and why it is exciting. Don’t go into details. + +Then, another paragraph going into the big picture of what you will do +and how you will do it. Not details, but enough so that someone knows +the overall path. + + + +Section +------- + + + +Summary +------- + + + +See also +-------- + +* Link +* Link diff --git a/branch/maikens_comments/_sources/time_travel.rst.txt b/branch/maikens_comments/_sources/time_travel.rst.txt new file mode 100644 index 0000000..f330bbc --- /dev/null +++ b/branch/maikens_comments/_sources/time_travel.rst.txt @@ -0,0 +1,62 @@ +Time Travelling with Containers +=============================== + +.. objectives:: + + * Understand the benefits of using containers to access and run legacy software versions. + * Learn how to install an older version of R and RStudio within an Apptainer container for interactive use. + * Develop the ability to manage software versions effectively in a containerized environment, ensuring compatibility and reproducibility. + + This demo illustrates how to "time travel" by using containers to install and run older versions of software that are no longer supported or compatible with current operating systems. This is particularly useful in scientific research, where reproducing results from past studies often requires software versions that were used originally. + +.. prerequisites:: + + * Access to an HPC system with Apptainer installed. + * Basic familiarity with the R programming language and Linux command line operations. + +The ability to work with specific software versions is crucial for ensuring that scientific findings are reproducible. Containers encapsulate software in an environment that includes everything needed to run it, thus preserving functionality even when host systems evolve. + +First, we'll create a container that includes R 3.2 and RStudio Server 0.99, which are older versions no longer typically supported on modern systems. + + +.. code-block:: bash + + # Example Apptainer definition file for R 3.2 and RStudio 0.99 + Bootstrap: library + From: ubuntu:16.04 + + %post + apt-get update && apt-get install -y sudo gdebi-core + wget https://download2.rstudio.org/server/trusty/amd64/rstudio-server-0.99.903-amd64.deb + gdebi --non-interactive rstudio-server-0.99.903-amd64.deb + apt-get install -y r-base=3.2.* + echo 'options(repos = list(CRAN = "http://cran.rstudio.com"))' >> /etc/R/Rprofile.site + + %runscript + echo "Starting RStudio Server..." + /usr/lib/rstudio-server/bin/rserver --server-daemonize=0 + + + + +.. code-block:: bash + + # Build the container with old R and RStudio + apptainer build rstudio_container.sif rstudio.def + + + +This block constructs the ``rstudio_container.sif`` from the ``rstudio.def`` file, setting up an Ubuntu 16.04 environment with R 3.2 and RStudio Server 0.99. These versions ensure compatibility with older scripts and packages. + +.. code-block:: bash + + # Run the container, accessing RStudio Server + apptainer run -p rstudio_container.sif + + +This command starts the RStudio Server within the container. You can access RStudio interactively by connecting to the host's IP address at the specified port (default is 8787), where RStudio Server is configured to run. This setup allows users to interact with an older R environment as if it were installed directly on their machine. + +Summary +------- +In this tutorial, you've learned how to use Apptainer to create a containerized environment that supports running older versions of R and RStudio. This "time travelling" capability is essential for reproducing past scientific results and maintaining long-term accessibility to software tools, regardless of their age or compatibility with current systems. By mastering these techniques, researchers can ensure their work remains valid and reproducible for years to come. + diff --git a/branch/maikens_comments/_sources/tips_tricks.rst.txt b/branch/maikens_comments/_sources/tips_tricks.rst.txt new file mode 100644 index 0000000..0e4bef5 --- /dev/null +++ b/branch/maikens_comments/_sources/tips_tricks.rst.txt @@ -0,0 +1,79 @@ +Tips, tricks and frequently asked questions +=========================================== + + +Where should I install my software? +----------------------------------- + +Quite often in Docker images software is installed under ``root``-user's +home folder (``/root``). This is **the wrong approach**. Installing software +there with the assumption that the container will be run by ``root``-user +can cause permission headaches. + +Folders under ``/home`` are also bad as that is commonly mounted by Apptainer +and thus the bind mount hides software installed there. + +You should install manual installations of software to, for example, +``/opt`` or ``/usr/local``. See +`Filesystem Hierarchy Standard `__ +for explanation on how different folders are organized. + + +I have sensitive code that I would need to have in the container +---------------------------------------------------------------- + +Instead of installing your sensitive application to the image +you can instead mount the application directory inside the container. + +If your program requires compilations or installations, you can +install dependencies into the container image and then install software +in a bound folder or on a +`persistent overlay `__. + +If you still decide to put sensitive code in your image, +remember that it is visible to everyone who has access to the image. + + +I have an existing container, but I would want to do small modifications to the code +------------------------------------------------------------------------------------ + +If you want to do you're own modifications to the code +you can either use +`persistent overlays `__ +or you can use the following trick: + +1. Copy the code that you want to modify from the container to a folder outside + of the container: + + .. code-block:: console + + $ apptainer exec my_container.sif cp -r /path/to/code/src src + +2. Modify the code outside of the container +3. Bind mount modified code from outside of the container back into the container + + .. code-block:: console + + $ apptainer run --bind src:/path/to/code/src my_container.sif + + +My container starts to become huge +---------------------------------- + +Remember to clean up any unnecessary source code or software in your +``%post``-block. If your program does not need e.g. development headers +once it has been installed, you can remove them. + +You can also try +`multi-stage builds `__ +where one container is used to build a software, which is then copied +to another container that has only those packages required to run the software. + + +I would want to install my conda environment in a container +----------------------------------------------------------- + +See +`this repository `__ +for an example definition file that can be used to bootstrap +conda environment into a Apptainer container image. diff --git a/branch/maikens_comments/_sources/verify_installation.rst.txt b/branch/maikens_comments/_sources/verify_installation.rst.txt new file mode 100644 index 0000000..001ddfa --- /dev/null +++ b/branch/maikens_comments/_sources/verify_installation.rst.txt @@ -0,0 +1,55 @@ +Verify Apptainer Installation +============================= + +.. objectives:: + + * Understand the importance of verifying tool installation on HPC systems. + * Learn how to check the installation and version of Apptainer on an HPC cluster. + * Gain practical skills in verifying software prerequisites for scientific computing environments. + + This demo guides you through the process of verifying whether Apptainer is installed on your HPC cluster and checking its version. This is a critical first step in ensuring that the necessary tools are correctly configured before moving on to more complex containerization tasks. Knowing the version of Apptainer is essential as it may affect compatibility with container recipes or other tools used in your workflows. + +.. prerequisites:: + + * No prerequisites for following the demo + +The first step in utilizing containers on any high-performance computing (HPC) cluster involves ensuring that the container management software, in this case, Apptainer, is properly installed. This demo is crucial as it confirms the foundational tool's availability, which is necessary for all subsequent container-related operations. + +This demo will not only verify the presence of Apptainer on your system but will also teach you how to check its version. Knowing the installed version is important as it helps in troubleshooting and in ensuring compatibility with various container definitions and configurations used in scientific applications. + + +.. code-block:: bash + + # Check if Apptainer is installed and determine its version + apptainer --version + + +This command checks if Apptainer is installed and displays the version number. This information is useful for understanding which features and functionalities are available to you, as different versions may have different capabilities. + +Summary +------- +In this lesson, you learned how to verify the installation of Apptainer on your HPC cluster and how to check its version. This is a foundational skill that ensures you can proceed with confidence in using Apptainer for more advanced tasks in container management. + +.. exercise:: Configure Apptainer + + Explore the online Apptainer documentation and search for the bash environment variables that apptainer uses. + 1. Do you have any apptainer variables set in your shell environment? + 2. How do you set the variables for the CACHEDIR and TMPDIR so that they are pointing to a disk where you have enough free space? (e.g. your work folder) + + .. solution:: Solution + + 1. Apptainer uses the following environemnt variables: + 2. The following code creates subfolders in your work directory and makes sure that apptainer will use those folders to store temporary files + + + .. code-block:: bash + + mkdir $WRKDIR/apptainercache/ + mkdir $WRKDIR/apptainertemp/ + export APPTAINER_CACHEDIR="$WRKDIR/apptainercache/" + export APPTAINER_TMPDIR="$WRKDIR/apptainertemp/" + + + + + diff --git a/branch/maikens_comments/_sources/webapp.rst.txt b/branch/maikens_comments/_sources/webapp.rst.txt new file mode 100644 index 0000000..b97687f --- /dev/null +++ b/branch/maikens_comments/_sources/webapp.rst.txt @@ -0,0 +1,66 @@ +Running Web Applications +======================== + +.. objectives:: + + * Understand how to configure and run web applications within Apptainer containers. + * Learn to set up network settings that allow web applications to run effectively inside containers. + * Develop skills to leverage container technology for deploying networked applications in an HPC environment. + + This demo will show you how to deploy a simple web application inside an Apptainer container, highlighting how to configure network settings to support web services. Running web applications in containers is a common scenario in many fields, including data science and web development, as it allows for scalable, consistent environments that are isolated from the host system. + +.. prerequisites:: + + * Access to an HPC system with Apptainer installed. + * Basic knowledge of web technologies and network configurations. + * Familiarity with container networking and security settings. + +Containers provide a lightweight, efficient means of deploying web applications, ensuring that they run the same way on any system. This is particularly useful in HPC environments where maintaining consistency across numerous nodes is critical. In this demo, you will set up a basic Python web server inside an Apptainer container to explore this functionality. + +First, we'll create a container definition file that includes a Python web application. + +.. code-block:: bash + + # Example Apptainer definition file for a Python web server + Bootstrap: library + From: ubuntu:20.04 + + %post + apt-get update && apt-get install -y python3 python3-pip + pip3 install flask + mkdir /webapp + echo "from flask import Flask, request" > /webapp/app.py + echo "app = Flask(__name__)" >> /webapp/app.py + echo "@app.route('/', methods=['GET'])" >> /webapp/app.py + echo "def home():" >> /webapp/app.py + echo " return 'Hello from Flask inside Apptainer!'" >> /webapp/app.py + echo "if __name__ == '__main__':" >> /webapp/app.py + echo " app.run(host='0.0.0.0', port=5000)" >> /webapp/app.py + + %environment + export FLASK_APP=/webapp/app.py + + %runscript + echo "Starting the Flask web server..." + python3 /webapp/app.py + + + +.. code-block:: bash + # Build the container for the web application + apptainer build webapp_container.sif webapp.def + + +This block constructs the ``webapp_container.sif`` from the ``webapp.def`` definition file, which sets up a basic Flask application in the container. The Flask server is configured to listen on all network interfaces at port 5000, allowing external access. + +.. code-block:: bash + # Run the container with network port mapping + apptainer exec --net --network-args "portmap=5000:5000/tcp" webapp_container.sif + + +This command runs the container with network settings that map port 5000 inside the container to port 5000 on the host. This setup allows you to access the Flask web server from outside the container, demonstrating the container's network capabilities. + +Summary +------- +In this tutorial, you've learned how to set up and run a simple web application within an Apptainer container, configuring it to be accessible over a network. This capability is key for deploying scalable, reproducible web services across different computing environments, making it an essential skill for developers and system administrators working in HPC contexts. + diff --git a/branch/maikens_comments/_sources/workflow.rst.txt b/branch/maikens_comments/_sources/workflow.rst.txt new file mode 100644 index 0000000..423a44f --- /dev/null +++ b/branch/maikens_comments/_sources/workflow.rst.txt @@ -0,0 +1,65 @@ +Workflow Integration +==================== + +.. objectives:: + + * Understand the benefits of integrating container technology into HPC workflows. + * Learn to integrate an Apptainer container into an existing workflow on an HPC system. + * Develop the ability to streamline and standardize computational workflows using containers. + + This demo illustrates how to integrate Apptainer containers into an existing HPC workflow. Containers can encapsulate environments and dependencies, making workflows more reproducible and portable across different computational systems. This integration is particularly beneficial in HPC settings where consistency and scalability are critical. + +.. prerequisites:: + + * Access to an HPC system with Apptainer installed. + * An existing workflow or application that will be containerized. + * Basic knowledge of shell scripting and command line operations on Linux. + +Integrating containers into HPC workflows involves encapsulating the application and its dependencies into a container, which can then be executed consistently across various environments. This process not only simplifies the deployment and management of applications but also enhances their portability and reproducibility. + +Let’s start by creating an Apptainer definition file that encapsulates a typical scientific application, then proceed to integrate this container into a sample HPC workflow. + +.. code-block:: bash + + # Create a directory for the workflow + mkdir -p /home/user/hpc_workflow + + # Example Apptainer definition file for a scientific application + Bootstrap: library + From: ubuntu:20.04 + + %post + apt-get update && apt-get install -y python3 python3-pip + pip3 install numpy scipy matplotlib + + %environment + export PATH=/usr/local/bin:$PATH + + %runscript + echo "Running the scientific application..." + python3 -c "import numpy as np; import scipy; import matplotlib.pyplot as plt; x = np.linspace(0, 10, 100); y = np.sin(x); plt.plot(x, y); plt.savefig('/workflow/output/plot.png');" + + + +.. code-block:: bash + + # Build the container for the scientific application + apptainer build sci_app_container.sif sci_app.def + + +This block creates the ``sci_app_container.sif`` from the ``sci_app.def`` definition file. This container includes Python and popular scientific libraries, setting up an environment capable of running complex scientific computations. + +.. code-block:: bash + # Define a directory on the host for output + mkdir -p /home/user/hpc_workflow/output + + # Run the container as part of the HPC workflow + apptainer run --bind /home/user/hpc_workflow/output:/workflow/output sci_app_container.sif + + +This command runs the container and binds a directory from the host system (``/home/user/hpc_workflow/output``) to the container. This setup allows the container to output results directly to the host filesystem, integrating the containerized application's output with other components of the HPC workflow. + +Summary +------- +In this tutorial, you've learned how to integrate an Apptainer container into an existing HPC workflow. By containerizing applications, you standardize the execution environment, reducing inconsistencies and enhancing reproducibility across different computational platforms. This practice is essential for maintaining the integrity and reliability of complex scientific workflows in high-performance computing environments. + diff --git a/branch/maikens_comments/_static/_sphinx_javascript_frameworks_compat.js b/branch/maikens_comments/_static/_sphinx_javascript_frameworks_compat.js new file mode 100644 index 0000000..8549469 --- /dev/null +++ b/branch/maikens_comments/_static/_sphinx_javascript_frameworks_compat.js @@ -0,0 +1,134 @@ +/* + * _sphinx_javascript_frameworks_compat.js + * ~~~~~~~~~~ + * + * Compatability shim for jQuery and underscores.js. + * + * WILL BE REMOVED IN Sphinx 6.0 + * xref RemovedInSphinx60Warning + * + */ + +/** + * select a different prefix for underscore + */ +$u = _.noConflict(); + + +/** + * 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; +} diff --git a/branch/maikens_comments/_static/basic.css b/branch/maikens_comments/_static/basic.css new file mode 100644 index 0000000..4e9a9f1 --- /dev/null +++ b/branch/maikens_comments/_static/basic.css @@ -0,0 +1,900 @@ +/* + * basic.css + * ~~~~~~~~~ + * + * Sphinx stylesheet -- basic theme. + * + * :copyright: Copyright 2007-2022 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 p.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: 360px; + 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; +} + +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, .figure.align-left, object.align-left { + clear: left; + float: left; + margin-right: 1em; +} + +img.align-right, figure.align-right, .figure.align-right, object.align-right { + clear: right; + float: right; + margin-left: 1em; +} + +img.align-center, figure.align-center, .figure.align-center, object.align-center { + display: block; + margin-left: auto; + margin-right: auto; +} + +img.align-default, figure.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, +aside.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; +} +nav.contents, +aside.topic, +div.admonition, div.topic, blockquote { + clear: left; +} + +/* -- topics ---------------------------------------------------------------- */ +nav.contents, +aside.topic, +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, +aside.sidebar > :last-child, +nav.contents > :last-child, +aside.topic > :last-child, +div.topic > :last-child, +div.admonition > :last-child { + margin-bottom: 0; +} + +div.sidebar::after, +aside.sidebar::after, +nav.contents::after, +aside.topic::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; +} + +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, figure { + margin: 0.5em; + padding: 0.5em; +} + +div.figure p.caption, figcaption { + padding: 0.3em; +} + +div.figure p.caption span.caption-number, +figcaption span.caption-number { + font-style: italic; +} + +div.figure p.caption span.caption-text, +figcaption 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; +} + +/* -- object description styles --------------------------------------------- */ + +.sig { + font-family: 'Consolas', 'Menlo', 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', monospace; +} + +.sig-name, code.descname { + background-color: transparent; + font-weight: bold; +} + +.sig-name { + font-size: 1.1em; +} + +code.descname { + font-size: 1.2em; +} + +.sig-prename, code.descclassname { + background-color: transparent; +} + +.optional { + font-size: 1.3em; +} + +.sig-paren { + font-size: larger; +} + +.sig-param.n { + font-style: italic; +} + +/* C++ specific styling */ + +.sig-inline.c-texpr, +.sig-inline.cpp-texpr { + font-family: unset; +} + +.sig.c .k, .sig.c .kt, +.sig.cpp .k, .sig.cpp .kt { + color: #0033B3; +} + +.sig.c .m, +.sig.cpp .m { + color: #1750EB; +} + +.sig.c .s, .sig.c .sc, +.sig.cpp .s, .sig.cpp .sc { + color: #067D17; +} + + +/* -- 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; +} +aside.footnote > span, +div.citation > span { + float: left; +} +aside.footnote > span:last-of-type, +div.citation > span:last-of-type { + padding-right: 0.5em; +} +aside.footnote > p { + margin-left: 2em; +} +div.citation > p { + margin-left: 4em; +} +aside.footnote > p:last-of-type, +div.citation > p:last-of-type { + margin-bottom: 0em; +} +aside.footnote > p:last-of-type:after, +div.citation > p:last-of-type: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 > 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; +} + +.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 0.5em; + content: ":"; + display: inline-block; +} + +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; + white-space: nowrap; +} + +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.highlight span.gp { /* gp: Generic.Prompt */ + user-select: none; + -webkit-user-select: text; /* Safari fallback only */ + -webkit-user-select: none; /* Chrome/Safari */ + -moz-user-select: none; /* Firefox */ + -ms-user-select: none; /* IE10+ */ +} + +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.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/branch/maikens_comments/_static/check-solid.svg b/branch/maikens_comments/_static/check-solid.svg new file mode 100644 index 0000000..92fad4b --- /dev/null +++ b/branch/maikens_comments/_static/check-solid.svg @@ -0,0 +1,4 @@ + + + + diff --git a/branch/maikens_comments/_static/clipboard.min.js b/branch/maikens_comments/_static/clipboard.min.js new file mode 100644 index 0000000..54b3c46 --- /dev/null +++ b/branch/maikens_comments/_static/clipboard.min.js @@ -0,0 +1,7 @@ +/*! + * clipboard.js v2.0.8 + * https://clipboardjs.com/ + * + * Licensed MIT © Zeno Rocha + */ +!function(t,e){"object"==typeof exports&&"object"==typeof module?module.exports=e():"function"==typeof define&&define.amd?define([],e):"object"==typeof exports?exports.ClipboardJS=e():t.ClipboardJS=e()}(this,function(){return n={686:function(t,e,n){"use strict";n.d(e,{default:function(){return o}});var e=n(279),i=n.n(e),e=n(370),u=n.n(e),e=n(817),c=n.n(e);function a(t){try{return document.execCommand(t)}catch(t){return}}var f=function(t){t=c()(t);return a("cut"),t};var l=function(t){var e,n,o,r=1 + + + + diff --git a/branch/maikens_comments/_static/copybutton.css b/branch/maikens_comments/_static/copybutton.css new file mode 100644 index 0000000..f1916ec --- /dev/null +++ b/branch/maikens_comments/_static/copybutton.css @@ -0,0 +1,94 @@ +/* Copy buttons */ +button.copybtn { + position: absolute; + display: flex; + top: .3em; + right: .3em; + width: 1.7em; + height: 1.7em; + opacity: 0; + transition: opacity 0.3s, border .3s, background-color .3s; + user-select: none; + padding: 0; + border: none; + outline: none; + border-radius: 0.4em; + /* The colors that GitHub uses */ + border: #1b1f2426 1px solid; + background-color: #f6f8fa; + color: #57606a; +} + +button.copybtn.success { + border-color: #22863a; + color: #22863a; +} + +button.copybtn svg { + stroke: currentColor; + width: 1.5em; + height: 1.5em; + padding: 0.1em; +} + +div.highlight { + position: relative; +} + +/* Show the copybutton */ +.highlight:hover button.copybtn, button.copybtn.success { + opacity: 1; +} + +.highlight button.copybtn:hover { + background-color: rgb(235, 235, 235); +} + +.highlight button.copybtn:active { + background-color: rgb(187, 187, 187); +} + +/** + * A minimal CSS-only tooltip copied from: + * https://codepen.io/mildrenben/pen/rVBrpK + * + * To use, write HTML like the following: + * + *

Short

+ */ + .o-tooltip--left { + position: relative; + } + + .o-tooltip--left:after { + opacity: 0; + visibility: hidden; + position: absolute; + content: attr(data-tooltip); + padding: .2em; + font-size: .8em; + left: -.2em; + background: grey; + color: white; + white-space: nowrap; + z-index: 2; + border-radius: 2px; + transform: translateX(-102%) translateY(0); + transition: opacity 0.2s cubic-bezier(0.64, 0.09, 0.08, 1), transform 0.2s cubic-bezier(0.64, 0.09, 0.08, 1); +} + +.o-tooltip--left:hover:after { + display: block; + opacity: 1; + visibility: visible; + transform: translateX(-100%) translateY(0); + transition: opacity 0.2s cubic-bezier(0.64, 0.09, 0.08, 1), transform 0.2s cubic-bezier(0.64, 0.09, 0.08, 1); + transition-delay: .5s; +} + +/* By default the copy button shouldn't show up when printing a page */ +@media print { + button.copybtn { + display: none; + } +} diff --git a/branch/maikens_comments/_static/copybutton.js b/branch/maikens_comments/_static/copybutton.js new file mode 100644 index 0000000..2ea7ff3 --- /dev/null +++ b/branch/maikens_comments/_static/copybutton.js @@ -0,0 +1,248 @@ +// Localization support +const messages = { + 'en': { + 'copy': 'Copy', + 'copy_to_clipboard': 'Copy to clipboard', + 'copy_success': 'Copied!', + 'copy_failure': 'Failed to copy', + }, + 'es' : { + 'copy': 'Copiar', + 'copy_to_clipboard': 'Copiar al portapapeles', + 'copy_success': '¡Copiado!', + 'copy_failure': 'Error al copiar', + }, + 'de' : { + 'copy': 'Kopieren', + 'copy_to_clipboard': 'In die Zwischenablage kopieren', + 'copy_success': 'Kopiert!', + 'copy_failure': 'Fehler beim Kopieren', + }, + 'fr' : { + 'copy': 'Copier', + 'copy_to_clipboard': 'Copier dans le presse-papier', + 'copy_success': 'Copié !', + 'copy_failure': 'Échec de la copie', + }, + 'ru': { + 'copy': 'Скопировать', + 'copy_to_clipboard': 'Скопировать в буфер', + 'copy_success': 'Скопировано!', + 'copy_failure': 'Не удалось скопировать', + }, + 'zh-CN': { + 'copy': '复制', + 'copy_to_clipboard': '复制到剪贴板', + 'copy_success': '复制成功!', + 'copy_failure': '复制失败', + }, + 'it' : { + 'copy': 'Copiare', + 'copy_to_clipboard': 'Copiato negli appunti', + 'copy_success': 'Copiato!', + 'copy_failure': 'Errore durante la copia', + } +} + +let locale = 'en' +if( document.documentElement.lang !== undefined + && messages[document.documentElement.lang] !== undefined ) { + locale = document.documentElement.lang +} + +let doc_url_root = DOCUMENTATION_OPTIONS.URL_ROOT; +if (doc_url_root == '#') { + doc_url_root = ''; +} + +/** + * SVG files for our copy buttons + */ +let iconCheck = ` + ${messages[locale]['copy_success']} + + +` + +// If the user specified their own SVG use that, otherwise use the default +let iconCopy = ``; +if (!iconCopy) { + iconCopy = ` + ${messages[locale]['copy_to_clipboard']} + + + +` +} + +/** + * Set up copy/paste for code blocks + */ + +const runWhenDOMLoaded = cb => { + if (document.readyState != 'loading') { + cb() + } else if (document.addEventListener) { + document.addEventListener('DOMContentLoaded', cb) + } else { + document.attachEvent('onreadystatechange', function() { + if (document.readyState == 'complete') cb() + }) + } +} + +const codeCellId = index => `codecell${index}` + +// Clears selected text since ClipboardJS will select the text when copying +const clearSelection = () => { + if (window.getSelection) { + window.getSelection().removeAllRanges() + } else if (document.selection) { + document.selection.empty() + } +} + +// Changes tooltip text for a moment, then changes it back +// We want the timeout of our `success` class to be a bit shorter than the +// tooltip and icon change, so that we can hide the icon before changing back. +var timeoutIcon = 2000; +var timeoutSuccessClass = 1500; + +const temporarilyChangeTooltip = (el, oldText, newText) => { + el.setAttribute('data-tooltip', newText) + el.classList.add('success') + // Remove success a little bit sooner than we change the tooltip + // So that we can use CSS to hide the copybutton first + setTimeout(() => el.classList.remove('success'), timeoutSuccessClass) + setTimeout(() => el.setAttribute('data-tooltip', oldText), timeoutIcon) +} + +// Changes the copy button icon for two seconds, then changes it back +const temporarilyChangeIcon = (el) => { + el.innerHTML = iconCheck; + setTimeout(() => {el.innerHTML = iconCopy}, timeoutIcon) +} + +const addCopyButtonToCodeCells = () => { + // If ClipboardJS hasn't loaded, wait a bit and try again. This + // happens because we load ClipboardJS asynchronously. + if (window.ClipboardJS === undefined) { + setTimeout(addCopyButtonToCodeCells, 250) + return + } + + // Add copybuttons to all of our code cells + const COPYBUTTON_SELECTOR = 'div.highlight pre'; + const codeCells = document.querySelectorAll(COPYBUTTON_SELECTOR) + codeCells.forEach((codeCell, index) => { + const id = codeCellId(index) + codeCell.setAttribute('id', id) + + const clipboardButton = id => + `` + codeCell.insertAdjacentHTML('afterend', clipboardButton(id)) + }) + +function escapeRegExp(string) { + return string.replace(/[.*+?^${}()|[\]\\]/g, '\\$&'); // $& means the whole matched string +} + +/** + * Removes excluded text from a Node. + * + * @param {Node} target Node to filter. + * @param {string} exclude CSS selector of nodes to exclude. + * @returns {DOMString} Text from `target` with text removed. + */ +function filterText(target, exclude) { + const clone = target.cloneNode(true); // clone as to not modify the live DOM + if (exclude) { + // remove excluded nodes + clone.querySelectorAll(exclude).forEach(node => node.remove()); + } + return clone.innerText; +} + +// Callback when a copy button is clicked. Will be passed the node that was clicked +// should then grab the text and replace pieces of text that shouldn't be used in output +function formatCopyText(textContent, copybuttonPromptText, isRegexp = false, onlyCopyPromptLines = true, removePrompts = true, copyEmptyLines = true, lineContinuationChar = "", hereDocDelim = "") { + var regexp; + var match; + + // Do we check for line continuation characters and "HERE-documents"? + var useLineCont = !!lineContinuationChar + var useHereDoc = !!hereDocDelim + + // create regexp to capture prompt and remaining line + if (isRegexp) { + regexp = new RegExp('^(' + copybuttonPromptText + ')(.*)') + } else { + regexp = new RegExp('^(' + escapeRegExp(copybuttonPromptText) + ')(.*)') + } + + const outputLines = []; + var promptFound = false; + var gotLineCont = false; + var gotHereDoc = false; + const lineGotPrompt = []; + for (const line of textContent.split('\n')) { + match = line.match(regexp) + if (match || gotLineCont || gotHereDoc) { + promptFound = regexp.test(line) + lineGotPrompt.push(promptFound) + if (removePrompts && promptFound) { + outputLines.push(match[2]) + } else { + outputLines.push(line) + } + gotLineCont = line.endsWith(lineContinuationChar) & useLineCont + if (line.includes(hereDocDelim) & useHereDoc) + gotHereDoc = !gotHereDoc + } else if (!onlyCopyPromptLines) { + outputLines.push(line) + } else if (copyEmptyLines && line.trim() === '') { + outputLines.push(line) + } + } + + // If no lines with the prompt were found then just use original lines + if (lineGotPrompt.some(v => v === true)) { + textContent = outputLines.join('\n'); + } + + // Remove a trailing newline to avoid auto-running when pasting + if (textContent.endsWith("\n")) { + textContent = textContent.slice(0, -1) + } + return textContent +} + + +var copyTargetText = (trigger) => { + var target = document.querySelector(trigger.attributes['data-clipboard-target'].value); + + // get filtered text + let exclude = '.linenos'; + + let text = filterText(target, exclude); + return formatCopyText(text, '', false, true, true, true, '', '') +} + + // Initialize with a callback so we can modify the text before copy + const clipboard = new ClipboardJS('.copybtn', {text: copyTargetText}) + + // Update UI with error/success messages + clipboard.on('success', event => { + clearSelection() + temporarilyChangeTooltip(event.trigger, messages[locale]['copy'], messages[locale]['copy_success']) + temporarilyChangeIcon(event.trigger) + }) + + clipboard.on('error', event => { + temporarilyChangeTooltip(event.trigger, messages[locale]['copy'], messages[locale]['copy_failure']) + }) +} + +runWhenDOMLoaded(addCopyButtonToCodeCells) \ No newline at end of file diff --git a/branch/maikens_comments/_static/copybutton_funcs.js b/branch/maikens_comments/_static/copybutton_funcs.js new file mode 100644 index 0000000..dbe1aaa --- /dev/null +++ b/branch/maikens_comments/_static/copybutton_funcs.js @@ -0,0 +1,73 @@ +function escapeRegExp(string) { + return string.replace(/[.*+?^${}()|[\]\\]/g, '\\$&'); // $& means the whole matched string +} + +/** + * Removes excluded text from a Node. + * + * @param {Node} target Node to filter. + * @param {string} exclude CSS selector of nodes to exclude. + * @returns {DOMString} Text from `target` with text removed. + */ +export function filterText(target, exclude) { + const clone = target.cloneNode(true); // clone as to not modify the live DOM + if (exclude) { + // remove excluded nodes + clone.querySelectorAll(exclude).forEach(node => node.remove()); + } + return clone.innerText; +} + +// Callback when a copy button is clicked. Will be passed the node that was clicked +// should then grab the text and replace pieces of text that shouldn't be used in output +export function formatCopyText(textContent, copybuttonPromptText, isRegexp = false, onlyCopyPromptLines = true, removePrompts = true, copyEmptyLines = true, lineContinuationChar = "", hereDocDelim = "") { + var regexp; + var match; + + // Do we check for line continuation characters and "HERE-documents"? + var useLineCont = !!lineContinuationChar + var useHereDoc = !!hereDocDelim + + // create regexp to capture prompt and remaining line + if (isRegexp) { + regexp = new RegExp('^(' + copybuttonPromptText + ')(.*)') + } else { + regexp = new RegExp('^(' + escapeRegExp(copybuttonPromptText) + ')(.*)') + } + + const outputLines = []; + var promptFound = false; + var gotLineCont = false; + var gotHereDoc = false; + const lineGotPrompt = []; + for (const line of textContent.split('\n')) { + match = line.match(regexp) + if (match || gotLineCont || gotHereDoc) { + promptFound = regexp.test(line) + lineGotPrompt.push(promptFound) + if (removePrompts && promptFound) { + outputLines.push(match[2]) + } else { + outputLines.push(line) + } + gotLineCont = line.endsWith(lineContinuationChar) & useLineCont + if (line.includes(hereDocDelim) & useHereDoc) + gotHereDoc = !gotHereDoc + } else if (!onlyCopyPromptLines) { + outputLines.push(line) + } else if (copyEmptyLines && line.trim() === '') { + outputLines.push(line) + } + } + + // If no lines with the prompt were found then just use original lines + if (lineGotPrompt.some(v => v === true)) { + textContent = outputLines.join('\n'); + } + + // Remove a trailing newline to avoid auto-running when pasting + if (textContent.endsWith("\n")) { + textContent = textContent.slice(0, -1) + } + return textContent +} diff --git a/branch/maikens_comments/_static/css/badge_only.css b/branch/maikens_comments/_static/css/badge_only.css new file mode 100644 index 0000000..c718cee --- /dev/null +++ b/branch/maikens_comments/_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/branch/maikens_comments/_static/css/fonts/Roboto-Slab-Bold.woff b/branch/maikens_comments/_static/css/fonts/Roboto-Slab-Bold.woff new file mode 100644 index 0000000..6cb6000 Binary files /dev/null and b/branch/maikens_comments/_static/css/fonts/Roboto-Slab-Bold.woff differ diff --git a/branch/maikens_comments/_static/css/fonts/Roboto-Slab-Bold.woff2 b/branch/maikens_comments/_static/css/fonts/Roboto-Slab-Bold.woff2 new file mode 100644 index 0000000..7059e23 Binary files /dev/null and b/branch/maikens_comments/_static/css/fonts/Roboto-Slab-Bold.woff2 differ diff --git a/branch/maikens_comments/_static/css/fonts/Roboto-Slab-Regular.woff b/branch/maikens_comments/_static/css/fonts/Roboto-Slab-Regular.woff new file mode 100644 index 0000000..f815f63 Binary files /dev/null and b/branch/maikens_comments/_static/css/fonts/Roboto-Slab-Regular.woff differ diff --git a/branch/maikens_comments/_static/css/fonts/Roboto-Slab-Regular.woff2 b/branch/maikens_comments/_static/css/fonts/Roboto-Slab-Regular.woff2 new file mode 100644 index 0000000..f2c76e5 Binary files /dev/null and b/branch/maikens_comments/_static/css/fonts/Roboto-Slab-Regular.woff2 differ diff --git a/branch/maikens_comments/_static/css/fonts/fontawesome-webfont.eot b/branch/maikens_comments/_static/css/fonts/fontawesome-webfont.eot new file mode 100644 index 0000000..e9f60ca Binary files /dev/null and b/branch/maikens_comments/_static/css/fonts/fontawesome-webfont.eot differ diff --git a/branch/maikens_comments/_static/css/fonts/fontawesome-webfont.svg b/branch/maikens_comments/_static/css/fonts/fontawesome-webfont.svg new file mode 100644 index 0000000..855c845 --- /dev/null +++ b/branch/maikens_comments/_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/branch/maikens_comments/_static/css/fonts/fontawesome-webfont.ttf b/branch/maikens_comments/_static/css/fonts/fontawesome-webfont.ttf new file mode 100644 index 0000000..35acda2 Binary files /dev/null and b/branch/maikens_comments/_static/css/fonts/fontawesome-webfont.ttf differ diff --git a/branch/maikens_comments/_static/css/fonts/fontawesome-webfont.woff b/branch/maikens_comments/_static/css/fonts/fontawesome-webfont.woff new file mode 100644 index 0000000..400014a Binary files /dev/null and b/branch/maikens_comments/_static/css/fonts/fontawesome-webfont.woff differ diff --git a/branch/maikens_comments/_static/css/fonts/fontawesome-webfont.woff2 b/branch/maikens_comments/_static/css/fonts/fontawesome-webfont.woff2 new file mode 100644 index 0000000..4d13fc6 Binary files /dev/null and b/branch/maikens_comments/_static/css/fonts/fontawesome-webfont.woff2 differ diff --git a/branch/maikens_comments/_static/css/fonts/lato-bold-italic.woff b/branch/maikens_comments/_static/css/fonts/lato-bold-italic.woff new file mode 100644 index 0000000..88ad05b Binary files /dev/null and b/branch/maikens_comments/_static/css/fonts/lato-bold-italic.woff differ diff --git a/branch/maikens_comments/_static/css/fonts/lato-bold-italic.woff2 b/branch/maikens_comments/_static/css/fonts/lato-bold-italic.woff2 new file mode 100644 index 0000000..c4e3d80 Binary files /dev/null and b/branch/maikens_comments/_static/css/fonts/lato-bold-italic.woff2 differ diff --git a/branch/maikens_comments/_static/css/fonts/lato-bold.woff b/branch/maikens_comments/_static/css/fonts/lato-bold.woff new file mode 100644 index 0000000..c6dff51 Binary files /dev/null and b/branch/maikens_comments/_static/css/fonts/lato-bold.woff differ diff --git a/branch/maikens_comments/_static/css/fonts/lato-bold.woff2 b/branch/maikens_comments/_static/css/fonts/lato-bold.woff2 new file mode 100644 index 0000000..bb19504 Binary files /dev/null and b/branch/maikens_comments/_static/css/fonts/lato-bold.woff2 differ diff --git a/branch/maikens_comments/_static/css/fonts/lato-normal-italic.woff b/branch/maikens_comments/_static/css/fonts/lato-normal-italic.woff new file mode 100644 index 0000000..76114bc Binary files /dev/null and b/branch/maikens_comments/_static/css/fonts/lato-normal-italic.woff differ diff --git a/branch/maikens_comments/_static/css/fonts/lato-normal-italic.woff2 b/branch/maikens_comments/_static/css/fonts/lato-normal-italic.woff2 new file mode 100644 index 0000000..3404f37 Binary files /dev/null and b/branch/maikens_comments/_static/css/fonts/lato-normal-italic.woff2 differ diff --git a/branch/maikens_comments/_static/css/fonts/lato-normal.woff b/branch/maikens_comments/_static/css/fonts/lato-normal.woff new file mode 100644 index 0000000..ae1307f Binary files /dev/null and b/branch/maikens_comments/_static/css/fonts/lato-normal.woff differ diff --git a/branch/maikens_comments/_static/css/fonts/lato-normal.woff2 b/branch/maikens_comments/_static/css/fonts/lato-normal.woff2 new file mode 100644 index 0000000..3bf9843 Binary files /dev/null and b/branch/maikens_comments/_static/css/fonts/lato-normal.woff2 differ diff --git a/branch/maikens_comments/_static/css/theme.css b/branch/maikens_comments/_static/css/theme.css new file mode 100644 index 0000000..19a446a --- /dev/null +++ b/branch/maikens_comments/_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/branch/maikens_comments/_static/doctools.js b/branch/maikens_comments/_static/doctools.js new file mode 100644 index 0000000..527b876 --- /dev/null +++ b/branch/maikens_comments/_static/doctools.js @@ -0,0 +1,156 @@ +/* + * doctools.js + * ~~~~~~~~~~~ + * + * Base JavaScript utilities for all Sphinx HTML documentation. + * + * :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ +"use strict"; + +const BLACKLISTED_KEY_CONTROL_ELEMENTS = new Set([ + "TEXTAREA", + "INPUT", + "SELECT", + "BUTTON", +]); + +const _ready = (callback) => { + if (document.readyState !== "loading") { + callback(); + } else { + document.addEventListener("DOMContentLoaded", callback); + } +}; + +/** + * Small JavaScript module for the documentation. + */ +const Documentation = { + init: () => { + Documentation.initDomainIndexTable(); + Documentation.initOnKeyListeners(); + }, + + /** + * i18n support + */ + TRANSLATIONS: {}, + PLURAL_EXPR: (n) => (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: (string) => { + const translated = Documentation.TRANSLATIONS[string]; + switch (typeof translated) { + case "undefined": + return string; // no translation + case "string": + return translated; // translation exists + default: + return translated[0]; // (singular, plural) translation tuple exists + } + }, + + ngettext: (singular, plural, n) => { + const translated = Documentation.TRANSLATIONS[singular]; + if (typeof translated !== "undefined") + return translated[Documentation.PLURAL_EXPR(n)]; + return n === 1 ? singular : plural; + }, + + addTranslations: (catalog) => { + Object.assign(Documentation.TRANSLATIONS, catalog.messages); + Documentation.PLURAL_EXPR = new Function( + "n", + `return (${catalog.plural_expr})` + ); + Documentation.LOCALE = catalog.locale; + }, + + /** + * helper function to focus on search bar + */ + focusSearchBar: () => { + document.querySelectorAll("input[name=q]")[0]?.focus(); + }, + + /** + * Initialise the domain index toggle buttons + */ + initDomainIndexTable: () => { + const toggler = (el) => { + const idNumber = el.id.substr(7); + const toggledRows = document.querySelectorAll(`tr.cg-${idNumber}`); + if (el.src.substr(-9) === "minus.png") { + el.src = `${el.src.substr(0, el.src.length - 9)}plus.png`; + toggledRows.forEach((el) => (el.style.display = "none")); + } else { + el.src = `${el.src.substr(0, el.src.length - 8)}minus.png`; + toggledRows.forEach((el) => (el.style.display = "")); + } + }; + + const togglerElements = document.querySelectorAll("img.toggler"); + togglerElements.forEach((el) => + el.addEventListener("click", (event) => toggler(event.currentTarget)) + ); + togglerElements.forEach((el) => (el.style.display = "")); + if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) togglerElements.forEach(toggler); + }, + + initOnKeyListeners: () => { + // only install a listener if it is really needed + if ( + !DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS && + !DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS + ) + return; + + document.addEventListener("keydown", (event) => { + // bail for input elements + if (BLACKLISTED_KEY_CONTROL_ELEMENTS.has(document.activeElement.tagName)) return; + // bail with special keys + if (event.altKey || event.ctrlKey || event.metaKey) return; + + if (!event.shiftKey) { + switch (event.key) { + case "ArrowLeft": + if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) break; + + const prevLink = document.querySelector('link[rel="prev"]'); + if (prevLink && prevLink.href) { + window.location.href = prevLink.href; + event.preventDefault(); + } + break; + case "ArrowRight": + if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) break; + + const nextLink = document.querySelector('link[rel="next"]'); + if (nextLink && nextLink.href) { + window.location.href = nextLink.href; + event.preventDefault(); + } + break; + } + } + + // some keyboard layouts may need Shift to get / + switch (event.key) { + case "/": + if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS) break; + Documentation.focusSearchBar(); + event.preventDefault(); + } + }); + }, +}; + +// quick alias for translations +const _ = Documentation.gettext; + +_ready(Documentation.init); diff --git a/branch/maikens_comments/_static/documentation_options.js b/branch/maikens_comments/_static/documentation_options.js new file mode 100644 index 0000000..c066c69 --- /dev/null +++ b/branch/maikens_comments/_static/documentation_options.js @@ -0,0 +1,14 @@ +var DOCUMENTATION_OPTIONS = { + URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'), + VERSION: '', + LANGUAGE: 'en', + COLLAPSE_INDEX: false, + BUILDER: 'dirhtml', + FILE_SUFFIX: '.html', + LINK_SUFFIX: '.html', + HAS_SOURCE: true, + SOURCELINK_SUFFIX: '.txt', + NAVIGATION_WITH_KEYS: false, + SHOW_SEARCH_SUMMARY: true, + ENABLE_SEARCH_SHORTCUTS: true, +}; \ No newline at end of file diff --git a/branch/maikens_comments/_static/file.png b/branch/maikens_comments/_static/file.png new file mode 100644 index 0000000..a858a41 Binary files /dev/null and b/branch/maikens_comments/_static/file.png differ diff --git a/branch/maikens_comments/_static/jquery-3.6.0.js b/branch/maikens_comments/_static/jquery-3.6.0.js new file mode 100644 index 0000000..fc6c299 --- /dev/null +++ b/branch/maikens_comments/_static/jquery-3.6.0.js @@ -0,0 +1,10881 @@ +/*! + * jQuery JavaScript Library v3.6.0 + * https://jquery.com/ + * + * Includes Sizzle.js + * https://sizzlejs.com/ + * + * Copyright OpenJS Foundation and other contributors + * Released under the MIT license + * https://jquery.org/license + * + * Date: 2021-03-02T17:08Z + */ +( 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. + // Support: QtWeb <=3.8.5, WebKit <=534.34, wkhtmltopdf tool <=0.12.5 + // Plus for old WebKit, typeof returns "function" for HTML collections + // (e.g., `typeof document.getElementsByTagName("div") === "function"`). (gh-4756) + return typeof obj === "function" && typeof obj.nodeType !== "number" && + typeof obj.item !== "function"; + }; + + +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.6.0", + + // 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.6 + * https://sizzlejs.com/ + * + * Copyright JS Foundation and other contributors + * Released under the MIT license + * https://js.foundation/ + * + * Date: 2021-02-16 + */ +( 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 && elem.namespaceURI, + docElem = elem && ( 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 primary Deferred + primary = 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 ) ) { + primary.resolveWith( resolveContexts, resolveValues ); + } + }; + }; + + // Single- and empty arguments are adopted like Promise.resolve + if ( remaining <= 1 ) { + adoptValue( singleValue, primary.done( updateFunc( i ) ).resolve, primary.reject, + !remaining ); + + // Use .then() to unwrap secondary thenables (cf. gh-3000) + if ( primary.state() === "pending" || + isFunction( resolveValues[ i ] && resolveValues[ i ].then ) ) { + + return primary.then(); + } + } + + // Multiple arguments are aggregated like Promise.all array elements + while ( i-- ) { + adoptValue( resolveValues[ i ], updateFunc( i ), primary.reject ); + } + + return primary.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 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(); + + // Support: Chrome 86+ + // In Chrome, if an element having a focusout handler is blurred by + // clicking outside of it, it invokes the handler synchronously. If + // that handler calls `.remove()` on the element, the data is cleared, + // leaving `result` undefined. We need to guard against this. + return result && 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: true +}, 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; + }, + + // Suppress native focus or blur as it's already being fired + // in leverageNative. + _default: function() { + 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! + // + // Support: Firefox 70+ + // Only Firefox includes border widths + // in computed dimensions. (gh-4529) + 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;border-collapse:separate"; + tr.style.cssText = "border:1px solid"; + + // Support: Chrome 86+ + // Height set through cssText does not get applied. + // Computed height then comes back as 0. + tr.style.height = "1px"; + trChild.style.height = "9px"; + + // Support: Android 8 Chrome 86+ + // In our bodyBackground.html iframe, + // display for all div elements is set to "inline", + // which causes a problem only in Android 8 Chrome 86. + // Ensuring the div is display: block + // gets around this issue. + trChild.style.display = "block"; + + documentElement + .appendChild( table ) + .appendChild( tr ) + .appendChild( trChild ); + + trStyle = window.getComputedStyle( tr ); + reliableTrDimensionsVal = ( parseInt( trStyle.height, 10 ) + + parseInt( trStyle.borderTopWidth, 10 ) + + parseInt( trStyle.borderBottomWidth, 10 ) ) === tr.offsetHeight; + + 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, parserErrorElem; + 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 ) {} + + parserErrorElem = xml && xml.getElementsByTagName( "parsererror" )[ 0 ]; + if ( !xml || parserErrorElem ) { + jQuery.error( "Invalid XML: " + ( + parserErrorElem ? + jQuery.map( parserErrorElem.childNodes, function( el ) { + return el.textContent; + } ).join( "\n" ) : + 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 but not if jsonp + if ( !isSuccess && + jQuery.inArray( "script", s.dataTypes ) > -1 && + jQuery.inArray( "json", s.dataTypes ) < 0 ) { + 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( " + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Advanced Container Recipes

+
+

Objectives

+
    +

  • Understand the complexities of building advanced scientific software stacks within containers.

    • +

  • Learn to construct detailed Apptainer definition files that encapsulate comprehensive scientific environments.

    • +

  • Develop proficiency in crafting container recipes that ensure reproducibility and consistency across different HPC systems.

    • +
+

This demo will walk you through the process of creating advanced container recipes using Apptainer, aimed at constructing robust scientific software environments. These environments often require multiple, intricately linked software tools and libraries that must be correctly configured to work together seamlessly.

+
+
+

Prerequisites

+
    +

  • Access to an HPC system with Apptainer installed.

    • +

  • Basic to intermediate knowledge of Linux, shell scripting, and scientific software installation.

    • +

  • Understanding of dependency management and environment configuration for scientific computing.

    • +
+
+

Building a scientific software stack in a container can be challenging due to dependencies and the need for specific configurations. By using advanced container recipes, researchers can encapsulate these environments, making them portable and reproducible. This is particularly important in scientific research, where precise control over software versions and settings is crucial for validating experimental results.

+

First, we’ll outline a container recipe that includes a typical setup for a bioinformatics analysis environment, featuring tools like BLAST, Python, and R.

+
# Example Apptainer definition file for a bioinformatics stack
+Bootstrap: library
+From: ubuntu:20.04
+
+%post
+    apt-get update && apt-get install -y wget build-essential python3 python3-pip r-base
+    pip3 install numpy scipy pandas biopython
+    wget ftp://ftp.ncbi.nlm.nih.gov/blast/executables/blast+/LATEST/ncbi-blast-2.10.1+-x64-linux.tar.gz
+    tar -xzf ncbi-blast-2.10.1+-x64-linux.tar.gz -C /usr/local/bin --strip-components=1
+    echo 'export PATH=/usr/local/bin:$PATH' >> ~/.bashrc
+
+%environment
+    export PATH=/usr/local/bin:$PATH
+
+%runscript
+    echo "Environment for bioinformatics analysis ready. Tools available: BLAST, Python, R."
+    exec /bin/bash
+
+
+
# Build the container for the bioinformatics stack
+apptainer build bioinfo_container.sif bioinfo.def
+
+
+

This block constructs the bioinfo_container.sif from the bioinfo.def file. It installs critical tools for bioinformatics, including BLAST for sequence analysis, and a suite of Python and R libraries commonly used in data analysis and visualization.

+
# Run the container, providing an interactive shell
+apptainer shell bioinfo_container.sif
+
+
+

This command provides an interactive shell within the bioinfo_container.sif, allowing users to execute the installed tools and perform analyses as if they were running on a native environment. This setup is ideal for ensuring that all users, regardless of their host system configuration, can reproduce the scientific computations.

+
+

Summary

+

In this tutorial, you’ve learned how to create advanced container recipes using Apptainer to build a comprehensive scientific software stack. This skill is invaluable for researchers who need to ensure the reproducibility of their experiments and for IT administrators tasked with maintaining consistent

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

© Copyright 2024-, The contributors.

+
+ + Built with Sphinx using a + theme + provided by Read the Docs. + + +
+
+
+
+
+ + + + \ No newline at end of file diff --git a/branch/maikens_comments/apptainer_gpus/index.html b/branch/maikens_comments/apptainer_gpus/index.html new file mode 100644 index 0000000..d266e8e --- /dev/null +++ b/branch/maikens_comments/apptainer_gpus/index.html @@ -0,0 +1,192 @@ + + + + + + + Using GPUs with Apptainer — Container on HPC with Apptainer documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Using GPUs with Apptainer

+
+

Objectives

+
    +

  • Understand how to access and utilize GPU resources within an Apptainer container.

    • +

  • Learn to configure an Apptainer container for running applications that require GPU computation.

    • +

  • Develop skills to integrate GPU-based processing within containerized scientific workflows.

    • +
+

This demo will guide you through the process of configuring and running an Apptainer container that utilizes GPUs, which is essential for high-performance computing tasks that require significant computational power, such as deep learning and large-scale data processing. Utilizing GPUs within containers can dramatically increase the efficiency and speed of these computations.

+
+
+

Prerequisites

+
    +

  • Access to an HPC system with NVIDIA GPUs installed.

    • +

  • Apptainer installed on the HPC system.

    • +

  • Basic understanding of containerization and GPU computing principles.

    • +
+
+

GPUs are powerful tools for accelerating computational workloads, particularly those involving parallel processing tasks. However, accessing GPU resources within a containerized environment presents unique challenges, such as ensuring proper drivers are installed and accessible to the container. This demo will show you how to overcome these challenges to harness the full potential of GPU computing in an HPC setting.

+

First, we will create an Apptainer definition file that sets up an environment capable of utilizing NVIDIA GPUs.

+
# Example Apptainer definition file for using NVIDIA GPUs
+Bootstrap: library
+From: nvcr.io/nvidia/cuda:11.0-base
+
+%post
+    apt-get update && apt-get install -y cuda-samples-11-0
+
+%test
+    cd /usr/local/cuda-11.0/samples/1_Utilities/deviceQuery
+    make
+    ./deviceQuery
+
+%environment
+    export PATH=/usr/local/nvidia/bin:/usr/local/cuda/bin:${PATH}
+    export LD_LIBRARY_PATH=/usr/local/nvidia/lib:/usr/local/nvidia/lib64
+
+%runscript
+    echo "Running CUDA device query..."
+    ./deviceQuery
+
+
+
# Build the GPU-enabled container
+apptainer build cuda_container.sif cuda.def
+
+
+

This block constructs the cuda_container.sif container from the cuda.def definition file, which includes the CUDA base image from NVIDIA’s container registry. This setup ensures that the container will have access to the necessary CUDA libraries and tools to utilize GPU resources.

+
# Run the container with GPU support
+apptainer exec --nv cuda_container.sif /bin/bash
+
+
+

This command executes the container with the --nv flag, which enables NVIDIA GPU support within the container. This flag is crucial as it allows the container to access the host’s GPU resources, essential for running GPU-accelerated applications.

+
+

Summary

+

In this tutorial, you have learned how to configure and use an Apptainer container to access and utilize GPU resources for high-performance computational tasks. This capability is particularly valuable in scientific computing, where the processing power of GPUs can be leveraged to accelerate research and development workflows. By integrating GPU support into your containers, you enhance their functionality and applicability in a wide range of HPC scenarios.

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

© Copyright 2024-, The contributors.

+
+ + Built with Sphinx using a + theme + provided by Read the Docs. + + +
+
+
+
+
+ + + + \ No newline at end of file diff --git a/branch/maikens_comments/basics_running_containers/index.html b/branch/maikens_comments/basics_running_containers/index.html new file mode 100644 index 0000000..a9e2da1 --- /dev/null +++ b/branch/maikens_comments/basics_running_containers/index.html @@ -0,0 +1,303 @@ + + + + + + + Basics of running containers — Container on HPC with Apptainer documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Basics of running containers

+
+

Objectives

+
    +

  • Learn what methods are available to run a container

    • +
+
+
+

Different ways you can run your containers

+

You can run your container in multiple different ways:

+
    +

  • You can run the container as a single application

    • +

  • You can get an interactive terminal in the container

    • +

  • You can run an application from within the container

    • +
+

We’ll cover these ways in individual sections below.

+
+
+

How to read Apptainer commands?

+

Apptainer’s commands can sometimes have multiple flags +which can make it hard to parse the command line.

+

A typical apptainer command has:

+
    +

  1. apptainer is at the start because we use the +Apptainer client to run the commands.

    2. +

  2. A subcommand (like pull, build, exec, run etc.) +that tells which Apptainer feature we want to use.

    3. +

  3. Often after the subcommand we have the name of the image we +want to use.

    4. +

  4. At the end we might have additional commands that Apptainer +ignores but are to be digested by the application that the container itself is running.

    5. +
+

For legibility reasons many commands in this lesson are highlighted +in this format:

+
+../_images/apptainer_example.png +
+

Figure 1: How apptainer-commands are highlighted

+
+
+

For the comprehensive list of client commands, see +Apptainer CLI reference page.

+
+
+

Obtaining a container from container registry

+

For these examples let’s use a +Python image from Docker Hub.

+

For now let’s just consider it as an application we want +to use and that this application is available in Docker Hub.

+

Let’s create the container image with the following command:

+
$ apptainer pull python.sif docker://python
+
+
+

We’ll talk about container images and image building later on. +For now it is enough to know that the file python.sif contains +a Python installation.

+
+
+

Running the container

+

Running the container means that we run some specific program +that the image creator has set to be the default program for this image.

+

When we run the container we will execute a so-called entry script +or runscript that contains commands specified by the image creators.

+
+

Warning

+

Remember to only run containers from sources that you trust.

+
+

Let’s run the Python container image:

+
$ apptainer run python.sif
+
+
+
+

Expected result

+

We get a Python interpreter running in the container:

+
$ apptainer run python.sif
+Python 3.12.3 (main, Apr 10 2024, 14:35:18) [GCC 12.2.0] on linux
+Type "help", "copyright", "credits" or "license" for more information.
+>>>
+
+
+
+

You should read the command line like this:

+
+../_images/run_example.png +
+

Figure 2: A simple run command

+
+
+

This syntax might seem self-evident, but in more complex use cases we will give +additional flags to various parts of the command.

+
+
+

Launching an interactive shell in the container

+

We can launch an interactive shell in a container with +apptainer shell-command:

+
$ apptainer shell python.sif
+
+
+
+

Expected result

+

We get a bash terminal running in the container:

+
$ apptainer shell python.sif
+Apptainer> echo $SHELL
+/bin/bash
+
+
+
+

You should read the command line like this:

+
+../_images/shell_example.png +
+

Figure 3: Launch a shell in a container

+
+
+
+
+

Running a single program from the container

+

We can launch a single program in a container with +apptainer exec-command.

+

The Python container is based on a Debian Linux distribution. +Let’s check the Debian version in the container:

+
$ apptainer exec python.sif cat /etc/debian_version
+
+
+
+

Expected result

+

With the command we print the contents of the +/etc/debian_version-file:

+
$ apptainer exec python.sif cat /etc/debian_version
+12.5
+
+
+
+

You should read the command line like this:

+
+../_images/exec_example.png +
+

Figure 4: Launch a program in a container

+
+
+
+
+

Review of this session

+
+

Key points to remember

+
    +

  • You can run the containers default program/application/set-of-commands with apptainer run my_image.sif

    • +

  • You can start an interactive shell in a container with apptainer shell my_image.sif

    • +

  • You can execute a single program in a container with apptainer exec my_image.sif my_program arg1 arg2

    • +
+
+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/branch/maikens_comments/binding_folders/index.html b/branch/maikens_comments/binding_folders/index.html new file mode 100644 index 0000000..1cccd33 --- /dev/null +++ b/branch/maikens_comments/binding_folders/index.html @@ -0,0 +1,204 @@ + + + + + + + Binding folders into your container — Container on HPC with Apptainer documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Binding folders into your container

+
+

Objectives

+
    +

  • Learn how you can bind folders into containers

    • +
+
+

When you launch a program in a container, the program runs in a contained +environment. The file system in the container might not have the same +folders structure as the machine that runs the container.

+

So, when you want to work on your data, you need to bring it with you into +this contained world inside the container.

+

This is done via method called mount binding.

+

Binding means that a folder from the host system is mapped into a folder +inside the container.

+
+../_images/default_mounts.png +
+

Figure 1: Only some folders are mounted by default

+
+
+

By default, $HOME, $CWD (current working directory) +/tmp and +few other paths +are bound to the image.

+

If you want to do additional mappings you need to do it by giving an +extra arguments to the command you’re running.

+

The following would bind folder /scratch from the host system to +/scratch in the container:

+
$ apptainer exec --bind /scratch example.sif ls /scratch
+
+
+
+../_images/bind_example.png +
+

Figure 2: Binding a directory inside a container

+
+
+

Setting --bind-argument works for apptainer run- and +apptainer shell-commands as well.

+

You can also bind directories to different places. This is especially +helpful if, for example. the code in container expects that data +should be in /data:

+
$ apptainer exec --bind /scratch:/data example.sif ls /data
+
+
+
+

Warning

+

Bind mounts are the same folders inside and outside of the image.

+

Deleting file from the folder that you bound inside the image will +delete the file completely.

+
+
+

Key points to remember

+
    +

  • By default only some folders are bound inside the container.

    • +

  • You’ll need to manually --bind-folders from outside of +the container if you want to use them inside the container.

    • +

  • Bound folders are the same folders inside and outside of the +container.

    • +
+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/branch/maikens_comments/building_images/index.html b/branch/maikens_comments/building_images/index.html new file mode 100644 index 0000000..c514015 --- /dev/null +++ b/branch/maikens_comments/building_images/index.html @@ -0,0 +1,525 @@ + + + + + + + Building Apptainer images — Container on HPC with Apptainer documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Building Apptainer images

+
+

Objectives

+
    +

  • Learn how you can build container images

    • +
+
+

In this session we’ll discuss various ways you can create Apptainer images.

+
+

Pulling an existing image from a container registry

+

We have already seen how to pull a +Python image from Docker Hub.

+
$ apptainer pull python.sif docker://python
+
+
+

We could have alternatively used the full registry specification URL:

+
$ apptainer pull python.sif docker://docker.io/library/python:latest
+
+
+

The format for these registry specifications is:

+

docker://REGISTRY_URL/USER_NAMESPACE/IMAGE_NAME:IMAGE_TAG

+

Here docker:// means that we use a Docker Hub compatible container +registry. There are other compatible registries such as +quay and +GitHub container registry.

+

You can read the command like this:

+
+../_images/pull_example.png +
+

Figure 1: Pulling an image from a repository

+
+
+
+
+

Handling temporary layers needed by the build process

+

When Apptainer creates a .sif-image it needs to first download any layers +it uses for the building. Then it will squash all of these layers to one +.sif-image.

+

These are stored in a folder specified by an environment variable +APPTAINER_CACHEDIR. By default, Apptainer will use +$HOME/.apptainer/cache. This can result in you running out of quota +during the image creation process if the home folder quota is not big.

+

You can set the cache directory with:

+
$ mkdir apptainer_cache
+$ export APPTAINER_CACHEDIR=$PWD/apptainer_cache
+
+
+

It is adviced to select a location in some filesystem that has enough space available. +For instance a type of “scratch” area on your HPC.

+

You can check the cache status with:

+
$ apptainer cache list
+
+
+

and you can clean the cache with:

+
$ apptainer cache clean
+
+
+

See this page +for more documentation.

+
+
+

Creating an image using a specification file

+

Let’s say we want to create an apptainer image for the following +summation.py-script:

+
import argparse
+
+parser = argparse.ArgumentParser()
+parser.add_argument(
+    "numbers", help="Numbers to sum", type=int, nargs='*'
+)
+args = parser.parse_args()
+
+numbers = args.numbers
+
+if len(numbers) > 1:
+   print(f'Sum of numbers was: {sum(numbers)}')
+else:
+   print('You did not give me any numbers to sum!')
+
+
+

Let’s create a definition file for this image:

+
Bootstrap: docker
+From: python:latest
+
+%files
+    summation.py /opt
+
+%runscript
+    echo "Got arguments: $*"
+    exec python /opt/summation.py "$@"
+
+
+

In this definition file we specify:

+
    +

  1. The bootstrapping method we want to use to build the image.

    2. +

  2. The base image we want to use for bootstrapping.

    3. +

  3. Files we want to copy to the image in the %files-block.

    4. +

  4. Commands we want to run when the image is ran in the %runscript-block.

    5. +
+

Now we can built this image with:

+
$ apptainer build my_container.sif my_container_definition.def
+
+
+
+../_images/build_example.png +
+

Figure 2: Building an image from a definition file

+
+
+

After building the image we can test out the image with:

+
$ apptainer run my_container.sif 1 2
+
+
+

This will run the default set of commands specified in the %runscript block in +the Apptainer definition file. The two arguments we send into the +shell environment of the container, namely the numbers 1 and 2 are used by the +executable in the runscript.

+
+

Expected result

+

Building container should result in a container image +my_container.sif being created.

+

Running the container should produce the following output:

+
$ apptainer run my_container.sif 1 2
+Got arguments: 1 2
+Sum of numbers was: 3
+
+
+
+
+

Key points to remember

+
    +

  • Bootstrap settings are analogous to what you would use with +apptainer pull.

    • +

  • The application inside the container could be much more complex. +By creating a apptainer run-interface via %runscript-block +you can convert a big and complex installation into what is +basically a single executable.

    • +
+
+
+
+

Running additional installation commands during image creation

+

More often than not, creating an image involves more than +just using an existing image.

+

If you want to run additional installation commands, +you can do them in a %post-block. These commands will +be run once during the building procedure.

+

For example, let’s modify our definition file so that we get an installation +of numpy-package in the image:

+
Bootstrap: docker
+From: python:latest
+
+%files
+    summation.py /opt
+
+%runscript
+    echo "Got arguments: $*"
+    exec python /opt/summation.py "$@"
+
+%post
+    pip install numpy
+
+
+

After re-building the image we can test the numpy installation with:

+
$ apptainer exec my_container.sif python -c 'import numpy; print(numpy.__version__)'
+
+
+
+

Expected result

+

During the build process we should see that the numpy-package is +being installed.

+

Running the container should produce the following output:

+
$ apptainer exec my_container.sif python -c 'import numpy; print(numpy.__version__)'
+1.26.4
+
+
+
+
+

Image building is done as a fake root-user

+

Commands that are run in the %post step and in other setup steps +are run in a state called +fakeroot where +the user looks like the root-user inside the container when in reality +the user is a normal user.

+

This means that use of sudo is not needed when installing packages via +package managers.

+

When converting installation instructions written for normal +non-containerized installations to definition files +one should usually remove sudo from the front of commands.

+
+
+

Warning

+

Remember that images should not contain any secrets +(passwords, sensitive code or data etc.)!

+

Anybody who has access to the image can access all files +in the image.

+
+
+
+

Setting environment variables in the image

+

We can also specify that additional environment variables should be set +when the image is being launched with an %environment-block.

+

While %runscript only applies when we apptainer run the image, +commands specified in the %environment-block will be executed when +the image is launched.

+

Let’s use this opportunity to set the terminal language options +in the container. Usually containers do not have all available language +settings installed, so setting these environment variables is very common.

+
Bootstrap: docker
+From: python:latest
+
+%files
+    summation.py /opt
+
+%runscript
+    echo "Got arguments: $*"
+    exec python /opt/summation.py "$@"
+
+%post
+    pip install numpy
+
+%environment
+    export LC_ALL=C
+    export LANGUAGE=C
+    export LANG=C
+
+
+

After re-building the image we can test that the environment values is set with:

+
$ apptainer exec my_container.sif python -c 'import os; print(os.getenv("LANG"))'
+
+
+
+

Expected result

+

After rebuilding the container running the container should produce the following output:

+
$ apptainer exec my_container.sif python -c 'import os; print(os.getenv("MYVAR"))'
+yes
+
+
+
+

You can also set environment variables when running an image by +setting APPTAINERENV_MYVAR=myvalue outside of the container or +by giving --env MYVAR=myvalue as a flag to the +run/exec/shell-command.

+

For more info on how to set environment variables when running containers, +see this page +from Apptainer’s documentation.

+
+
+

Adding documentation to your image

+

If you’re planning on sharing your image with other people or you want to +keep tabs on multiple images you can use labels to mark your image with +a %labels-block.

+

You can also add a %help-block that will tell users on how to use your +image.

+

Let’s add these blocks to the definition file:

+
Bootstrap: docker
+From: python:latest
+
+%files
+    summation.py /opt
+
+%runscript
+    echo "Got arguments: $*"
+    exec python /opt/summation.py "$@"
+
+%post
+    pip install numpy
+
+%environment
+    export LC_ALL=C
+    export LANGUAGE=C
+    export LANG=C
+
+%labels
+   Author: CodeRefinery
+   Version: v0.0.1
+   Description: This is an example image
+
+%help
+   This container sums up numbers.
+
+   Example:
+
+      apptainer run my_container.sif 1 2
+
+
+

Let’s check the help message with:

+
$ apptainer run-help my_container.sif
+
+
+
+

Expected result

+

The output should look something like this:

+
$ apptainer run-help my_container.sif
+    This container sums up numbers.
+
+    Example:
+
+       apptainer run my_container.sif 1 2
+
+
+
+
+
+

Examining the container

+

Now that we have a container with some software in it we can examine it with

+
$ apptainer inspect my_container.sif
+
+
+
+

Expected result

+

The output should look something like this:

+
$ apptainer inspect my_container.sif
+Author:: CodeRefinery
+Description:: This is an example image
+Version:: v0.0.1
+org.label-schema.build-arch: amd64
+org.label-schema.build-date: Thursday_25_April_2024_21:45:51_EEST
+org.label-schema.schema-version: 1.0
+org.label-schema.usage.apptainer.version: 1.3.0
+org.label-schema.usage.singularity.deffile.bootstrap: docker
+org.label-schema.usage.singularity.deffile.from: python:latest
+
+
+
+

We can also see the image contents with

+
$ apptainer sif list my_container.sif
+
+
+
+

Expected result

+

Output of the command should be something like this:

+
$ apptainer sif list my_container.sif
+------------------------------------------------------------------------------
+ID   |GROUP   |LINK    |SIF POSITION (start-end)  |TYPE
+------------------------------------------------------------------------------
+1    |1       |NONE    |32176-32385               |Def.FILE
+2    |1       |NONE    |32385-34957               |JSON.Generic
+3    |1       |NONE    |34957-35407               |JSON.Generic
+4    |1       |NONE    |36864-394522624           |FS (Squashfs/-System/amd64)
+
+
+
+

From the output of the previous command we see that at position 1 of the file we have +the definition file used to build the image. We can examine that with

+
$ apptainer sif dump 1 my_container.sif
+
+
+
+
+

Additional definition file options

+

There are plenty of other sections that can be used in the definition +file. For a great and comprehensive documentation, see +Apptainer’s documentation for definition files.

+
+
These features include:
    +

  • Creating multiple callable applications in the image

    • +

  • Creating services that can be started and stopped

    • +

  • Creating tests for the image build

    • +
+
+
+
+

Key points to remember

+
    +

  • Use apptainer pull to pull existing Docker images.

    • +

  • Use apptainer build to build custom images from definition files.

    • +

  • Do not store secret information in images.

    • +

  • There are plenty of additional features provided. Check documentation +for more info.

    • +
+
+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/branch/maikens_comments/conda/index.html b/branch/maikens_comments/conda/index.html new file mode 100644 index 0000000..72a0bfd --- /dev/null +++ b/branch/maikens_comments/conda/index.html @@ -0,0 +1,187 @@ + + + + + + + Reproducibility with Python — Container on HPC with Apptainer documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Reproducibility with Python

+
+

Objectives

+
    +

  • Understand the role of Conda environments in ensuring reproducibility in scientific computing.

    • +

  • Learn how to set up a Conda environment within an Apptainer container.

    • +

  • Develop skills to create and manage Python environments that are consistent across various computing platforms.

    • +
+

This demo demonstrates the creation of a Conda environment within an Apptainer container to enhance reproducibility in scientific computing. Conda is a popular package management system that simplifies package installation and environment management. This is crucial in scientific research where experiments often require specific versions of software and libraries to ensure consistent results.

+
+
+

Prerequisites

+
    +

  • Access to an HPC system with Apptainer installed.

    • +

  • Basic knowledge of Python, Conda, and container technologies.

    • +
+
+

Reproducibility is a cornerstone of scientific research, ensuring that results are consistent over time and across different platforms. By using Conda within Apptainer containers, researchers can encapsulate their computational environment, making their workflows portable and reproducible.

+

First, we’ll define a container with a Conda environment set up for a typical scientific Python stack.

+
# Example Apptainer definition file for setting up a Conda environment
+Bootstrap: library
+From: continuumio/miniconda3
+
+%post
+    conda create -n scienv python=3.8 numpy scipy matplotlib ipython -y
+    echo "source activate scienv" >> ~/.bashrc
+
+%environment
+    export PATH=/opt/conda/envs/scienv/bin:$PATH
+
+%runscript
+    echo "Activating Conda environment and launching IPython..."
+    source activate scienv
+    ipython
+
+
+
# Build the container that includes the Conda environment
+apptainer build conda_container.sif conda.def
+
+
+

This block builds the conda_container.sif from the conda.def definition file, which uses the Miniconda image to install a Conda environment named scienv with several essential scientific computing packages like NumPy, SciPy, and Matplotlib.

+
# Run the container, initiating the Conda environment
+apptainer exec conda_container.sif /bin/bash -c "source ~/.bashrc && ipython"
+
+
+

This command starts a shell that activates the Conda environment and launches IPython, a powerful interactive shell for Python. This setup allows users to interactively compute and visualize data within the consistent environment provided by the container.

+
+

Summary

+

In this tutorial, you’ve learned how to create a reproducible Python computing environment using Conda within an Apptainer container. This approach is invaluable for scientific researchers who need to ensure that their computational experiments are consistent and reproducible, regardless of the underlying hardware or software environment. By leveraging Conda and Apptainer, you can significantly enhance the portability and reliability of your scientific workflows.

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

© Copyright 2024-, The contributors.

+
+ + Built with Sphinx using a + theme + provided by Read the Docs. + + +
+
+
+
+
+ + + + \ No newline at end of file diff --git a/branch/maikens_comments/container_images/index.html b/branch/maikens_comments/container_images/index.html new file mode 100644 index 0000000..64a2cf2 --- /dev/null +++ b/branch/maikens_comments/container_images/index.html @@ -0,0 +1,268 @@ + + + + + + + Intro to container images — Container on HPC with Apptainer documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Intro to container images

+
+

Objectives

+
    +

  • Learn what container image means

    • +
+
+
+

Traditional container images (Docker etc.)

+

When containers launch they need a file system with a linux operating system. +This filesystem is provided by a container image.

+

This naming comes from an analogy with a traditional image or a painting.

+
+https://upload.wikimedia.org/wikipedia/commons/6/6d/Saint_Jerome_Leonardo_-_image_only_%28Q972196%29.jpg +
+

Figure 1: Saint Jerome in the Wilderness by Leonardo da Vinci

+
+
+

Let’s consider the image above. It is an unfinished painting by Leonardo da Vinci.

+

From the unfinished nature of this painting you can see the following:

+
    +

  • Some areas of the background panel are not touched at all (e.g. hands).

    • +

  • The base background is in some places covered by sketches (e.g the lion) and in most places by the background colors.

    • +

  • The background colors are sometimes covered in sketches as well (e.g. top left).

    • +
+

From these things we can gather that the image is constructed from layers where +paint or sketches cover what is hidden underneath.

+

This analogy happens with traditional container images as well (e.g. docker images): +container images consist of multiple layers where top layers can hide preceding layers.

+

A typical image might look something like this:

+
+../_images/image_explanation.png +
+

Figure 2: Typical container image consists of individual layers

+
+
+

In practice this overwriting behaviour is done by using a file format called SquashFS, +where file systems are stored in one single layer.

+

In a traditional image the image is built in this fashion:

+
    +

  1. The build starts from a base image. This is often an OS image, but it does not have to +be. It can be some other image that has a OS image as its base image.

    2. +

  2. This layer is started up in a container.

    3. +

  3. Modifications are done. For example, an application is installed.

    4. +

  4. The difference of what files were modified is stored into a new layer.

    5. +

  5. This new image with the modifications is now used as a base image.

    6. +

  6. More modifications are done unless there are no more modifications to do.

    7. +

  7. The last layer is tagged with some human readable name.

    8. +

  8. When image is published to other users, it is sent to some container registry.

    9. +
+

The file that contains the commands that need to be run to build the image +is called a Dockerfile. +This is true for systems other that Docker as well.

+

This way of working with differences of layers reduces the space needed to +store the images and the network capacity needed to transfer the images.

+

When a container is launched these layers are fetched and organized on top of each +other and when a program tries to find a file, it will go through the layers until it +finds it. This is analogous to light bouncing off from the top layer of paint on a +painting. Paint below the top layer is hidden.

+
+

Key points to remember

+
    +

  • Traditional containers are built layer by layer.

    • +

  • Traditional containers are built from Dockerfiles.

    • +

  • Traditional container images are transferred via registries using +client tools or as .tar-files.

    • +
+
+
+
+

Apptainer container images

+

Apptainer works a bit differently than traditional container setups.

+

Apptainer stores the container image in one file in +Singularity image format or .sif. This file is a SquashFS file with +additional metadata included.

+

This means that Apptainer does not store image as multiple layers. +Instead it writes all of the layers into one single layer. This is analogous +to printing an image of a painting on a piece of paper. The hidden layers +of paint are not replicated and only the topmost layer is visible.

+
+../_images/image_explanation_apptainer.png +
+

Figure 3: Apptainer container image is a single unchanging image layer

+
+
+

This way of working has some upsides and some downsides.

+

Upsides include:

+
    +

  • The image is more portable. One image can be easily transferred across +systems using normal file copying tools.

    • +

  • The image is more reproducible. The metadata stored in the file gives +information on when the image was created and what commands were used +to create it.

    • +

  • The image is easier to archive. One just needs to keep track of a single +file.

    • +
+

Downsides include:

+
    +

  • Image creation takes longer as all operations need to be done in one go. +Traditional container images can be built layer by layer.

    • +

  • Images cannot be stored in traditional registries like Docker Hub.

    • +
+

Apptainer images can use Docker images as their starting point. +Additional build steps and runtime behaviour can be specified in a +definition file (.def).

+
+

Key points to remember

+
    +

  • Apptainer images are a single image layer which is stored in a .sif-file.

    • +

  • When built from traditional image, Apptainer images squash all layers to a single one.

    • +

  • Apptainer images are built from definition file (.def).

    • +

  • Apptainer images are transferred as normal files.

    • +
+
+
+
+

Image sources

+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/branch/maikens_comments/debugging/index.html b/branch/maikens_comments/debugging/index.html new file mode 100644 index 0000000..fd1ac84 --- /dev/null +++ b/branch/maikens_comments/debugging/index.html @@ -0,0 +1,194 @@ + + + + + + + Debugging Containers — Container on HPC with Apptainer documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Debugging Containers

+
+

Objectives

+
    +

  • Understand the importance of being able to debug applications within container environments.

    • +

  • Learn to enter an Apptainer container using a shell for debugging purposes.

    • +

  • Develop practical troubleshooting skills for containerized applications in an HPC setting.

    • +
+

This demo will instruct on how to access an Apptainer container with a shell interface to perform debugging and troubleshooting tasks. Debugging within containers is crucial because it allows developers and administrators to directly interact with the running environment and resolve issues that may not be apparent from outside the container.

+
+
+

Prerequisites

+
    +

  • Access to an HPC system with Apptainer installed.

    • +

  • A container with a misbehaving application or one prepared for debugging.

    • +

  • Basic familiarity with command-line interface operations and debugging tools.

    • +
+
+

Containers encapsulate dependencies and environments but can sometimes obscure problems from the host system. By entering the container itself, you can use standard debugging tools and inspect the state of the application as it runs within its isolated environment.

+

First, we’ll set up a simple container that includes tools and an application setup conducive to debugging. Then, we’ll demonstrate how to enter this container to troubleshoot issues.

+
# Example Apptainer definition file for a debuggable environment
+Bootstrap: library
+From: ubuntu:20.04
+
+%post
+    apt-get update && apt-get install -y python3 python3-pip gdb vim
+    pip3 install flask
+    echo "from flask import Flask" > /app.py
+    echo "app = Flask(__name__)" >> /app.py
+    echo "@app.route('/')" >> /app.py
+    echo "def hello():" >> /app.py
+    echo "    raise Exception('Intentional Error for Debugging')" >> /app.py
+    echo "if __name__ == '__main__':" >> /app.py
+    echo "    app.run(host='0.0.0.0', port=5000, debug=True)" >> /app.py
+
+%environment
+    export FLASK_APP=/app.py
+
+%runscript
+    echo "Running Flask app with intentional errors for debugging..."
+    python3 /app.py
+
+
+
# Build the container for debugging
+apptainer build debug_container.sif debug.def
+
+
+

This block constructs the debug_container.sif from the debug.def file, which sets up a Flask application programmed to raise an exception. This setup is useful for demonstrating how to handle errors within a live application.

+
# Enter the container with a shell to start debugging
+apptainer shell debug_container.sif
+
+
+

This command launches a shell within the debug_container.sif, allowing you to interact directly with the container’s environment. Inside the container, you can run the application, use tools like gdb or vim to inspect and modify files, or check logs to diagnose issues.

+
+

Summary

+

In this tutorial, you’ve learned how to enter an Apptainer container with a shell for the purpose of debugging applications. This skill is essential for software development and system administration in containerized environments, particularly in HPC where applications may behave differently due to complex interactions with underlying hardware and software layers. By mastering container debugging, you can significantly improve the reliability and performance of your applications.

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

© Copyright 2024-, The contributors.

+
+ + Built with Sphinx using a + theme + provided by Read the Docs. + + +
+
+
+
+
+ + + + \ No newline at end of file diff --git a/branch/maikens_comments/env_scripts/index.html b/branch/maikens_comments/env_scripts/index.html new file mode 100644 index 0000000..df5128e --- /dev/null +++ b/branch/maikens_comments/env_scripts/index.html @@ -0,0 +1,187 @@ + + + + + + + Environment Variables and Scripts — Container on HPC with Apptainer documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Environment Variables and Scripts

+
+

Objectives

+
    +

  • Understand the role of environment variables in configuring software behavior inside containers.

    • +

  • Learn to set and export environment variables within an Apptainer container.

    • +

  • Develop the ability to customize the behavior of applications running in containers through environmental configuration.

    • +
+

This demo will show you how to set and manipulate environment variables inside an Apptainer container. Environment variables are a critical component in software development and deployment, allowing you to modify the behavior of applications without changing code. They are especially useful in containerized environments where they can be used to control and customize settings across different deployments seamlessly.

+
+
+

Prerequisites

+
    +

  • Access to an HPC system with Apptainer installed.

    • +

  • Basic familiarity with shell scripting and command line operations.

    • +
+
+

Setting environment variables inside a container is an essential skill for software developers and system administrators. These variables can dictate operational parameters such as database connections, logging levels, and other configurable settings that an application might need to operate correctly in different environments. In this demo, you will learn how to set these variables within an Apptainer container, ensuring your applications behave as expected under various conditions.

+

First, we will create a simple Apptainer definition file that includes the necessary commands to set environment variables. Then, we will build and run the container to see how these variables affect the application’s behavior.

+
# Example Apptainer definition file setting environment variables
+Bootstrap: library
+From: ubuntu:20.04
+
+%post
+    apt-get update && apt-get install -y vim
+    echo 'export MY_VAR="Hello from Apptainer!"' >> /etc/profile
+
+%environment
+    export PATH="/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:$PATH"
+    export ANOTHER_VAR="Another example variable"
+
+%runscript
+    echo "MY_VAR is set to $MY_VAR"
+    echo "ANOTHER_VAR is set to $ANOTHER_VAR"
+
+
+
# Build the container with environment variables
+apptainer build env_container.sif env.def
+
+
+

This block creates the env_container.sif container from the env.def file. It sets up an Ubuntu-based environment and installs Vim as an example application. The %post section modifies the system profile to permanently set an environment variable, while %environment sets it specifically for when the container is run.

+
# Run the container to see environment variables in action
+apptainer run env_container.sif
+
+
+

This final command executes the container, running the script defined in %runscript. It outputs the values of the environment variables set during the build phase and the runtime environment, demonstrating how these can be manipulated within the container.

+
+

Summary

+

In this tutorial, you’ve learned how to set and export environment variables within an Apptainer container to influence the behavior of contained software applications. This skill is vital for managing software configurations in a reproducible and scalable manner across various computing environments. By using environment variables effectively, you can ensure that your applications perform consistently no matter where they are deployed.

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

© Copyright 2024-, The contributors.

+
+ + Built with Sphinx using a + theme + provided by Read the Docs. + + +
+
+
+
+
+ + + + \ No newline at end of file diff --git a/branch/maikens_comments/first_build/index.html b/branch/maikens_comments/first_build/index.html new file mode 100644 index 0000000..7d27148 --- /dev/null +++ b/branch/maikens_comments/first_build/index.html @@ -0,0 +1,195 @@ + + + + + + + Building Your First Container — Container on HPC with Apptainer documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Building Your First Container

+
+

Objectives

+
    +

  • Understand the basic concept and utility of containerization in HPC environments.

    • +

  • Learn to create an Apptainer container using a definition file.

    • +

  • Apply this knowledge to build reproducible computing environments.

    • +
+

In this demo, you will learn how to build your first container using Apptainer, starting from a simple definition file. Containers are crucial for creating reproducible, portable, and scalable environments that are isolated from the underlying infrastructure. This hands-on example will guide you through the process of defining and building a basic container, which is a foundational skill in using containers effectively in high-performance computing.

+
+
+

Prerequisites

+
    +

  • No prerequisites for following the demo

    • +
+
+

Building your first container is a significant first step to test the technology and make sure it works in the cluster(s) you use. This example is based on the typical case when you need to install and run a specific tool which cannot be easily installed by your HPC cluster admins. This can happen if certain tools are really tight to some specific system-wide dependencies (e.g. certain versions of libraries, compilers, operating system).

+

For the sake of learning, assume that the three tools fortune, cowsay, and lolcat cannot be installed by your cluster admins, and have strict requirements that you cannot just install them by yourself without root privileges.

+
# Example definition file content for Apptainer
+Bootstrap: docker
+From: ubuntu:20.04
+
+%post
+    apt-get -y update
+    apt-get -y install fortune cowsay lolcat
+
+%environment
+    export LC_ALL=C
+    export PATH=/usr/games:$PATH
+
+%runscript
+    fortune | cowsay | lolcat
+
+# Save the above content into a file named 'mydefinition.def'
+
+
+

Next we need to build the container image.

+
# Build an Apptainer container from a definition file
+apptainer build mycontainer.sif mydefinition.def
+
+
+

This command constructs a container named ‘mycontainer.sif’ from the definition file ‘mydefinition.def’. The .sif file format is a portable container format used by Apptainer. This step is essential as it compiles all the necessary components and software specified in your definition file into a single executable container.

+
+

Summary

+

This example showed you how to build a basic container using Apptainer from a definition file. You’ve learned a critical skill in containerization, enabling you to create reproducible and portable environments for a wide range of scientific applications. This capability is foundational in leveraging the full potential of HPC resources while ensuring consistency across different computing environments.

+
+

Build a simple container and test it

+

Build a simple container on your cluster. You do not have to use the example above. Test the following: +1. Start a terminal shell on the container and run a command such as date +2. Test the runscript part for the container above. How do you run it and what is the output?

+
+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/branch/maikens_comments/genindex/index.html b/branch/maikens_comments/genindex/index.html new file mode 100644 index 0000000..89c2ab5 --- /dev/null +++ b/branch/maikens_comments/genindex/index.html @@ -0,0 +1,141 @@ + + + + + + Index — Container on HPC with Apptainer documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ + +

Index

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

© Copyright 2024-, The contributors.

+
+ + Built with Sphinx using a + theme + provided by Read the Docs. + + +
+
+
+
+
+ + + + \ No newline at end of file diff --git a/branch/maikens_comments/gpus/index.html b/branch/maikens_comments/gpus/index.html new file mode 100644 index 0000000..6ad90be --- /dev/null +++ b/branch/maikens_comments/gpus/index.html @@ -0,0 +1,229 @@ + + + + + + + Running containers that use GPUs — Container on HPC with Apptainer documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Running containers that use GPUs

+
+

Objectives

+
    +

  • Learn how you can use GPUs with containers

    • +
+
+

If your program uses GPUs, you’ll need to make the GPUs visible in +the container. This is done by giving additional flag to the +apptainer command.

+

The container itself must have the correct GPU computing libraries +installed inside the image (CUDA toolkit for NVIDIA and ROCm for AMD). +Code inside the image needs to be installed with GPU support as well. +Apptainer will only mount the driver libraries and the GPU devices +that these toolkits need to run the code on GPUs.

+
+

Using NVIDIA’s GPUs

+

When using NVIDIA’s GPUs that use the CUDA-framework the flag is --nv.

+

As an example, let’s get a CUDA-enabled PyTorch-image:

+
$ apptainer pull pytorch-cuda.sif docker://docker.io/pytorch/pytorch:2.2.2-cuda12.1-cudnn8-runtime
+
+
+

Now when we launch the image, we can give the image GPU access with

+
$ apptainer exec --nv pytorch-cuda.sif python -c 'import torch; print(torch.cuda.is_available())'
+
+
+
+../_images/nv_example.png +
+

Figure 1: Enabling NVIDIA’s GPUs in containers

+
+
+
+

Expected result

+

If you run this in a system with an NVIDIA GPU, you should see the following result:

+
$ apptainer exec --nv pytorch-cuda.sif python -c 'import torch; print(torch.cuda.is_available())'
+True
+
+
+
+
+

Key points to remember

+
    +

  • Code inside the container image needs to support GPU calculations.

    • +

  • Container image should have a working CUDA toolkit installed.

    • +

  • Use --nv-flag to mount the device drivers inside of the image.

    • +
+
+
+
+

Using AMD’s GPUs

+

When using AMD’s GPUs that use the ROCm-framework the flag is --rocm.

+

As an example, let’s get a ROCm-enabled PyTorch-image:

+
$ apptainer pull pytorch-rocm.sif docker://docker.io/rocm/pytorch:rocm6.1_ubuntu22.04_py3.10_pytorch_2.1.2
+
+
+

Now when we launch the image, we can give the image GPU access with

+
$ apptainer exec --rocm pytorch-rocm.sif python -c 'import torch; print(torch.cuda.is_available())'
+
+
+
+../_images/rocm_example.png +
+

Figure 2: Enabling AMD’s GPUs in containers

+
+
+
+

Expected result

+

If you run this in a system with an AMD GPU, you should see the following result:

+
$ apptainer exec --rocm pytorch-rocm.sif python -c 'import torch; print(torch.cuda.is_available())'
+True
+
+
+
+
+

Key points to remember

+
    +

  • Code inside the container image needs to support GPU calculations.

    • +

  • Container image should have a working ROCm toolkit installed.

    • +

  • Use --rocm-flag to mount the device drivers inside of the image.

    • +
+
+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/branch/maikens_comments/index.html b/branch/maikens_comments/index.html new file mode 100644 index 0000000..cce9313 --- /dev/null +++ b/branch/maikens_comments/index.html @@ -0,0 +1,262 @@ + + + + + + + Containers on HPC with Apptainer — Container on HPC with Apptainer documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Containers on HPC with Apptainer

+
+

Warning

+

This is under construction.

+
+
+

Course instance in May 2024

+

You can follow the dates this course is given on the course page. +Dates are not yet known and registration is not yet open, though.

+
+

Improve your cluster workflows! You’ve had a basic course on working +with a cluster - but what do people actually do? This course shows +practical examples and tips which may help you, but aren’t usually +covered in either basic or advanced courses.

+

We won’t go so deep into each topic that you know everything about it, +but you learn what is possible, see some examples, and know where to +follow up on the tools that are right for you. The format is +designed to be “fireside chat with experts”, a combination of demos, +type-along, and independent exercises. You can engage at different +levels, depending on your interest.

+
+

Prerequisites

+
    +

  • Basic HPC usage course (if you don’t have, many of the things we +talk about won’t make sense, but you might pick up something +anyway).

    • +

  • A bit of experience using a HPC cluster (technically optional, +but will allow you to engage with the material at a deeper +level).

    • +

  • Access to some HPC computer cluster to do most exercises. +(Slurm-based, but most are these days). (If you don’t have, you +can’t do all exercises - but still might learn something!)

    • +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +

15 min

Intro to containers (on HPC)

20 min

Basics of running containers

15 min

Intro to container images

10 min

Break

25 min

Building Apptainer images

15 min

Binding folders into your container

05 min

Open discussion and where to go next

+
+

The lesson

+ +
+
+

Extras

+ +
+
+

Exercises

+ +
+
+

Who is the course for?

+

This course is for people using clusters or other larger computing +resources. It’s not a basic course, but also not extremely advanced. +It lets you see some examples and know what people actually do, and +then you can follow up with more reading, courses, or direct help +later on.

+

Some learner personas:

+
    +

  • You’ve just taken a basic HPC course, and while you mostly +understand how the basic pices work, you are left wondering “How +does this all fit together? How do people combine all of these +tools into an actual whole workflow?”.

    +

    You care about some real examples and things you can use right now, +but wouldn’t mind seeing some advanced or out-of-scope stuff as long +as you don’t have to spend too much mental effort on it.

    +

    You’ll probably do the more basic exercises and watch the rest as a +demo until you come back to it later (if needed).

    +
    • +

  • You’ve been using the cluster for a while and doing your work just +fine - or so you think. It works well, but you know there must be +some other tricks out there that can make your life (if not work) +even better.

    +

    You’ll probably attend and do the more advanced exercises, while +passively watching some of the more basic demos.

    +
    • +
+
+
+

About the course

+
+
+

See also

+
+
+

Credits

+

This course is a collaboration between ~10 different instructors.

+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/branch/maikens_comments/inspecting/index.html b/branch/maikens_comments/inspecting/index.html new file mode 100644 index 0000000..fee2ae3 --- /dev/null +++ b/branch/maikens_comments/inspecting/index.html @@ -0,0 +1,188 @@ + + + + + + + Inspecting Containers — Container on HPC with Apptainer documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Inspecting Containers

+
+

Objectives

+
    +

  • Understand the importance of inspecting containers to verify configurations and settings.

    • +

  • Learn to use Apptainer’s inspect command to view metadata, files, and environment settings within a container.

    • +

  • Develop skills to assess and troubleshoot container configurations in HPC environments.

    • +
+

This demo demonstrates how to use the inspect command in Apptainer to examine various aspects of a container. Inspecting a container is crucial for ensuring that it has been configured correctly, verifying that all necessary dependencies are included, and understanding how the container interacts with its environment. This capability is especially important in complex HPC setups where precise control over the computational environment is needed to ensure reproducibility and security.

+
+
+

Prerequisites

+
    +

  • Access to an HPC system with Apptainer installed.

    • +

  • A container already built and available for inspection.

    • +
+
+

The ability to inspect a container provides transparency into the containerized environment, which is invaluable for debugging, compliance checks, and enhancing security. In this demo, you will inspect an existing container to reveal its configuration details.

+

First, we will provide an example of a simple container definition file used to build a container, which we will then inspect.

+
# Example Apptainer definition file for inspection demo
+Bootstrap: library
+From: ubuntu:20.04
+
+%post
+    apt-get update && apt-get install -y vim
+    echo 'export TEST_VAR="This is a test environment variable"' >> /etc/environment
+
+%environment
+    export MY_APP_VERSION="1.0"
+    echo "Environment ready."
+
+%labels
+    AUTHOR "John Doe"
+    VERSION "1.0"
+    DESCRIPTION "This is a sample container for inspection purposes."
+
+
+
# Build the container for inspection
+apptainer build inspect_container.sif inspect.def
+
+
+

This block builds the inspect_container.sif from the inspect.def file, which includes a simple environment setup and labels for metadata. This setup prepares the container for detailed inspection.

+
# Inspect the container to view metadata, environment variables, and runscript
+apptainer inspect --labels --environment --runscript inspect_container.sif
+
+
+

This command uses Apptainer’s inspect functionality to show the container’s labels, environment variables, and the script that runs when the container is executed. These details are critical for understanding how the container is configured and for verifying its contents.

+
+

Summary

+

In this tutorial, you’ve learned how to inspect an Apptainer container to understand its internal configurations, including metadata, environment settings, and operational scripts. This knowledge is essential for managing and troubleshooting containers effectively, especially in research and development environments where precision and reproducibility are paramount.

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

© Copyright 2024-, The contributors.

+
+ + Built with Sphinx using a + theme + provided by Read the Docs. + + +
+
+
+
+
+ + + + \ No newline at end of file diff --git a/branch/maikens_comments/instructor-guide/index.html b/branch/maikens_comments/instructor-guide/index.html new file mode 100644 index 0000000..b1077b4 --- /dev/null +++ b/branch/maikens_comments/instructor-guide/index.html @@ -0,0 +1,160 @@ + + + + + + + Instructor’s guide — Container on HPC with Apptainer documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Instructor’s guide

+
+

Why we teach this lesson

+
+
+

Intended learning outcomes

+
+
+

Timing

+
+
+

Preparing exercises

+

e.g. what to do the day before to set up common repositories.

+
+
+

Other practical aspects

+
+
+

Interesting questions you might get

+
+
+

Typical pitfalls

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

© Copyright 2024-, The contributors.

+
+ + Built with Sphinx using a + theme + provided by Read the Docs. + + +
+
+
+
+
+ + + + \ No newline at end of file diff --git a/branch/maikens_comments/intro_and_motivation/index.html b/branch/maikens_comments/intro_and_motivation/index.html new file mode 100644 index 0000000..6794e8b --- /dev/null +++ b/branch/maikens_comments/intro_and_motivation/index.html @@ -0,0 +1,272 @@ + + + + + + + Intro to containers (on HPC) — Container on HPC with Apptainer documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Intro to containers (on HPC)

+
+

Objectives

+
    +

  • Understand the basic logic and terms behind container technology

    • +

  • Learn about the possible use cases for containers on HPC clusters

    • +
+
+
+

What even is a container?

+

Containers take their name from shipping containers:

+
+https://upload.wikimedia.org/wikipedia/commons/3/36/Shipping_container%2C_Bellarena_-_geograph.org.uk_-_1859736.jpg +
+

Figure 1: A shipping container in its natural habitat

+
+
+

This analogue is based on the idea is that containers have a barrier +between the insides of the container and outside of the container. +This makes shipping them between ports easy.

+

Based on this analogue one might think that the container is just a +storage format. It is that as well: containers are stored in container +images (more on this in a later chapter).

+

Instead it is a way of running an application in a self-contained +environment with all the tools that this specific application needs.

+

More traditional container launchers like Docker, Podman and Kubernetes +also manage containers’ resource usage, networking and various other aspects. +When using Apptainer, we do not need to worry about these features.

+
+

More technical information on how traditional containers work

+

Traditional containers use +linux namespaces +when they implement various features. These features include:

+
    +

  • Creating a separate process identifier (PID) namespace: +This means that process id’s are not shared in the container and on +the host.

    • +

  • Creating a virtual network for the containers: +Container runtimes such as docker often create virtual network +interfaces that the containers can use to communicate like actual +virtual machines.

    • +

  • Limiting container resources: +Container runtimes usually limit container resource usage +(CPU usage, RAM usage) via Linux control groups (cgroups).

    • +
+

Apptainer does none of these as it is meant to be run as a normal +user and not as a superuser.

+

Apptainer does use +user namespaces +for launching the container without giving the user additional privileges.

+
+

Let’s consider the following case:

+
    +

  1. User installs and runs an application on a their home computer

    2. +

  2. They want to run the exact same application on their HPC cluster

    3. +

  3. The operating system / available software is different on the HPC cluster

    4. +

  4. Even if the program runs, it is necessarily not the exact same program as operating system has changed

    5. +
+
+../_images/normal_application.png +
+

Figure 2: Without containers, your program uses libraries from the host system

+
+
+

With containers the user would run the exact same container on both systems:

+
+../_images/containerized_application.png +
+

Figure 3: With containers, your program uses libraries from the container image

+
+
+
+

Key points to remember

+

Containers are a way of launching applications in a self-contained +environment with their own OS and program libraries.

+

The filesystem used by containers is stored in container images. We’ll talk +more on container images later.

+
+
Remember that the word container can refer to:
    +

  • a running container with it’s own environment

    • +

  • the container image that defines the container environment

    • +
+
+
+
+
+
+

What is the intended use case of Apptainer?

+

Apptainer is meant for running complex applications in various systems such +as HPC systems in a reproducible and portable way.

+

There are many uses, but here are some example:

+
    +

  • Installing an application that has installation instructions designed for a specific operating system different than the one you are on.

    • +

  • Creating a self-contained application that can be used as a part of your +workflow in multiple different systems and can easily be shared with colleagues

    • +

  • Creating a finished application that can be shared with your paper

    • +

  • Reducing the amount of files needed to install an application by putting +all files in the image (especially useful for Python environments)

    • +
+
+
+

Apptainer vs. Singularity

+

Singularity started as an open source project from Lawrence Berkeley National +Laboratory in 2015. In 2018 a company called Sylabs was founded to provide +commercial support for sites that use it.

+

In 2021 the project joined Linux Foundation and was renamed Apptainer.

+

Sylabs is still present and they maintain their own fork of the project called +SingulartyCE.

+

For more info, see the +Singularity wikipedia article.

+
+

Key points to remember

+

Your site might be running Singularity, SingularityCE or Apptainer.

+

In most cases the user interface is completely the same.

+

If you’re running singularity you can just rename any +apptainer-commands to singularity.

+
+
+
+

Image sources

+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/branch/maikens_comments/mpi_demo/index.html b/branch/maikens_comments/mpi_demo/index.html new file mode 100644 index 0000000..56b0966 --- /dev/null +++ b/branch/maikens_comments/mpi_demo/index.html @@ -0,0 +1,196 @@ + + + + + + + Running Parallel Jobs — Container on HPC with Apptainer documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Running Parallel Jobs

+
+

Objectives

+
    +

  • Understand the integration of MPI with containerized environments.

    • +

  • Learn to execute a script that runs parallel computational jobs using MPI inside an Apptainer container.

    • +

  • Acquire skills to leverage HPC resources for parallel computing within containerized applications.

    • +
+

This demo demonstrates how to run parallel computational jobs inside an Apptainer container using the Message Passing Interface (MPI). Parallel computing is essential in HPC for solving complex and large-scale problems efficiently. By running these jobs inside containers, you can enhance portability and reproducibility of your computations across different HPC systems. This example will guide you through setting up an MPI environment inside a container and executing a parallel job script.

+
+
+

Prerequisites

+
    +

  • Access to an HPC system with Apptainer installed.

    • +

  • Basic knowledge of parallel computing and MPI.

    • +

  • User permissions to run jobs on the HPC cluster.

    • +
+
+

Containers can encapsulate all the necessary software and libraries, providing a consistent runtime environment for applications. This is particularly beneficial for parallel computing where environmental consistency can significantly affect computational results. In this demo, you will use Apptainer to encapsulate the MPI environment and ensure that your parallel jobs can be executed seamlessly on any HPC system.

+

First, you will create a definition file for an Apptainer container that includes MPI libraries and a simple MPI script. Then, you will build the container and run a parallel job using MPI.

+
# Apptainer definition file for MPI environment
+Bootstrap: library
+From: ubuntu:20.04
+
+%post
+    apt-get update && apt-get install -y mpich
+    echo "Hello from MPI" > /mpi_test.c
+    echo "#include <mpi.h>" >> /mpi_test.c
+    echo "int main(int argc, char* argv[]) {" >> /mpi_test.c
+    echo "    MPI_Init(&argc, &argv);" >> /mpi_test.c
+    echo "    int rank;" >> /mpi_test.c
+    echo "    MPI_Comm_rank(MPI_COMM_WORLD, &rank);" >> /mpi_test.c
+    echo "    printf(\"Rank %d: Hello MPI World!\\n\", rank);" >> /mpi_test.c
+    echo "    MPI_Finalize();" >> /mpi_test.c
+    echo "    return 0;" >> /mpi_test.c
+    echo "}" >> /mpi_test.c
+    mpicc /mpi_test.c -o /mpi_hello
+
+%environment
+    export PATH=/usr/local/bin:$PATH
+
+%runscript
+    mpirun -np 4 /mpi_hello
+
+
+
# Build the MPI container
+apptainer build mpi_container.sif mpi.def
+
+
+

This block creates the container mpi_container.sif from the definition file mpi.def. It includes installing MPICH, a popular MPI implementation, and compiling a simple MPI program that will be executed within the container.

+
# Run the MPI container job
+apptainer exec --nv mpi_container.sif mpirun -np 4 /mpi_hello
+
+
+

This command runs the MPI program inside the container across four processes. The --nv option allows the container to access the host’s Nvidia GPU resources if available, which is useful for MPI jobs that may benefit from GPU acceleration.

+
+

Summary

+

You have successfully learned how to set up and execute parallel computational jobs using MPI inside an Apptainer container. This ability is critical for ensuring that your scientific computing tasks are both scalable and reproducible, regardless of the underlying HPC infrastructure. By encapsulating the MPI environment inside a container, you maintain consistency and control over the software dependencies, significantly enhancing the reliability of your computational results.

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

© Copyright 2024-, The contributors.

+
+ + Built with Sphinx using a + theme + provided by Read the Docs. + + +
+
+
+
+
+ + + + \ No newline at end of file diff --git a/branch/maikens_comments/networking/index.html b/branch/maikens_comments/networking/index.html new file mode 100644 index 0000000..dd120b4 --- /dev/null +++ b/branch/maikens_comments/networking/index.html @@ -0,0 +1,185 @@ + + + + + + + Networking in Containers — Container on HPC with Apptainer documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Networking in Containers

+
+

Objectives

+
    +

  • Understand the impact of network configurations on containerized applications in HPC environments.

    • +

  • Learn to configure and test network settings within an Apptainer container.

    • +

  • Acquire the ability to ensure network connectivity and proper configuration for applications running inside containers.

    • +
+

This demo focuses on the configuration and testing of network settings within an Apptainer container. Networking is a critical component of containerized applications, particularly when these applications need to communicate with external resources or other applications within a cluster. Proper network configuration helps ensure that containers are both secure and functional, aligning with the network policies of the HPC environment.

+
+
+

Prerequisites

+
    +

  • Access to an HPC system with Apptainer installed.

    • +

  • Basic knowledge of networking concepts such as IP addressing, DNS, and port mapping.

    • +

  • Permissions to modify network settings on the host, if necessary.

    • +
+
+

Networking within containers can be complex due to the isolation provided by the container environment. This isolation, while beneficial for security and resource management, can complicate network communication unless properly configured. In this demo, you’ll learn how to set up and verify network configurations that allow your containerized applications to communicate effectively and securely.

+

First, let’s define a container that includes networking tools for testing connectivity and configurations.

+
# Create an Apptainer definition file with network tools
+Bootstrap: library
+From: ubuntu:20.04
+
+%post
+    apt-get update && apt-get install -y iproute2 net-tools inetutils-ping
+
+%runscript
+    echo "Checking network configuration..."
+    ifconfig
+    echo "Pinging google.com to test DNS resolution and internet connectivity..."
+    ping -c 4 google.com
+
+
+
# Build the container with networking capabilities
+apptainer build net_container.sif net.def
+
+
+

This block compiles the net_container.sif container from the net.def file, which includes necessary tools such as ifconfig for checking IP addresses, net-tools for various network operations, and ping to test connectivity.

+
# Run the container to test network settings
+apptainer exec net_container.sif /bin/bash
+
+
+

This command launches the container, allowing you to interact with the shell and manually execute commands to inspect and test the network settings as defined in the %runscript section. You can verify the network interface configurations and test internet connectivity via DNS resolution.

+
+

Summary

+

In this tutorial, you’ve learned how to configure and test network settings within an Apptainer container. Understanding and managing network configurations is essential for the deployment of containerized applications in HPC environments, especially those that require external network communication or are part of a larger distributed system. By ensuring that your containers are properly configured to handle network traffic, you enhance their utility and integration into broader computing frameworks.

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

© Copyright 2024-, The contributors.

+
+ + Built with Sphinx using a + theme + provided by Read the Docs. + + +
+
+
+
+
+ + + + \ No newline at end of file diff --git a/branch/maikens_comments/objects.inv b/branch/maikens_comments/objects.inv new file mode 100644 index 0000000..e43b70a Binary files /dev/null and b/branch/maikens_comments/objects.inv differ diff --git a/branch/maikens_comments/overlay/index.html b/branch/maikens_comments/overlay/index.html new file mode 100644 index 0000000..6e6f834 --- /dev/null +++ b/branch/maikens_comments/overlay/index.html @@ -0,0 +1,188 @@ + + + + + + + Overlay File Systems — Container on HPC with Apptainer documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Overlay File Systems

+
+

Objectives

+
    +

  • Understand the concept and utility of overlay file systems in container technology.

    • +

  • Learn how to use overlay file systems to modify contents within an Apptainer container at runtime.

    • +

  • Develop the ability to dynamically alter container environments, enhancing flexibility for computational tasks.

    • +
+

This demo explains the use of overlay file systems with Apptainer containers. Overlay file systems allow modifications to a container’s file system during runtime without altering the base image. This capability is crucial for scenarios where temporary changes are needed for a session or when permissions restrict modifications to the container’s base image.

+
+
+

Prerequisites

+
    +

  • Access to an HPC system with Apptainer installed.

    • +

  • A basic container already available for modification.

    • +

  • Understanding of file system structures and permissions.

    • +
+
+

Overlay file systems in containers are particularly useful in multi-user environments like HPC systems, where users may need to experiment with different configurations without affecting the original container setup. By using overlays, users can ensure that their modifications are temporary and do not impact other users.

+

First, we’ll set up a simple container with a base configuration, and then demonstrate how to use an overlay to modify its contents at runtime.

+
# Example Apptainer definition file for a basic container
+Bootstrap: library
+From: ubuntu:20.04
+
+%post
+    apt-get update && apt-get install -y curl
+    mkdir /app
+    echo "Hello from the base container!" > /app/message.txt
+
+%runscript
+    cat /app/message.txt
+
+
+
# Build the base container
+apptainer build base_container.sif base.def
+
+
+

This block constructs the base_container.sif from the base.def definition file, which includes installing basic utilities and creating an initial message file in the /app directory.

+
# Create a temporary overlay directory on the host
+mkdir -p /home/user/my_overlay/upper /home/user/my_overlay/work
+
+# Example command to run the container with an overlay
+apptainer run --overlay /home/user/my_overlay/upper:/home/user/my_overlay/work:rw base_container.sif
+
+
+

This command runs base_container.sif with an overlay file system. The overlay consists of an upper directory (/home/user/my_overlay/upper) where changes are written, and a work directory (/home/user/my_overlay/work) that is used by the overlay file system to manage these changes.

+

Inside the container, you can modify /app/message.txt or add new files. These changes will appear in the upper directory on the host, demonstrating how overlays allow for runtime modifications without altering the original container image.

+
+

Summary

+

In this tutorial, you’ve learned how to use overlay file systems with Apptainer to dynamically modify container contents at runtime. This technique is invaluable for testing, development, and computational experiments in HPC environments, allowing users to tailor their environments temporarily without impacting the stability and integrity of the base container. This flexibility greatly enhances the usability and adaptability of containerized applications in research and production settings.

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

© Copyright 2024-, The contributors.

+
+ + Built with Sphinx using a + theme + provided by Read the Docs. + + +
+
+
+
+
+ + + + \ No newline at end of file diff --git a/branch/maikens_comments/quick-reference/index.html b/branch/maikens_comments/quick-reference/index.html new file mode 100644 index 0000000..172b704 --- /dev/null +++ b/branch/maikens_comments/quick-reference/index.html @@ -0,0 +1,138 @@ + + + + + + + Quick Reference — Container on HPC with Apptainer documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Quick Reference

+
+ + +
+
+
+ +
+ +
+

© Copyright 2024-, The contributors.

+
+ + Built with Sphinx using a + theme + provided by Read the Docs. + + +
+
+
+
+
+ + + + \ No newline at end of file diff --git a/branch/maikens_comments/readonlydirs/index.html b/branch/maikens_comments/readonlydirs/index.html new file mode 100644 index 0000000..4360cba --- /dev/null +++ b/branch/maikens_comments/readonlydirs/index.html @@ -0,0 +1,188 @@ + + + + + + + Container Security Features — Container on HPC with Apptainer documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Container Security Features

+
+

Objectives

+
    +

  • Understand Apptainer’s security model and its implications for HPC environments.

    • +

  • Learn how to bind host directories to a container as read-only to prevent unauthorized changes.

    • +

  • Develop the ability to securely configure containers to protect sensitive data and maintain system integrity.

    • +
+

This demo explores the security features of Apptainer, with a focus on how to bind host directories as read-only within a container. Apptainer’s ability to integrate securely into HPC systems makes it an invaluable tool for managing containerized applications in a multi-user environment. By making directories read-only, you can prevent unintended or malicious modifications to the host system from within the container, thus enhancing the security and stability of your computational infrastructure.

+
+
+

Prerequisites

+
    +

  • Access to an HPC system with Apptainer installed.

    • +

  • Basic knowledge of Linux filesystem permissions and container security concerns.

    • +
+
+

Containers can significantly streamline the deployment and management of applications, but they also introduce new security challenges. Apptainer’s security features, such as read-only bindings, are designed to mitigate these risks by strictly controlling how containers interact with the host filesystem.

+

In this demo, we will create a container that includes tools for inspecting its environment, and then demonstrate the security implications of read-only host directory bindings.

+

First, we will prepare a simple environment inside the container that attempts to write to a bound directory, showing the effect of the read-only property.

+
# Create an example host directory and a simple text file
+mkdir /home/user/example_dir
+echo "This is a host file" > /home/user/example_dir/hostfile.txt
+
+
+
# Example Apptainer definition file with security settings
+Bootstrap: library
+From: ubuntu:20.04
+
+%post
+    apt-get update && apt-get install -y nano
+
+%runscript
+    echo "Trying to modify the host file from within the container..."
+    nano /home/user/example_dir/hostfile.txt
+
+
+
# Build the container with basic tools
+apptainer build security_container.sif security.def
+
+
+

This block builds the security_container.sif from the definition file security.def, which includes installing Nano, a simple text editor, to demonstrate file editing within the container.

+
# Run the container with a read-only bind to the host directory
+apptainer exec --bind /home/user/example_dir:/home/user/example_dir:ro security_container.sif /bin/bash
+
+
+

This command runs the container and binds the /home/user/example_dir directory from the host as read-only inside the container. When you try to modify hostfile.txt using Nano from within the container, you will see that the system prevents any changes, illustrating the effectiveness of read-only bindings for protecting host resources.

+
+

Summary

+

In this tutorial, you’ve explored key security features of Apptainer, focusing on read-only bindings of host directories. This technique is crucial for preventing unauthorized changes to the host filesystem from within containers, thereby safeguarding the integrity of both the host and the containerized applications. By implementing these security measures, you can enhance the overall resilience and stability of your HPC infrastructure against both unintentional errors and malicious attacks.

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

© Copyright 2024-, The contributors.

+
+ + Built with Sphinx using a + theme + provided by Read the Docs. + + +
+
+
+
+
+ + + + \ No newline at end of file diff --git a/branch/maikens_comments/resources/index.html b/branch/maikens_comments/resources/index.html new file mode 100644 index 0000000..99cc32d --- /dev/null +++ b/branch/maikens_comments/resources/index.html @@ -0,0 +1,194 @@ + + + + + + + Resource Limits — Container on HPC with Apptainer documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Resource Limits

+
+

Objectives

+
    +

  • Understand the importance of managing resource usage within containerized environments on a shared HPC cluster.

    • +

  • Learn to set specific CPU and memory limits on an Apptainer container.

    • +

  • Develop skills to optimize container performance while preventing resource contention among users.

    • +
+

This demo demonstrates how to set resource limits on an Apptainer container, which is essential in a shared HPC environment to ensure fair usage and prevent any single user or job from monopolizing system resources. Managing these limits helps maintain system stability and improves overall cluster performance, especially during peak usage times.

+
+
+

Prerequisites

+
    +

  • Access to an HPC system with Apptainer installed.

    • +

  • Basic understanding of system resources like CPU cores and memory.

    • +

  • Permissions to run resource-limited jobs on the HPC cluster.

    • +
+
+

Resource limits on containers are crucial in multi-user environments where careful resource management is needed to avoid performance degradation. This tutorial will show you how to configure these settings, which can help in running multiple containerized applications concurrently without impacting each other’s performance.

+

First, we’ll set up a simple Apptainer definition file that runs a resource-intensive task, and then apply CPU and memory limits to this container.

+
# Example Apptainer definition file for a resource-intensive task
+Bootstrap: library
+From: ubuntu:20.04
+
+%post
+    apt-get update && apt-get install -y stress
+
+%runscript
+    echo "Starting stress test..."
+    stress --cpu 8 --io 4 --vm 2 --vm-bytes 256M --timeout 30s
+
+
+
# Build the container for the stress test
+apptainer build stress_container.sif stress.def
+
+
+

This block builds the stress_container.sif from the stress.def file. It includes the stress tool, which is used to generate a controlled load on the system’s resources to demonstrate the effects of CPU and memory limits.

+
# Run the container with specific CPU and memory limits
+apptainer exec --apply-cgroups /path/to/cgroup_settings.json stress_container.sif
+
+
+

This command runs the stress_container.sif container with resource limits specified in a cgroups configuration file. This file (cgroup_settings.json) should contain JSON-formatted settings that define the CPU and memory limits for the container, like the following:

+
{
+    "cpu": {
+        "shares": 512
+    },
+    "memory": {
+        "limit_in_bytes": "500M"
+    }
+}
+
+
+

These settings restrict the container to using only a fraction of available CPU resources (shares: 512) and limit its memory usage to 500 MB. Adjust these values based on your cluster’s policies and the specific requirements of your workload.

+
+

Summary

+

In this tutorial, you’ve learned how to set resource limits for an Apptainer container using cgroups. This approach is vital for managing resource allocation on shared HPC clusters, ensuring that all users and applications can operate effectively without resource contention. By implementing these limits, you can optimize the performance and reliability of containerized applications in a shared environment.

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

© Copyright 2024-, The contributors.

+
+ + Built with Sphinx using a + theme + provided by Read the Docs. + + +
+
+
+
+
+ + + + \ No newline at end of file diff --git a/branch/maikens_comments/search/index.html b/branch/maikens_comments/search/index.html new file mode 100644 index 0000000..f8a7ab6 --- /dev/null +++ b/branch/maikens_comments/search/index.html @@ -0,0 +1,155 @@ + + + + + + Search — Container on HPC with Apptainer documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
    • +
  • Search
    • +
  • +
    • +
+
+
+
+
+ + + + +
+ +
+ +
+
+
+ +
+ +
+

© Copyright 2024-, The contributors.

+
+ + Built with Sphinx using a + theme + provided by Read the Docs. + + +
+
+
+
+
+ + + + + + + + + \ No newline at end of file diff --git a/branch/maikens_comments/searchindex.js b/branch/maikens_comments/searchindex.js new file mode 100644 index 0000000..39b41cc --- /dev/null +++ b/branch/maikens_comments/searchindex.js @@ -0,0 +1 @@ +Search.setIndex({"docnames": ["advanced_recipe", "apptainer_gpus", "basics_running_containers", "binding_folders", "building_images", "conda", "container_images", "debugging", "env_scripts", "first_build", "gpus", "index", "inspecting", "instructor-guide", "intro_and_motivation", "mpi_demo", "networking", "overlay", "quick-reference", "readonlydirs", "resources", "services_apps", "storage", "template", "time_travel", "tips_tricks", "verify_installation", "webapp", "workflow"], "filenames": ["advanced_recipe.rst", "apptainer_gpus.rst", "basics_running_containers.rst", "binding_folders.rst", "building_images.rst", "conda.rst", "container_images.rst", "debugging.rst", "env_scripts.rst", "first_build.rst", "gpus.rst", "index.rst", "inspecting.rst", "instructor-guide.rst", "intro_and_motivation.rst", "mpi_demo.rst", "networking.rst", "overlay.rst", "quick-reference.rst", "readonlydirs.rst", "resources.rst", "services_apps.rst", "storage.rst", "template.rst", "time_travel.rst", "tips_tricks.rst", "verify_installation.rst", "webapp.rst", "workflow.rst"], "titles": ["Advanced Container Recipes", "Using GPUs with Apptainer", "Basics of running containers", "Binding folders into your container", "Building Apptainer images", "Reproducibility with Python", "Intro to container images", "Debugging Containers", "Environment Variables and Scripts", "Building Your First Container", "Running containers that use GPUs", "Containers on HPC with Apptainer", "Inspecting Containers", "Instructor\u2019s guide", "Intro to containers (on HPC)", "Running Parallel Jobs", "Networking in Containers", "Overlay File Systems", "Quick Reference", "Container Security Features", "Resource Limits", "Services and apps", "Persistent Storage", "Lesson name", "Time Travelling with Containers", "Tips, tricks and frequently asked questions", "Verify Apptainer Installation", "Running Web Applications", "Workflow Integration"], "terms": {"understand": [0, 1, 5, 7, 8, 9, 11, 12, 14, 15, 16, 17, 19, 20, 22, 24, 26, 27, 28], "complex": [0, 2, 4, 7, 12, 14, 15, 16, 26, 28], "build": [0, 1, 2, 5, 6, 7, 8, 11, 12, 15, 16, 17, 19, 20, 21, 22, 24, 25, 28], "scientif": [0, 1, 5, 9, 15, 24, 26, 28], "softwar": [0, 4, 5, 7, 8, 9, 14, 15, 24, 26], "stack": [0, 5], "within": [0, 1, 2, 5, 7, 8, 12, 15, 16, 17, 19, 20, 22, 24, 27], "learn": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 14, 15, 16, 17, 19, 20, 22, 23, 24, 26, 27, 28], "construct": [0, 1, 6, 7, 9, 11, 17, 24, 27], "detail": [0, 12, 23], "apptain": [0, 3, 5, 7, 8, 9, 10, 12, 15, 16, 17, 19, 20, 21, 22, 24, 25, 27, 28], "definit": [0, 1, 5, 6, 7, 8, 9, 12, 15, 16, 17, 19, 20, 21, 22, 24, 25, 26, 27, 28], "file": [0, 1, 2, 3, 5, 6, 7, 8, 9, 12, 14, 15, 16, 19, 20, 21, 22, 24, 25, 26, 27, 28], "encapsul": [0, 5, 7, 15, 22, 24, 28], "comprehens": [0, 2, 4], "environ": [0, 1, 3, 5, 7, 9, 12, 14, 15, 16, 17, 19, 20, 21, 22, 24, 26, 27, 28], "develop": [0, 1, 5, 7, 8, 12, 17, 19, 20, 22, 24, 25, 27, 28], "profici": 0, "craft": 0, "ensur": [0, 1, 5, 8, 9, 12, 15, 16, 17, 20, 22, 24, 26, 27], "reproduc": [0, 6, 8, 9, 12, 14, 15, 24, 27, 28], "consist": [0, 5, 6, 8, 9, 15, 17, 27, 28], "across": [0, 5, 6, 8, 9, 15, 22, 27, 28], "differ": [0, 3, 5, 6, 7, 8, 9, 11, 14, 15, 17, 23, 25, 26, 27, 28], "hpc": [0, 1, 4, 5, 7, 8, 9, 12, 15, 16, 17, 19, 20, 22, 24, 26, 27, 28], "system": [0, 1, 3, 4, 5, 6, 7, 8, 9, 10, 12, 14, 15, 16, 19, 20, 22, 24, 26, 27, 28], "thi": [0, 1, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 14, 15, 16, 17, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28], "demo": [0, 1, 5, 7, 8, 9, 11, 12, 15, 16, 17, 19, 20, 22, 23, 24, 26, 27, 28], "walk": 0, "you": [0, 1, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 14, 15, 16, 17, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28], "through": [0, 1, 6, 8, 9, 15, 26], "process": [0, 1, 9, 14, 15, 26, 28], "creat": [0, 1, 2, 5, 6, 8, 9, 14, 15, 16, 17, 19, 21, 22, 24, 26, 27, 28], "us": [0, 2, 3, 5, 6, 7, 8, 9, 11, 12, 15, 17, 19, 20, 21, 22, 24, 25, 26, 27, 28], "aim": 0, "robust": [0, 22], "These": [0, 4, 8, 12, 14, 17, 20, 21, 24], "often": [0, 2, 4, 5, 6, 14, 21, 24, 25], "requir": [0, 1, 5, 9, 16, 20, 21, 22, 24, 25], "multipl": [0, 2, 4, 6, 14, 20, 21], "intric": 0, "link": [0, 4, 23], "tool": [0, 1, 6, 7, 9, 11, 14, 16, 19, 20, 24, 26], "librari": [0, 1, 4, 5, 7, 8, 9, 10, 12, 14, 15, 16, 17, 19, 20, 22, 24, 27, 28], "must": [0, 10, 11], "correctli": [0, 8, 12, 26], "configur": [0, 1, 8, 12, 16, 17, 19, 20, 22, 24, 27], "work": [0, 3, 6, 9, 10, 11, 17, 24, 26, 27], "togeth": [0, 11], "seamlessli": [0, 8, 15], "access": [0, 1, 4, 5, 7, 8, 10, 11, 12, 15, 16, 17, 19, 20, 22, 24, 25, 27, 28], "an": [0, 1, 3, 5, 6, 7, 8, 9, 10, 11, 12, 14, 15, 16, 17, 19, 20, 21, 22, 24, 26, 27, 28], "instal": [0, 1, 2, 5, 6, 7, 8, 9, 10, 11, 12, 14, 15, 16, 17, 19, 20, 22, 24, 27, 28], "basic": [0, 1, 4, 5, 7, 8, 9, 11, 14, 15, 16, 17, 19, 20, 22, 24, 27, 28], "intermedi": 0, "knowledg": [0, 5, 9, 12, 15, 16, 19, 22, 27, 28], "linux": [0, 2, 6, 14, 19, 22, 24, 28], "shell": [0, 3, 4, 5, 7, 8, 9, 16, 26, 28], "script": [0, 2, 4, 12, 15, 21, 22, 24, 28], "depend": [0, 7, 9, 11, 12, 15, 22, 25, 28], "manag": [0, 4, 5, 8, 12, 14, 16, 17, 19, 20, 22, 24, 26, 28], "comput": [0, 1, 5, 8, 9, 10, 11, 12, 14, 15, 16, 17, 19, 26, 27, 28], "can": [0, 1, 3, 4, 5, 6, 7, 8, 9, 10, 11, 14, 15, 16, 17, 19, 20, 21, 22, 23, 24, 25, 26, 28], "challeng": [0, 1, 19], "due": [0, 7, 16], "need": [0, 3, 5, 6, 8, 9, 10, 11, 12, 14, 16, 17, 20, 21, 22, 23, 24], "specif": [0, 2, 5, 8, 9, 14, 20, 21, 24], "By": [0, 1, 3, 4, 5, 7, 8, 15, 16, 17, 19, 20, 22, 24, 28], "research": [0, 1, 5, 12, 17, 22, 24], "make": [0, 1, 2, 5, 9, 10, 11, 14, 19, 21, 26, 27, 28], "them": [0, 3, 4, 9, 14, 21, 25], "portabl": [0, 5, 6, 9, 14, 15, 28], "i": [0, 1, 2, 3, 5, 6, 7, 8, 9, 10, 12, 15, 16, 17, 19, 20, 21, 22, 23, 24, 26, 27, 28], "particularli": [0, 1, 7, 15, 16, 17, 24, 27, 28], "import": [0, 4, 7, 10, 12, 20, 22, 26, 27, 28], "where": [0, 1, 4, 5, 6, 7, 8, 11, 12, 15, 17, 20, 22, 24, 26, 27, 28], "precis": [0, 12], "control": [0, 8, 12, 14, 15, 19, 20], "over": [0, 5, 12, 15, 27], "version": [0, 2, 4, 5, 9, 12, 24, 26], "set": [0, 1, 2, 3, 5, 7, 8, 12, 13, 15, 16, 17, 19, 20, 21, 22, 23, 24, 26, 27, 28], "crucial": [0, 1, 5, 7, 9, 12, 17, 19, 20, 22, 24, 26], "valid": [0, 24], "experiment": 0, "result": [0, 5, 15, 22, 24, 28], "first": [0, 1, 4, 5, 7, 8, 11, 12, 15, 16, 17, 19, 20, 22, 23, 24, 26, 27], "we": [0, 1, 2, 4, 5, 6, 7, 8, 9, 10, 11, 12, 14, 17, 19, 20, 21, 22, 24, 27], "ll": [0, 2, 3, 4, 5, 7, 10, 11, 14, 16, 17, 20, 21, 24, 27], "outlin": 0, "includ": [0, 1, 4, 5, 6, 7, 8, 12, 14, 15, 16, 17, 19, 20, 22, 23, 24, 27, 28], "typic": [0, 2, 5, 6, 9, 22, 24, 28], "setup": [0, 1, 4, 5, 6, 7, 12, 17, 21, 22, 24, 27, 28], "bioinformat": 0, "analysi": 0, "featur": [0, 2, 4, 14, 26], "like": [0, 2, 4, 5, 6, 7, 14, 17, 20, 21], "blast": 0, "python": [0, 2, 4, 10, 14, 27, 28], "r": [0, 24, 25], "exampl": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 14, 15, 17, 19, 20, 22, 24, 25, 27, 28], "bootstrap": [0, 1, 4, 5, 7, 8, 9, 12, 15, 16, 17, 19, 20, 21, 22, 24, 25, 27, 28], "from": [0, 1, 3, 5, 6, 7, 8, 9, 12, 14, 15, 16, 17, 19, 20, 21, 22, 24, 25, 27, 28], "ubuntu": [0, 7, 8, 9, 12, 15, 16, 17, 19, 20, 22, 24, 27, 28], "20": [0, 7, 8, 9, 11, 12, 15, 16, 17, 19, 20, 22, 27, 28], "04": [0, 7, 8, 9, 12, 15, 16, 17, 19, 20, 22, 24, 27, 28], "post": [0, 1, 4, 5, 7, 8, 9, 12, 15, 16, 17, 19, 20, 22, 24, 25, 27, 28], "apt": [0, 1, 7, 8, 9, 12, 15, 16, 17, 19, 20, 22, 24, 27, 28], "get": [0, 1, 2, 4, 7, 8, 9, 10, 12, 15, 16, 17, 19, 20, 22, 24, 27, 28], "updat": [0, 1, 7, 8, 9, 12, 15, 16, 17, 19, 20, 22, 24, 27, 28], "y": [0, 1, 5, 7, 8, 9, 12, 15, 16, 17, 19, 20, 22, 24, 27, 28], "wget": [0, 24], "essenti": [0, 1, 5, 7, 8, 9, 12, 15, 16, 20, 22, 24, 26, 27, 28], "python3": [0, 7, 27, 28], "pip": [0, 4, 7, 27, 28], "base": [0, 1, 2, 4, 6, 8, 9, 11, 14, 17, 20, 24], "pip3": [0, 7, 27, 28], "numpi": [0, 4, 5, 28], "scipi": [0, 5, 28], "panda": 0, "biopython": 0, "ftp": 0, "ncbi": 0, "nlm": 0, "nih": 0, "gov": 0, "execut": [0, 1, 2, 4, 8, 9, 12, 15, 16, 28], "latest": [0, 4], "2": [0, 2, 3, 4, 6, 9, 10, 14, 20, 21, 23, 24, 26], "10": [0, 2, 11, 28], "1": [0, 2, 3, 4, 6, 9, 10, 12, 14, 21, 23, 26], "x64": 0, "tar": [0, 6], "gz": 0, "xzf": 0, "c": [0, 4, 5, 9, 10, 15, 16, 21, 28], "usr": [0, 1, 8, 9, 15, 24, 25, 28], "local": [0, 1, 8, 15, 25, 28], "bin": [0, 1, 2, 5, 8, 15, 16, 19, 24, 28], "strip": 0, "compon": [0, 8, 9, 16, 28], "echo": [0, 1, 2, 4, 5, 7, 8, 12, 15, 16, 17, 19, 20, 22, 24, 27, 28], "export": [0, 1, 4, 5, 7, 8, 9, 12, 15, 21, 26, 27, 28], "path": [0, 1, 3, 5, 8, 9, 15, 20, 23, 25, 28], "bashrc": [0, 5], "runscript": [0, 1, 2, 4, 5, 7, 8, 9, 12, 15, 16, 17, 19, 20, 22, 24, 27, 28], "readi": [0, 12], "avail": [0, 2, 4, 12, 14, 15, 17, 20, 26], "exec": [0, 1, 2, 3, 4, 5, 10, 15, 16, 19, 20, 21, 25], "bash": [0, 1, 2, 5, 16, 19, 26], "bioinfo_contain": 0, "sif": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 12, 15, 16, 17, 19, 20, 21, 22, 24, 25, 27, 28], "bioinfo": 0, "def": [0, 1, 4, 5, 6, 7, 8, 9, 12, 15, 16, 17, 19, 20, 22, 24, 27, 28], "block": [0, 1, 4, 5, 7, 8, 12, 15, 16, 17, 19, 20, 21, 22, 24, 25, 27, 28], "It": [0, 4, 6, 8, 11, 14, 15, 20], "critic": [0, 8, 9, 12, 15, 16, 22, 26, 27, 28], "sequenc": 0, "suit": 0, "commonli": [0, 25], "data": [0, 1, 3, 4, 5, 19, 21, 22, 27], "visual": [0, 5], "run": [0, 1, 3, 5, 6, 7, 8, 9, 11, 12, 14, 16, 17, 19, 20, 21, 22, 24, 25, 28], "provid": [0, 4, 5, 6, 12, 14, 15, 16, 27], "interact": [0, 5, 7, 12, 16, 19, 22, 24], "command": [0, 1, 3, 5, 6, 7, 8, 9, 10, 12, 14, 15, 16, 17, 19, 20, 21, 22, 24, 26, 27, 28], "allow": [0, 1, 5, 7, 8, 11, 15, 16, 17, 21, 22, 24, 27, 28], "user": [0, 5, 6, 14, 15, 17, 19, 20, 21, 22, 24, 25, 28], "perform": [0, 1, 7, 8, 9, 20, 26, 28], "analys": 0, "thei": [0, 6, 8, 14, 19, 21, 26, 27], "were": [0, 6, 24], "nativ": 0, "ideal": 0, "all": [0, 4, 6, 9, 11, 12, 14, 15, 20, 21, 26, 27], "regardless": [0, 5, 15, 24], "host": [0, 1, 3, 7, 14, 15, 16, 17, 19, 22, 24, 27, 28], "In": [0, 1, 4, 5, 6, 7, 8, 9, 12, 14, 15, 16, 17, 19, 20, 21, 22, 24, 26, 27, 28], "tutori": [0, 1, 5, 7, 8, 12, 16, 17, 19, 20, 22, 24, 27, 28], "ve": [0, 5, 7, 8, 9, 11, 12, 16, 17, 19, 20, 22, 24, 27, 28], "how": [0, 1, 3, 4, 5, 7, 8, 9, 10, 11, 12, 15, 16, 17, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28], "skill": [0, 1, 5, 7, 8, 9, 12, 15, 20, 26, 27], "invalu": [0, 5, 12, 17, 19], "who": [0, 4, 5, 25], "experi": [0, 5, 11, 17, 23], "IT": 0, "administr": [0, 7, 8, 27], "task": [0, 1, 7, 15, 17, 20, 26], "maintain": [0, 14, 15, 19, 20, 22, 24, 27, 28], "util": [1, 9, 16, 17, 26], "resourc": [1, 9, 11, 14, 15, 16, 19], "contain": [1, 5, 8, 15, 17, 20, 22, 26, 27, 28], "applic": [1, 2, 4, 6, 7, 8, 9, 14, 15, 16, 17, 19, 20, 21, 22, 25, 26, 28], "integr": [1, 15, 16, 17, 19, 22], "container": [1, 4, 7, 8, 9, 12, 15, 16, 17, 19, 20, 22, 24, 26, 28], "workflow": [1, 5, 11, 14, 26], "guid": [1, 9, 15, 26], "which": [1, 2, 5, 6, 7, 9, 11, 12, 15, 16, 17, 19, 20, 22, 24, 25, 26, 27, 28], "high": [1, 9, 23, 26, 28], "signific": [1, 9], "power": [1, 5], "deep": [1, 11], "larg": [1, 15], "scale": [1, 15], "dramat": 1, "increas": 1, "effici": [1, 15, 27], "speed": 1, "nvidia": [1, 15], "principl": 1, "ar": [1, 2, 3, 4, 5, 6, 8, 9, 11, 12, 14, 15, 16, 17, 19, 20, 22, 24, 25, 26, 27, 28], "acceler": [1, 15], "workload": [1, 20], "those": [1, 16, 25, 26], "involv": [1, 4, 26, 28], "parallel": 1, "howev": 1, "present": [1, 14, 23], "uniqu": 1, "proper": [1, 16], "driver": [1, 10], "show": [1, 8, 9, 11, 12, 19, 20, 22, 27], "overcom": 1, "har": 1, "full": [1, 4, 9], "potenti": [1, 9], "up": [1, 4, 5, 6, 7, 8, 11, 13, 15, 16, 17, 20, 21, 22, 23, 24, 25, 27, 28], "capabl": [1, 9, 12, 16, 17, 22, 24, 26, 27, 28], "nvcr": 1, "io": [1, 4, 10, 20], "cuda": [1, 10], "11": 1, "0": [1, 2, 4, 7, 12, 14, 15, 24, 27, 28], "sampl": [1, 12, 28], "test": [1, 4, 12, 16, 17, 20, 21], "cd": 1, "1_util": 1, "devicequeri": 1, "ld_library_path": 1, "lib": [1, 21, 24], "lib64": 1, "devic": [1, 10], "queri": 1, "enabl": [1, 9, 10, 22], "cuda_contain": 1, "imag": [1, 2, 3, 5, 9, 10, 11, 17, 21, 25], "": [1, 2, 4, 6, 7, 8, 9, 11, 12, 14, 15, 16, 17, 19, 20, 21, 24, 25, 26, 27, 28], "registri": [1, 6], "have": [1, 2, 3, 4, 6, 9, 10, 11, 14, 15, 21, 23, 26], "necessari": [1, 8, 9, 12, 15, 16, 26], "support": [1, 10, 14, 24, 27], "nv": [1, 10, 15], "flag": [1, 2, 4, 10], "valuabl": [1, 22], "leverag": [1, 5, 9, 15, 22, 27], "your": [1, 5, 7, 8, 10, 11, 14, 15, 16, 19, 20, 21, 22, 25, 26], "enhanc": [1, 5, 12, 15, 16, 17, 19, 22, 28], "function": [1, 12, 16, 24, 26, 27], "wide": [1, 9], "rang": [1, 9], "scenario": [1, 17, 27], "what": [2, 4, 6, 9, 11, 13, 23], "method": [2, 3, 4, 27], "termin": [2, 4, 9], "cover": [2, 6, 11], "individu": [2, 6, 21], "section": [2, 4, 8, 16, 21], "below": [2, 6], "sometim": [2, 6, 7], "hard": 2, "pars": 2, "line": [2, 7, 8, 22, 24, 28], "A": [2, 6, 7, 11, 12, 14, 17, 23], "ha": [2, 4, 6, 12, 14, 21, 25], "start": [2, 4, 5, 6, 7, 9, 14, 20, 21, 24, 27, 28], "becaus": [2, 7], "client": [2, 6, 21], "subcommand": 2, "pull": [2, 10], "etc": [2, 4, 8, 12, 24], "tell": [2, 4], "want": [2, 3, 4, 14, 21], "after": [2, 4, 21, 22], "name": [2, 4, 5, 6, 9, 14, 21], "At": 2, "end": [2, 4], "might": [2, 3, 6, 8, 11, 14, 21, 23], "addit": [2, 3, 6, 10, 14], "ignor": 2, "digest": 2, "itself": [2, 7, 10], "For": [2, 4, 6, 9, 14, 21], "legibl": 2, "reason": 2, "mani": [2, 11, 14, 27], "lesson": [2, 26], "highlight": [2, 27], "format": [2, 4, 6, 9, 11, 14, 20], "figur": [2, 3, 4, 6, 10, 14, 21], "list": [2, 4, 21, 24], "see": [2, 4, 6, 8, 10, 14, 19, 21, 25], "cli": 2, "refer": [2, 14], "page": [2, 4, 11, 21, 23], "let": [2, 4, 6, 10, 11, 14, 16, 21, 28], "docker": [2, 4, 9, 10, 14, 21, 25], "hub": [2, 4, 6], "now": [2, 4, 6, 10, 11, 21, 23], "just": [2, 4, 6, 9, 11, 14], "consid": [2, 6, 14], "follow": [2, 3, 4, 6, 9, 10, 11, 14, 20, 21, 25, 26], "talk": [2, 11, 14], "about": [2, 14], "later": [2, 11, 14], "enough": [2, 4, 23, 26], "know": [2, 11, 23, 26], "mean": [2, 3, 4, 6, 14, 27], "some": [2, 3, 4, 6, 9, 11, 14], "creator": 2, "default": [2, 3, 4, 22, 24], "when": [2, 3, 4, 6, 8, 9, 10, 12, 14, 16, 17, 19, 21, 22, 24], "so": [2, 3, 4, 11, 23, 26], "call": [2, 3, 4, 6, 14, 21], "entri": [2, 21], "specifi": [2, 4, 6, 9, 20, 21, 24], "onli": [2, 3, 4, 6, 10, 19, 20, 25, 26, 28], "sourc": [2, 5, 25], "trust": 2, "interpret": 2, "3": [2, 4, 5, 6, 14, 23, 24], "12": 2, "main": [2, 15], "apr": 2, "2024": 2, "14": 2, "35": 2, "18": 2, "gcc": 2, "type": [2, 4, 11, 23], "help": [2, 3, 4, 11, 16, 20, 21, 26], "copyright": 2, "credit": 2, "licens": 2, "more": [2, 4, 6, 11, 21, 26, 28], "inform": [2, 4, 6, 21, 26], "should": [2, 3, 4, 10, 20, 21], "simpl": [2, 7, 8, 12, 15, 17, 19, 20, 22, 27], "syntax": 2, "seem": 2, "self": [2, 14], "evid": 2, "case": [2, 9, 21, 26], "give": [2, 3, 4, 6, 10, 14], "variou": [2, 4, 5, 8, 12, 14, 16, 26, 28], "part": [2, 9, 14, 16], "The": [2, 3, 4, 6, 8, 9, 10, 12, 14, 15, 17, 21, 24, 26, 27], "debian": 2, "distribut": [2, 16], "check": [2, 4, 7, 12, 16, 21, 26], "cat": [2, 17, 22], "debian_vers": 2, "With": [2, 14], "print": [2, 4, 6, 10], "content": [2, 4, 9, 12, 17, 20], "5": 2, "4": [2, 4, 15, 16, 20], "my_imag": 2, "my_program": 2, "arg1": 2, "arg2": 2, "launch": [3, 4, 5, 6, 7, 10, 14, 16, 21], "program": [3, 6, 7, 10, 14, 15, 24, 25], "same": [3, 14, 27], "structur": [3, 17], "machin": [3, 14, 24], "bring": 3, "world": [3, 15], "insid": [3, 4, 7, 8, 10, 14, 15, 16, 17, 19, 22, 25, 27], "done": [3, 6, 10, 21], "via": [3, 4, 6, 14, 16], "mount": [3, 10, 21, 22, 25], "map": [3, 16, 27], "home": [3, 4, 14, 17, 19, 22, 25, 27, 28], "cwd": 3, "current": [3, 24], "directori": [3, 4, 17, 19, 21, 22, 25, 26, 28], "tmp": 3, "few": 3, "other": [3, 4, 6, 8, 11, 14, 16, 17, 20, 21, 26, 28], "bound": [3, 19, 22, 25], "If": [3, 4, 10, 11, 14, 25], "do": [3, 4, 6, 9, 11, 13, 14, 17, 21, 23, 26], "extra": 3, "argument": [3, 4, 21], "re": [3, 4, 14, 21, 25], "would": [3, 4, 14, 21, 23], "scratch": [3, 4], "l": [3, 21], "well": [3, 6, 10, 11, 14, 21], "also": [3, 4, 14, 19, 21, 25, 26, 28], "place": [3, 6], "especi": [3, 8, 12, 14, 16, 20, 22], "code": [3, 4, 8, 10, 21, 26], "expect": [3, 8], "outsid": [3, 4, 7, 14, 25, 27], "delet": 3, "complet": [3, 14], "manual": [3, 16, 25], "session": [4, 17], "discuss": [4, 11, 23], "wai": [4, 6, 14, 27], "alreadi": [4, 12, 17], "seen": 4, "could": 4, "altern": 4, "url": 4, "registry_url": 4, "user_namespac": 4, "image_nam": 4, "image_tag": 4, "here": [4, 14], "compat": [4, 24, 26], "There": [4, 14], "quai": 4, "github": 4, "read": [4, 11, 19, 22], "repositori": [4, 13, 25], "download": 4, "ani": [4, 14, 15, 19, 20, 22, 25, 26, 27], "Then": [4, 7, 8, 15, 23], "squash": [4, 6], "one": [4, 6, 7, 14, 21, 25], "store": [4, 6, 14, 22, 26], "folder": [4, 11, 21, 25, 26], "apptainer_cachedir": [4, 26], "cach": 4, "out": [4, 11], "quota": 4, "big": [4, 23], "mkdir": [4, 17, 19, 21, 22, 26, 27, 28], "apptainer_cach": 4, "pwd": 4, "advic": 4, "select": 4, "locat": [4, 21], "filesystem": [4, 6, 14, 19, 22, 25, 28], "space": [4, 6, 26], "instanc": [4, 21], "area": [4, 6], "statu": 4, "clean": [4, 25], "sai": 4, "summat": 4, "py": [4, 7, 27], "argpars": 4, "parser": 4, "argumentpars": 4, "add_argu": 4, "number": [4, 26], "sum": 4, "int": [4, 15], "narg": 4, "arg": 4, "parse_arg": 4, "len": 4, "f": 4, "wa": [4, 6, 14], "els": 4, "did": [4, 21], "me": 4, "opt": [4, 5, 25], "got": 4, "copi": [4, 6, 25], "ran": [4, 21], "built": [4, 6, 12], "my_contain": [4, 25], "my_container_definit": 4, "two": 4, "send": 4, "being": [4, 7], "produc": 4, "output": [4, 8, 9, 28], "analog": [4, 6], "much": [4, 11], "interfac": [4, 7, 14, 15, 16, 27], "convert": 4, "singl": [4, 6, 9, 20, 21], "than": [4, 6, 14, 21], "onc": [4, 21, 25], "procedur": 4, "modifi": [4, 6, 7, 8, 16, 17, 19, 21, 22, 25], "our": [4, 21], "packag": [4, 5, 24, 25], "__version__": 4, "26": 4, "step": [4, 6, 9, 26], "state": [4, 7, 22], "fakeroot": 4, "look": [4, 6, 21], "realiti": 4, "normal": [4, 6, 14], "sudo": [4, 24], "instruct": [4, 7, 14], "written": [4, 17], "non": [4, 24], "usual": [4, 11, 14], "remov": [4, 25], "front": 4, "secret": 4, "password": [4, 21], "sensit": [4, 19], "anybodi": 4, "while": [4, 8, 9, 11, 16, 20], "appli": [4, 9, 20], "opportun": 4, "languag": [4, 21, 24], "veri": [4, 21], "common": [4, 6, 13, 14, 27], "lc_all": [4, 9, 21], "lang": [4, 21], "valu": [4, 8, 20], "o": [4, 6, 14, 15], "getenv": 4, "rebuild": 4, "myvar": 4, "ye": 4, "apptainerenv_myvar": 4, "myvalu": 4, "env": [4, 5, 8], "info": [4, 14], "plan": [4, 21], "share": [4, 14, 20], "peopl": [4, 11, 23], "keep": [4, 6], "tab": 4, "label": [4, 12], "mark": 4, "add": [4, 17], "author": [4, 12], "coderefineri": 4, "v0": 4, "descript": [4, 12, 23], "messag": [4, 15, 17], "someth": [4, 6, 11], "inspect": [4, 7, 16, 19], "org": [4, 24], "schema": 4, "arch": 4, "amd64": [4, 24], "date": [4, 9, 11], "thursday_25_april_2024_21": 4, "45": 4, "51_eest": 4, "usag": [4, 11, 14, 20, 21], "singular": [4, 6], "deffil": 4, "id": [4, 14], "group": [4, 14], "posit": 4, "none": [4, 14], "32176": 4, "32385": 4, "34957": 4, "json": [4, 20], "gener": [4, 20, 22], "35407": 4, "36864": 4, "394522624": 4, "squashf": [4, 6], "previou": 4, "dump": 4, "plenti": 4, "great": 4, "callabl": 4, "servic": [4, 11, 27], "stop": [4, 21, 22], "custom": [4, 8], "role": [5, 8], "conda": 5, "platform": [5, 28], "demonstr": [5, 7, 8, 12, 15, 17, 19, 20, 22, 27], "creation": [5, 6], "popular": [5, 15, 28], "simplifi": [5, 28], "technologi": [5, 9, 14, 17, 22, 27, 28], "cornerston": 5, "time": [5, 20, 23], "defin": [5, 8, 9, 14, 16, 20, 21], "continuumio": 5, "miniconda3": 5, "n": [5, 15], "scienv": 5, "8": [5, 20], "matplotlib": [5, 28], "ipython": 5, "activ": 5, "conda_contain": 5, "miniconda": 5, "sever": 5, "initi": [5, 17], "approach": [5, 20, 25], "underli": [5, 7, 9, 15], "hardwar": [5, 7], "significantli": [5, 7, 15, 19], "reliabl": [5, 7, 15, 20, 22, 28], "oper": [6, 7, 8, 9, 12, 14, 16, 20, 24, 26, 28], "come": [6, 11, 24], "analogi": 6, "paint": 6, "saint": 6, "jerom": 6, "wilder": 6, "leonardo": 6, "da": 6, "vinci": 6, "abov": [6, 9], "unfinish": 6, "natur": [6, 14], "background": [6, 21], "panel": 6, "touch": 6, "e": [6, 9, 13, 25, 26], "g": [6, 9, 13, 25, 26], "hand": [6, 9], "sketch": 6, "lion": 6, "most": [6, 11, 14, 21], "color": 6, "top": 6, "left": [6, 11], "thing": [6, 11], "gather": 6, "layer": [6, 7], "hidden": 6, "underneath": 6, "happen": [6, 9, 23], "hide": [6, 25], "preced": 6, "practic": [6, 7, 11, 22, 26, 28], "overwrit": 6, "behaviour": 6, "fashion": 6, "doe": [6, 11, 12, 14, 25], "its": [6, 7, 12, 14, 17, 19, 20, 26, 28], "modif": [6, 17, 19], "new": [6, 17, 19, 21], "unless": [6, 16], "last": 6, "tag": 6, "human": 6, "readabl": 6, "publish": 6, "sent": 6, "dockerfil": 6, "true": [6, 7, 10], "reduc": [6, 14, 28], "network": [6, 14, 27], "capac": 6, "transfer": 6, "fetch": [6, 21], "organ": [6, 25], "each": [6, 11, 20, 21], "tri": 6, "find": [6, 24], "go": [6, 11, 23], "until": [6, 11, 21], "light": 6, "bounc": 6, "off": 6, "bit": [6, 11], "metadata": [6, 12], "instead": [6, 14, 21, 25], "write": [6, 19, 22], "piec": 6, "paper": [6, 14], "replic": 6, "topmost": 6, "visibl": [6, 10, 25], "unchang": 6, "upsid": 6, "downsid": 6, "One": 6, "easili": [6, 9, 14], "easier": 6, "archiv": 6, "track": 6, "take": [6, 14], "longer": [6, 24], "cannot": [6, 9], "runtim": [6, 8, 10, 14, 15, 17], "cc0": 6, "wikimedia": [6, 14], "abl": 7, "enter": 7, "purpos": [7, 12], "troubleshoot": [7, 12, 26], "directli": [7, 24, 28], "resolv": 7, "issu": 7, "mai": [7, 15, 17, 26], "appar": 7, "misbehav": 7, "prepar": [7, 12, 19], "familiar": [7, 8, 24, 27], "obscur": 7, "problem": [7, 15], "standard": [7, 25, 28], "isol": [7, 9, 16, 27], "conduc": 7, "debugg": 7, "gdb": 7, "vim": [7, 8, 12], "flask": [7, 27], "app": [7, 11, 17, 27], "__name__": [7, 27], "rout": [7, 27], "hello": [7, 8, 15, 17, 22, 27], "rais": 7, "except": 7, "intent": 7, "error": [7, 19], "__main__": [7, 27], "port": [7, 14, 16, 24, 27], "5000": [7, 27], "flask_app": [7, 27], "debug_contain": 7, "handl": [7, 16], "live": 7, "log": [7, 8, 22], "diagnos": 7, "behav": [7, 8], "master": [7, 24], "improv": [7, 11, 20], "behavior": 8, "abil": [8, 12, 15, 16, 17, 19, 22, 24, 28], "environment": [8, 15], "manipul": 8, "deploy": [8, 16, 19, 22, 28], "without": [8, 9, 14, 17, 20], "chang": [8, 14, 17, 19, 22], "dictat": 8, "paramet": 8, "databas": [8, 21, 22], "connect": [8, 16, 21, 24], "level": [8, 11, 23], "under": [8, 11, 25], "condit": 8, "affect": [8, 15, 17, 26], "my_var": 8, "profil": 8, "sbin": 8, "another_var": 8, "anoth": [8, 22, 23, 25], "env_contain": 8, "perman": 8, "action": 8, "final": 8, "dure": [8, 17, 20], "phase": 8, "influenc": 8, "vital": [8, 20], "scalabl": [8, 9, 15, 27, 28], "manner": 8, "effect": [8, 9, 12, 16, 19, 20, 22, 24, 27], "matter": 8, "deploi": [8, 27], "concept": [9, 16, 17], "infrastructur": [9, 15, 19], "foundat": [9, 14, 26], "No": [9, 26], "sure": [9, 26], "cluster": [9, 11, 14, 15, 16, 20, 26], "admin": 9, "certain": [9, 21], "realli": [9, 23], "tight": 9, "compil": [9, 15, 16, 25], "sake": 9, "assum": 9, "three": 9, "fortun": 9, "cowsai": 9, "lolcat": 9, "strict": 9, "yourself": 9, "root": [9, 25], "privileg": [9, 14], "game": 9, "save": 9, "mydefinit": 9, "next": [9, 11], "mycontain": 9, "correct": 10, "toolkit": 10, "rocm": 10, "framework": [10, 16], "As": 10, "pytorch": 10, "cuda12": 10, "cudnn8": 10, "torch": 10, "is_avail": 10, "calcul": 10, "rocm6": 10, "1_ubuntu22": 10, "04_py3": 10, "10_pytorch_2": 10, "given": 11, "yet": 11, "known": 11, "registr": 11, "open": [11, 14], "though": 11, "had": 11, "actual": [11, 14], "tip": 11, "aren": 11, "t": [11, 23], "either": [11, 25], "advanc": [11, 26], "won": 11, "topic": 11, "everyth": [11, 24], "possibl": [11, 14, 21], "right": 11, "design": [11, 14, 19], "firesid": 11, "chat": 11, "expert": 11, "combin": 11, "along": [11, 23], "independ": 11, "engag": 11, "interest": 11, "don": [11, 23], "sens": 11, "pick": 11, "anywai": 11, "technic": 11, "option": [11, 15, 24], "materi": [11, 23], "deeper": 11, "slurm": 11, "dai": [11, 13], "still": [11, 14, 25], "15": 11, "min": 11, "intro": 11, "break": 11, "25": 11, "bind": [11, 19, 21, 22, 25, 28], "05": 11, "gpu": [11, 15], "trick": 11, "frequent": 11, "ask": 11, "question": 11, "verifi": [11, 12, 16], "larger": [11, 16, 21], "extrem": 11, "direct": 11, "learner": 11, "persona": 11, "taken": 11, "mostli": 11, "pice": 11, "wonder": 11, "fit": 11, "whole": 11, "care": [11, 20], "real": 11, "wouldn": 11, "mind": 11, "scope": 11, "stuff": 11, "long": [11, 24], "spend": 11, "too": 11, "mental": 11, "effort": 11, "probabl": 11, "watch": 11, "rest": 11, "back": [11, 25], "been": [11, 12, 21, 25], "fine": 11, "think": [11, 14], "life": 11, "even": [11, 22, 24], "better": 11, "attend": 11, "passiv": 11, "collabor": 11, "between": [11, 14, 22, 23], "instructor": 11, "view": 12, "assess": 12, "examin": 12, "aspect": [12, 14], "secur": [12, 16, 27], "transpar": 12, "debug": 12, "complianc": 12, "exist": [12, 28], "reveal": 12, "test_var": 12, "variabl": [12, 21, 26], "my_app_vers": 12, "john": 12, "inspect_contain": 12, "intern": 12, "paramount": [12, 22], "befor": [13, 26], "logic": 14, "term": [14, 24], "behind": 14, "ship": 14, "habitat": 14, "analogu": 14, "idea": 14, "barrier": 14, "easi": 14, "storag": 14, "chapter": 14, "launcher": 14, "podman": 14, "kubernet": 14, "worri": 14, "namespac": 14, "implement": [14, 15, 19, 20], "separ": 14, "identifi": 14, "pid": 14, "virtual": 14, "commun": [14, 16], "limit": 14, "cpu": [14, 20], "ram": 14, "cgroup": [14, 20], "meant": 14, "superus": 14, "exact": 14, "necessarili": 14, "both": [14, 15, 16, 19], "own": [14, 21, 25], "word": 14, "colleagu": 14, "finish": 14, "amount": 14, "put": [14, 25], "project": 14, "lawrenc": 14, "berkelei": 14, "nation": 14, "laboratori": 14, "2015": 14, "2018": 14, "compani": 14, "sylab": 14, "found": [14, 21], "commerci": 14, "site": [14, 24], "2021": 14, "join": 14, "renam": 14, "fork": 14, "singulartyc": 14, "wikipedia": 14, "articl": 14, "singularityc": 14, "bellarena": 14, "rossograph": 14, "cc": 14, "BY": 14, "sa": 14, "mpi": 15, "acquir": [15, 16], "pass": 15, "solv": 15, "permiss": [15, 16, 17, 19, 20, 22, 25], "benefici": [15, 16, 28], "mpich": 15, "mpi_test": 15, "h": 15, "argc": 15, "char": 15, "argv": 15, "mpi_init": 15, "rank": 15, "mpi_comm_rank": 15, "mpi_comm_world": 15, "printf": 15, "d": 15, "mpi_fin": 15, "return": [15, 27], "mpicc": 15, "mpi_hello": 15, "mpirun": 15, "np": [15, 28], "mpi_contain": 15, "four": 15, "benefit": [15, 24, 28], "successfulli": 15, "impact": [16, 17, 20], "focus": [16, 19], "extern": [16, 27], "align": 16, "polici": [16, 20], "ip": [16, 24], "address": [16, 24], "dn": 16, "complic": [16, 21], "properli": [16, 26], "iproute2": 16, "net": 16, "inetutil": 16, "ping": 16, "ifconfig": 16, "googl": 16, "com": [16, 24], "resolut": 16, "internet": 16, "net_contain": 16, "traffic": 16, "broader": 16, "dynam": 17, "alter": 17, "flexibl": [17, 22], "explain": [17, 22], "temporari": [17, 26], "restrict": [17, 20], "multi": [17, 19, 20, 25], "origin": [17, 24], "curl": 17, "txt": [17, 19, 22], "base_contain": 17, "p": [17, 22, 24, 28], "my_overlai": 17, "upper": 17, "rw": 17, "appear": 17, "techniqu": [17, 19, 24], "tailor": 17, "temporarili": 17, "stabil": [17, 19, 20], "greatli": 17, "usabl": [17, 22], "adapt": 17, "product": 17, "model": 19, "implic": 19, "prevent": [19, 20, 22], "unauthor": 19, "protect": 19, "explor": [19, 26, 27], "focu": 19, "unintend": 19, "malici": 19, "thu": [19, 24, 25], "concern": 19, "streamlin": [19, 28], "introduc": 19, "mitig": 19, "risk": 19, "strictli": 19, "attempt": 19, "properti": 19, "text": [19, 23], "example_dir": 19, "hostfil": 19, "nano": [19, 22], "try": [19, 25], "security_contain": 19, "editor": 19, "edit": 19, "ro": 19, "illustr": [19, 24, 28], "kei": [19, 27], "therebi": 19, "safeguard": 19, "measur": 19, "overal": [19, 20, 23], "resili": 19, "against": [19, 21], "unintent": 19, "attack": 19, "memori": 20, "optim": 20, "among": 20, "fair": 20, "job": 20, "monopol": 20, "peak": 20, "core": [20, 24], "avoid": 20, "degrad": 20, "concurr": 20, "intens": 20, "stress": 20, "vm": 20, "byte": 20, "256m": 20, "timeout": 20, "30": 20, "stress_contain": 20, "load": 20, "cgroup_set": 20, "512": 20, "limit_in_byt": 20, "500m": 20, "fraction": 20, "500": 20, "mb": 20, "adjust": 20, "alloc": 20, "subset": 21, "dataset": 21, "kind": 21, "quit": [21, 25], "entrypoint": 21, "server": [21, 24, 27], "sh": 21, "postgr": 21, "16": [21, 24], "startscript": 21, "postgres_us": 21, "pguser": 21, "postgres_password": 21, "pgpassword": 21, "pghost": 21, "hostnam": 21, "pgport": 21, "19200": 21, "var": 21, "runfil": 21, "postgres_data": 21, "postgres_run": 21, "postgres_contain": 21, "postgres_serv": 21, "apprun": 21, "psql": 21, "apphelp": 21, "beforehand": 21, "coupl": 21, "u": 21, "document": [21, 26], "newli": 21, "notic": 21, "note": 21, "again": 21, "made": [21, 22], "shut": 21, "down": 21, "ongo": 22, "lost": 22, "restart": 22, "continu": 22, "destroi": 22, "To": 22, "preserv": [22, 24], "serv": 22, "persistent_data": 22, "ad": 22, "data_contain": 22, "displai": [22, 26], "point": [23, 26], "goe": 23, "divid": 23, "exercis": 23, "possibli": 23, "ok": 23, "sentenc": 23, "summar": 23, "suitabl": 23, "preview": 23, "paragraph": 23, "motiv": 23, "why": 23, "excit": 23, "pictur": 23, "Not": 23, "someon": 23, "legaci": 24, "older": 24, "rstudio": 24, "past": 24, "studi": 24, "evolv": 24, "99": 24, "modern": 24, "gdebi": 24, "http": 24, "download2": 24, "trusti": 24, "903": 24, "deb": 24, "repo": 24, "cran": 24, "rprofil": 24, "rserver": 24, "daemon": 24, "old": 24, "rstudio_contain": 24, "8787": 24, "ag": 24, "remain": 24, "year": 24, "wrong": 25, "assumpt": 25, "caus": 25, "headach": 25, "bad": 25, "hierarchi": 25, "explan": 25, "persist": 25, "overlai": 25, "decid": 25, "rememb": 25, "everyon": 25, "cp": 25, "src": 25, "unnecessari": 25, "header": 25, "stage": 25, "gain": 26, "whether": 26, "move": 26, "recip": 26, "confirm": 26, "subsequ": 26, "relat": 26, "presenc": 26, "teach": 26, "determin": 26, "proce": [26, 28], "confid": 26, "onlin": 26, "search": 26, "cachedir": 26, "tmpdir": 26, "disk": 26, "free": 26, "environemnt": 26, "subfold": 26, "wrkdir": 26, "apptainercach": 26, "apptainertemp": 26, "apptainer_tmpdir": 26, "field": 27, "scienc": 27, "lightweight": 27, "numer": 27, "node": 27, "webapp": 27, "request": 27, "webapp_contain": 27, "listen": 27, "context": 27, "hpc_workflow": 28, "pyplot": 28, "plt": 28, "x": 28, "linspac": 28, "100": 28, "sin": 28, "plot": 28, "savefig": 28, "png": 28, "sci_app_contain": 28, "sci_app": 28, "inconsist": 28}, "objects": {}, "objtypes": {}, "objnames": {}, "titleterms": {"advanc": 0, "contain": [0, 2, 3, 4, 6, 7, 9, 10, 11, 12, 14, 16, 19, 21, 24, 25], "recip": 0, "object": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 12, 14, 15, 16, 17, 19, 20, 22, 23, 24, 26, 27, 28], "prerequisit": [0, 1, 5, 7, 8, 9, 11, 12, 15, 16, 17, 19, 20, 22, 23, 24, 26, 27, 28], "summari": [0, 1, 5, 7, 8, 9, 12, 15, 16, 17, 19, 20, 22, 23, 24, 26, 27, 28], "us": [1, 4, 10, 14], "gpu": [1, 10], "apptain": [1, 2, 4, 6, 11, 14, 26], "basic": 2, "run": [2, 4, 10, 15, 27], "differ": 2, "wai": 2, "you": [2, 13], "can": 2, "your": [2, 3, 4, 9], "how": [2, 14], "read": 2, "command": [2, 4], "obtain": 2, "from": [2, 4], "registri": [2, 4], "expect": [2, 4, 10], "result": [2, 4, 10], "launch": 2, "an": [2, 4, 25], "interact": 2, "shell": 2, "singl": 2, "program": 2, "review": 2, "thi": [2, 13], "session": 2, "kei": [2, 3, 4, 6, 10, 14, 21], "point": [2, 3, 4, 6, 10, 14, 21], "rememb": [2, 3, 4, 6, 10, 14, 21], "bind": 3, "folder": 3, "build": [4, 9], "imag": [4, 6, 14], "pull": 4, "exist": [4, 25], "handl": 4, "temporari": 4, "layer": 4, "need": [4, 25], "process": 4, "creat": 4, "specif": 4, "file": [4, 17], "addit": 4, "instal": [4, 25, 26], "dure": 4, "creation": 4, "i": [4, 11, 14, 25], "done": 4, "fake": 4, "root": 4, "user": 4, "set": 4, "environ": [4, 8, 25], "variabl": [4, 8], "ad": 4, "document": 4, "examin": 4, "definit": 4, "option": 4, "reproduc": 5, "python": 5, "intro": [6, 14], "tradit": [6, 14], "docker": 6, "etc": 6, "sourc": [6, 14], "debug": 7, "script": 8, "first": 9, "simpl": 9, "test": 9, "nvidia": 10, "": [10, 13], "amd": 10, "hpc": [11, 14], "cours": 11, "instanc": 11, "mai": 11, "2024": 11, "The": 11, "lesson": [11, 13, 23], "extra": 11, "exercis": [11, 13], "who": 11, "about": 11, "see": [11, 23], "also": [11, 23], "credit": 11, "inspect": 12, "instructor": 13, "guid": 13, "why": 13, "we": 13, "teach": 13, "intend": [13, 14], "learn": 13, "outcom": 13, "time": [13, 24], "prepar": 13, "other": 13, "practic": 13, "aspect": 13, "interest": 13, "question": [13, 25], "might": 13, "get": 13, "typic": 13, "pitfal": 13, "what": [14, 21], "even": 14, "more": 14, "technic": 14, "inform": 14, "work": 14, "case": 14, "v": 14, "singular": 14, "parallel": 15, "job": 15, "network": 16, "overlai": 17, "system": 17, "quick": 18, "refer": 18, "secur": 19, "featur": 19, "resourc": 20, "limit": 20, "servic": 21, "app": 21, "ar": 21, "exampl": 21, "postgresql": 21, "persist": 22, "storag": 22, "name": 23, "section": 23, "travel": 24, "tip": 25, "trick": 25, "frequent": 25, "ask": 25, "where": 25, "should": 25, "my": 25, "softwar": 25, "have": 25, "sensit": 25, "code": 25, "would": 25, "want": 25, "do": 25, "small": 25, "modif": 25, "start": 25, "becom": 25, "huge": 25, "conda": 25, "verifi": 26, "configur": 26, "solut": 26, "web": 27, "applic": 27, "workflow": 28, "integr": 28}, "envversion": {"sphinx.domains.c": 2, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 8, "sphinx.domains.index": 1, "sphinx.domains.javascript": 2, "sphinx.domains.math": 2, "sphinx.domains.python": 3, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx": 57}, "alltitles": {"Advanced Container Recipes": [[0, "advanced-container-recipes"]], "Objectives": [[0, "objectives-0"], [1, "objectives-0"], [2, "objectives-0"], [3, "objectives-0"], [4, "objectives-0"], [5, "objectives-0"], [6, "objectives-0"], [7, "objectives-0"], [8, "objectives-0"], [9, "objectives-0"], [10, "objectives-0"], [12, "objectives-0"], [14, "objectives-0"], [15, "objectives-0"], [16, "objectives-0"], [17, "objectives-0"], [19, "objectives-0"], [20, "objectives-0"], [22, "objectives-0"], [23, "objectives-0"], [24, "objectives-0"], [26, "objectives-0"], [27, "objectives-0"], [28, "objectives-0"]], "Prerequisites": [[0, "prerequisites-0"], [1, "prerequisites-0"], [5, "prerequisites-0"], [7, "prerequisites-0"], [8, "prerequisites-0"], [9, "prerequisites-0"], [11, "prerequisites-0"], [12, "prerequisites-0"], [15, "prerequisites-0"], [16, "prerequisites-0"], [17, "prerequisites-0"], [19, "prerequisites-0"], [20, "prerequisites-0"], [22, "prerequisites-0"], [23, "prerequisites-0"], [24, "prerequisites-0"], [26, "prerequisites-0"], [27, "prerequisites-0"], [28, "prerequisites-0"]], "Summary": [[0, "summary"], [1, "summary"], [5, "summary"], [7, "summary"], [8, "summary"], [9, "summary"], [12, "summary"], [15, "summary"], [16, "summary"], [17, "summary"], [19, "summary"], [20, "summary"], [22, "summary"], [23, "summary"], [24, "summary"], [26, "summary"], [27, "summary"], [28, "summary"]], "Using GPUs with Apptainer": [[1, "using-gpus-with-apptainer"]], "Basics of running containers": [[2, "basics-of-running-containers"]], "Different ways you can run your containers": [[2, "different-ways-you-can-run-your-containers"]], "How to read Apptainer commands?": [[2, "how-to-read-apptainer-commands"]], "Obtaining a container from container registry": [[2, "obtaining-a-container-from-container-registry"]], "Running the container": [[2, "running-the-container"]], "Expected result": [[2, null], [2, null], [2, null], [4, null], [4, null], [4, null], [4, null], [4, null], [4, null], [10, null], [10, null]], "Launching an interactive shell in the container": [[2, "launching-an-interactive-shell-in-the-container"]], "Running a single program from the container": [[2, "running-a-single-program-from-the-container"]], "Review of this session": [[2, "review-of-this-session"]], "Key points to remember": [[2, null], [3, null], [4, null], [4, null], [6, null], [6, null], [10, null], [10, null], [14, null], [14, null], [21, null]], "Binding folders into your container": [[3, "binding-folders-into-your-container"]], "Building Apptainer images": [[4, "building-apptainer-images"]], "Pulling an existing image from a container registry": [[4, "pulling-an-existing-image-from-a-container-registry"]], "Handling temporary layers needed by the build process": [[4, "handling-temporary-layers-needed-by-the-build-process"]], "Creating an image using a specification file": [[4, "creating-an-image-using-a-specification-file"]], "Running additional installation commands during image creation": [[4, "running-additional-installation-commands-during-image-creation"]], "Image building is done as a fake root-user": [[4, null]], "Setting environment variables in the image": [[4, "setting-environment-variables-in-the-image"]], "Adding documentation to your image": [[4, "adding-documentation-to-your-image"]], "Examining the container": [[4, "examining-the-container"]], "Additional definition file options": [[4, "additional-definition-file-options"]], "Reproducibility with Python": [[5, "reproducibility-with-python"]], "Intro to container images": [[6, "intro-to-container-images"]], "Traditional container images (Docker etc.)": [[6, "traditional-container-images-docker-etc"]], "Apptainer container images": [[6, "apptainer-container-images"]], "Image sources": [[6, "image-sources"], [14, "image-sources"]], "Debugging Containers": [[7, "debugging-containers"]], "Environment Variables and Scripts": [[8, "environment-variables-and-scripts"]], "Building Your First Container": [[9, "building-your-first-container"]], "Build a simple container and test it": [[9, "exercise-0"]], "Running containers that use GPUs": [[10, "running-containers-that-use-gpus"]], "Using NVIDIA\u2019s GPUs": [[10, "using-nvidia-s-gpus"]], "Using AMD\u2019s GPUs": [[10, "using-amd-s-gpus"]], "Containers on HPC with Apptainer": [[11, "containers-on-hpc-with-apptainer"]], "Course instance in May 2024": [[11, null]], "The lesson": [[11, null]], "Extras": [[11, null]], "Exercises": [[11, null]], "Who is the course for?": [[11, "who-is-the-course-for"]], "About the course": [[11, "about-the-course"]], "See also": [[11, "see-also"], [23, "see-also"]], "Credits": [[11, "credits"]], "Inspecting Containers": [[12, "inspecting-containers"]], "Instructor\u2019s guide": [[13, "instructor-s-guide"]], "Why we teach this lesson": [[13, "why-we-teach-this-lesson"]], "Intended learning outcomes": [[13, "intended-learning-outcomes"]], "Timing": [[13, "timing"]], "Preparing exercises": [[13, "preparing-exercises"]], "Other practical aspects": [[13, "other-practical-aspects"]], "Interesting questions you might get": [[13, "interesting-questions-you-might-get"]], "Typical pitfalls": [[13, "typical-pitfalls"]], "Intro to containers (on HPC)": [[14, "intro-to-containers-on-hpc"]], "What even is a container?": [[14, "what-even-is-a-container"]], "More technical information on how traditional containers work": [[14, null]], "What is the intended use case of Apptainer?": [[14, "what-is-the-intended-use-case-of-apptainer"]], "Apptainer vs. Singularity": [[14, "apptainer-vs-singularity"]], "Running Parallel Jobs": [[15, "running-parallel-jobs"]], "Networking in Containers": [[16, "networking-in-containers"]], "Overlay File Systems": [[17, "overlay-file-systems"]], "Quick Reference": [[18, "quick-reference"]], "Container Security Features": [[19, "container-security-features"]], "Resource Limits": [[20, "resource-limits"]], "Services and apps": [[21, "services-and-apps"]], "What are services?": [[21, "what-are-services"]], "What are apps?": [[21, "what-are-apps"]], "Example: PostgreSQL container": [[21, "example-postgresql-container"]], "Persistent Storage": [[22, "persistent-storage"]], "Lesson name": [[23, "lesson-name"]], "Section": [[23, "section"]], "Time Travelling with Containers": [[24, "time-travelling-with-containers"]], "Tips, tricks and frequently asked questions": [[25, "tips-tricks-and-frequently-asked-questions"]], "Where should I install my software?": [[25, "where-should-i-install-my-software"]], "I have sensitive code that I would need to have in the container": [[25, "i-have-sensitive-code-that-i-would-need-to-have-in-the-container"]], "I have an existing container, but I would want to do small modifications to the code": [[25, "i-have-an-existing-container-but-i-would-want-to-do-small-modifications-to-the-code"]], "My container starts to become huge": [[25, "my-container-starts-to-become-huge"]], "I would want to install my conda environment in a container": [[25, "i-would-want-to-install-my-conda-environment-in-a-container"]], "Verify Apptainer Installation": [[26, "verify-apptainer-installation"]], "Configure Apptainer": [[26, "exercise-0"]], "Solution": [[26, "solution-0"]], "Running Web Applications": [[27, "running-web-applications"]], "Workflow Integration": [[28, "workflow-integration"]]}, "indexentries": {}}) \ No newline at end of file diff --git a/branch/maikens_comments/services_apps/index.html b/branch/maikens_comments/services_apps/index.html new file mode 100644 index 0000000..5d6535d --- /dev/null +++ b/branch/maikens_comments/services_apps/index.html @@ -0,0 +1,308 @@ + + + + + + + Services and apps — Container on HPC with Apptainer documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Services and apps

+
+

What are services?

+

You can use Apptainer to launch services that run in +the background. Service might be, for example, a database +application that your code uses to fetch subsets from a +larger dataset.

+

Creating containers for these kinds of services can +often be quite complicated as they might need specific +folders to be created or specific environment variables +to be set.

+
+
+

What are apps?

+

When we’re launching a complicated services or making +containers with more than one application we might also +want to specify multiple run scripts and entrypoints to +the container.

+

This can be done in Apptainer containers by specifying +multiple apps in the definition file.

+
+
+

Example: PostgreSQL container

+

The following example uses a +PostgreSQL image to +set up a PostgreSQL server. Launching the server requires +that certain directory mounts and environment variables are set.

+

These have been found by looking at the +docker-entrypoint.sh-script +that would start the image when using Docker.

+

In the case of PostgreSQL, we’ll most likely +want to use the PostgreSQL client to modify our databases. +We can do this by specifying an app for it.

+

Let’s look at the definition file:

+
Bootstrap: docker
+From: postgres:16
+
+%environment
+    export LC_ALL=C
+    export LANG=C
+    export LANGUAGE=C
+
+%startscript
+    export POSTGRES_USER=$PGUSER
+    export POSTGRES_PASSWORD=$PGPASSWORD
+    export PGHOST=$HOSTNAME
+    export PGPORT=${PGPORT:-19200}
+
+    # Run the entry script for PostgreSQL Docker image
+    exec docker-entrypoint.sh postgres "$@"
+
+%help
+
+    This is a postgres container.
+
+    The following data locations need to be mounted into the container:
+
+    - Data location for the postgres: /var/lib/postgresql/data
+    - Location for the runfiles for postgres: /var/run/postgresql
+
+    The start script needs the following arguments:
+
+    - postgres user name
+    - postgres user password
+
+    Usage:
+
+        mkdir postgres_data
+        mkdir postgres_run
+
+        export PGUSER=postgres_user
+        export PGPASSWORD=postgres_password
+        apptainer instance start --bind postgres_data:/var/lib/postgresql/data --bind postgres_run:/var/run/postgresql postgres_container.sif postgres_server
+
+        apptainer instance list
+
+%apprun psql
+    export POSTGRES_USER=$PGUSER
+    export POSTGRES_PASSWORD=$PGPASSWORD
+    export PGHOST=$HOSTNAME
+    export PGPORT=${PGPORT:-19200}
+    exec psql "$@"
+
+%apphelp psql
+    Run psql-client in image
+
+    PostgreSQL instance needs to be started beforehand
+
+    Usage:
+
+        export PGUSER=postgres_user
+        export PGPASSWORD=postgres_password
+        apptainer run --app psql instance://postgres_server -c 'create database test;'
+        apptainer run --app psql instance://postgres_server -c '\l'
+
+
+

The definition file has couple of new blocks:

+
    +

  • %startscript: This block defines what commands will be run when we start up the service.

    • +

  • %apprun: This block allows us to specify individual applications in our image. In this +case we have an application called psql for the PostgreSQL client. This block specifies +how we run this specific application.

    • +

  • %apphelp: Each app in a container can have it’s own help section as well as other +setup sections. See documentation for all possibilities.

    • +
+

For more information on how to specify multiple apps in a container, see +this documentation page.

+

After building the image we can start the database with:

+
$ mkdir postgres_data
+$ mkdir postgres_run
+$ export POSTGRES_USER=postgres_user
+$ export POSTGRES_PASSWORD=postgres_password
+$ apptainer instance start --bind postgres_data:/var/lib/postgresql/data --bind postgres_run:/var/run/postgresql postgres_container.sif postgres_server
+
+
+
+../_images/instance_example.png +
+

Figure 1: Starting container as an instance

+
+
+

Now that we have started the instance we can check that the instance is running with:

+
$ apptainer instance list
+
+
+

Let’s use the psql-app that we have specified. We can use it to make a +connection to the server and to create a new database. Let’s also list the +newly created database:

+
$ export PGUSER=postgres_user
+$ export PGPASSWORD=postgres_password
+$ apptainer run --app psql instance://postgres_server -c 'create database test;'
+$ apptainer run --app psql instance://postgres_server -c '\l'
+
+
+
+../_images/app_run_example.png +
+

Figure 2: Running an app from a container

+
+
+

You’ll notice that we did not start a new container. Instead ran the application in +the running instance by specifying instance://postgres_server instead of the +.sif-image. You’ll also note that we did not need to specify the bind-mounts +again: once the instance is started, bind mounts are made and they are there until +the instance is stopped.

+

We can then shut down the server with:

+
$ apptainer instance stop postgres_server
+
+
+
+

Key points to remember

+
    +

  • You can start containers as instances.

    • +

  • You can use %startscript-block to specify how an instance should start.

    • +

  • You can create multiple apps in a container with %app*-blocks

    • +

  • Started instances with bind mounts have them until instance is stopped. +This is very useful if you plan on running multiple commands against a +single container.

    • +
+
+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/branch/maikens_comments/storage/index.html b/branch/maikens_comments/storage/index.html new file mode 100644 index 0000000..0166c44 --- /dev/null +++ b/branch/maikens_comments/storage/index.html @@ -0,0 +1,187 @@ + + + + + + + Persistent Storage — Container on HPC with Apptainer documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Persistent Storage

+
+

Objectives

+
    +

  • Understand the importance of persistent storage in containerized environments.

    • +

  • Learn how to configure persistent storage for an Apptainer container to maintain data state between runs.

    • +

  • Develop the ability to effectively manage data persistence, enhancing the usability and flexibility of container deployments in HPC settings.

    • +
+

This demo explains how to set up and use persistent storage with Apptainer containers. Persistent storage is crucial for applications that need to maintain data or state between runs, such as databases or applications that generate ongoing logs or results. This capability is essential for ensuring data is not lost when a container is stopped or restarted, which is especially important in research environments where data integrity and continuity are paramount.

+
+
+

Prerequisites

+
    +

  • Access to an HPC system with Apptainer installed.

    • +

  • Basic knowledge of filesystems and permissions on Linux.

    • +
+
+

Container technology typically encapsulates application environments and dependencies, but by default, any changes made inside the container can be lost when the container is stopped or destroyed. To prevent this, Apptainer allows you to bind host directories to the container, enabling the container to read from and write to persistent storage on the host system.

+

First, we will demonstrate creating a simple application that writes data to a file inside a container, then show how this data can be preserved using a host directory bound to the container.

+
# Create a directory on the host to serve as persistent storage
+mkdir -p /home/user/persistent_data
+
+# Example Apptainer definition file to use persistent storage
+Bootstrap: library
+From: ubuntu:20.04
+
+%post
+    apt-get update && apt-get install -y nano
+    echo "Hello from Apptainer!" > /data/hello.txt
+
+%runscript
+    echo "Modifying the data file..."
+    echo "Another line added to the file." >> /data/hello.txt
+    cat /data/hello.txt
+
+
+
# Build the container that interacts with persistent data
+apptainer build data_container.sif data.def
+
+
+

This block builds the data_container.sif from the data.def file, which includes a simple script to modify and display a data file stored in /data.

+
# Run the container with the persistent storage directory bound
+apptainer run --bind /home/user/persistent_data:/data data_container.sif
+
+
+

This command mounts the /home/user/persistent_data directory from the host to the /data directory inside the container. This setup allows the container to read from and write to the persistent storage, ensuring that changes to the data file are maintained even after the container is stopped.

+
+

Summary

+

In this tutorial, you’ve learned how to configure and use persistent storage with an Apptainer container. This practice is critical for applications that require data continuity, ensuring that valuable research data is not lost across container runs. By leveraging persistent storage, you can enhance the robustness and reliability of your containerized applications within the HPC environment.

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

© Copyright 2024-, The contributors.

+
+ + Built with Sphinx using a + theme + provided by Read the Docs. + + +
+
+
+
+
+ + + + \ No newline at end of file diff --git a/branch/maikens_comments/template/index.html b/branch/maikens_comments/template/index.html new file mode 100644 index 0000000..7ef8e3a --- /dev/null +++ b/branch/maikens_comments/template/index.html @@ -0,0 +1,178 @@ + + + + + + + Lesson name — Container on HPC with Apptainer documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Lesson name

+
+

Objectives

+
    +

  • High-level point 1

    • +

  • High-level point 2

    • +

  • High-level point 3

    • +
+

Description of how the lesson goes: How is it divided between +discussion, demo, type-along, and exercise? How might different +people experience this differently?

+
+
+

Prerequisites

+
    +

  • Prerequisite 1

    • +

  • Prerequisite 2 (possibly including link to how to learn)

    • +
+

What happens if you don’t have the prerequisites: is doing the +lesson as a demo OK? Is there no time to set up now? Can you do +the type-alongs?

+
+

First sentence that summarizes the lesson, suitable for preview text. +A first paragraph really motivating why you would need the material +presented on this page, and why it is exciting. Don’t go into details.

+

Then, another paragraph going into the big picture of what you will do +and how you will do it. Not details, but enough so that someone knows +the overall path.

+
+

Section

+
+
+

Summary

+
+
+

See also

+
    +

  • Link

    • +

  • Link

    • +
+
+
+ + +
+
+
+ +
+ +
+

© Copyright 2024-, The contributors.

+
+ + Built with Sphinx using a + theme + provided by Read the Docs. + + +
+
+
+
+
+ + + + \ No newline at end of file diff --git a/branch/maikens_comments/time_travel/index.html b/branch/maikens_comments/time_travel/index.html new file mode 100644 index 0000000..6168cc8 --- /dev/null +++ b/branch/maikens_comments/time_travel/index.html @@ -0,0 +1,186 @@ + + + + + + + Time Travelling with Containers — Container on HPC with Apptainer documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Time Travelling with Containers

+
+

Objectives

+
    +

  • Understand the benefits of using containers to access and run legacy software versions.

    • +

  • Learn how to install an older version of R and RStudio within an Apptainer container for interactive use.

    • +

  • Develop the ability to manage software versions effectively in a containerized environment, ensuring compatibility and reproducibility.

    • +
+

This demo illustrates how to “time travel” by using containers to install and run older versions of software that are no longer supported or compatible with current operating systems. This is particularly useful in scientific research, where reproducing results from past studies often requires software versions that were used originally.

+
+
+

Prerequisites

+
    +

  • Access to an HPC system with Apptainer installed.

    • +

  • Basic familiarity with the R programming language and Linux command line operations.

    • +
+
+

The ability to work with specific software versions is crucial for ensuring that scientific findings are reproducible. Containers encapsulate software in an environment that includes everything needed to run it, thus preserving functionality even when host systems evolve.

+

First, we’ll create a container that includes R 3.2 and RStudio Server 0.99, which are older versions no longer typically supported on modern systems.

+
# Example Apptainer definition file for R 3.2 and RStudio 0.99
+Bootstrap: library
+From: ubuntu:16.04
+
+%post
+    apt-get update && apt-get install -y sudo gdebi-core
+    wget https://download2.rstudio.org/server/trusty/amd64/rstudio-server-0.99.903-amd64.deb
+    gdebi --non-interactive rstudio-server-0.99.903-amd64.deb
+    apt-get install -y r-base=3.2.*
+    echo 'options(repos = list(CRAN = "http://cran.rstudio.com"))' >> /etc/R/Rprofile.site
+
+%runscript
+    echo "Starting RStudio Server..."
+    /usr/lib/rstudio-server/bin/rserver --server-daemonize=0
+
+
+
# Build the container with old R and RStudio
+apptainer build rstudio_container.sif rstudio.def
+
+
+

This block constructs the rstudio_container.sif from the rstudio.def file, setting up an Ubuntu 16.04 environment with R 3.2 and RStudio Server 0.99. These versions ensure compatibility with older scripts and packages.

+
# Run the container, accessing RStudio Server
+apptainer run -p rstudio_container.sif
+
+
+

This command starts the RStudio Server within the container. You can access RStudio interactively by connecting to the host’s IP address at the specified port (default is 8787), where RStudio Server is configured to run. This setup allows users to interact with an older R environment as if it were installed directly on their machine.

+
+

Summary

+

In this tutorial, you’ve learned how to use Apptainer to create a containerized environment that supports running older versions of R and RStudio. This “time travelling” capability is essential for reproducing past scientific results and maintaining long-term accessibility to software tools, regardless of their age or compatibility with current systems. By mastering these techniques, researchers can ensure their work remains valid and reproducible for years to come.

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

© Copyright 2024-, The contributors.

+
+ + Built with Sphinx using a + theme + provided by Read the Docs. + + +
+
+
+
+
+ + + + \ No newline at end of file diff --git a/branch/maikens_comments/tips_tricks/index.html b/branch/maikens_comments/tips_tricks/index.html new file mode 100644 index 0000000..828cf59 --- /dev/null +++ b/branch/maikens_comments/tips_tricks/index.html @@ -0,0 +1,212 @@ + + + + + + + Tips, tricks and frequently asked questions — Container on HPC with Apptainer documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Tips, tricks and frequently asked questions

+
+

Where should I install my software?

+

Quite often in Docker images software is installed under root-user’s +home folder (/root). This is the wrong approach. Installing software +there with the assumption that the container will be run by root-user +can cause permission headaches.

+

Folders under /home are also bad as that is commonly mounted by Apptainer +and thus the bind mount hides software installed there.

+

You should install manual installations of software to, for example, +/opt or /usr/local. See +Filesystem Hierarchy Standard +for explanation on how different folders are organized.

+
+
+

I have sensitive code that I would need to have in the container

+

Instead of installing your sensitive application to the image +you can instead mount the application directory inside the container.

+

If your program requires compilations or installations, you can +install dependencies into the container image and then install software +in a bound folder or on a +persistent overlay.

+

If you still decide to put sensitive code in your image, +remember that it is visible to everyone who has access to the image.

+
+
+

I have an existing container, but I would want to do small modifications to the code

+

If you want to do you’re own modifications to the code +you can either use +persistent overlays +or you can use the following trick:

+
    +

  1. Copy the code that you want to modify from the container to a folder outside +of the container:

    +
    $ apptainer exec my_container.sif cp -r /path/to/code/src src
+
    +
    +
    2. +

  2. Modify the code outside of the container

    3. +

  3. Bind mount modified code from outside of the container back into the container

    +
    $ apptainer run --bind src:/path/to/code/src my_container.sif
+
    +
    +
    4. +
+
+
+

My container starts to become huge

+

Remember to clean up any unnecessary source code or software in your +%post-block. If your program does not need e.g. development headers +once it has been installed, you can remove them.

+

You can also try +multi-stage builds +where one container is used to build a software, which is then copied +to another container that has only those packages required to run the software.

+
+
+

I would want to install my conda environment in a container

+

See +this repository +for an example definition file that can be used to bootstrap +conda environment into a Apptainer container image.

+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/branch/maikens_comments/verify_installation/index.html b/branch/maikens_comments/verify_installation/index.html new file mode 100644 index 0000000..ec4043b --- /dev/null +++ b/branch/maikens_comments/verify_installation/index.html @@ -0,0 +1,191 @@ + + + + + + + Verify Apptainer Installation — Container on HPC with Apptainer documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Verify Apptainer Installation

+
+

Objectives

+
    +

  • Understand the importance of verifying tool installation on HPC systems.

    • +

  • Learn how to check the installation and version of Apptainer on an HPC cluster.

    • +

  • Gain practical skills in verifying software prerequisites for scientific computing environments.

    • +
+

This demo guides you through the process of verifying whether Apptainer is installed on your HPC cluster and checking its version. This is a critical first step in ensuring that the necessary tools are correctly configured before moving on to more complex containerization tasks. Knowing the version of Apptainer is essential as it may affect compatibility with container recipes or other tools used in your workflows.

+
+
+

Prerequisites

+
    +

  • No prerequisites for following the demo

    • +
+
+

The first step in utilizing containers on any high-performance computing (HPC) cluster involves ensuring that the container management software, in this case, Apptainer, is properly installed. This demo is crucial as it confirms the foundational tool’s availability, which is necessary for all subsequent container-related operations.

+

This demo will not only verify the presence of Apptainer on your system but will also teach you how to check its version. Knowing the installed version is important as it helps in troubleshooting and in ensuring compatibility with various container definitions and configurations used in scientific applications.

+
# Check if Apptainer is installed and determine its version
+apptainer --version
+
+
+

This command checks if Apptainer is installed and displays the version number. This information is useful for understanding which features and functionalities are available to you, as different versions may have different capabilities.

+
+

Summary

+

In this lesson, you learned how to verify the installation of Apptainer on your HPC cluster and how to check its version. This is a foundational skill that ensures you can proceed with confidence in using Apptainer for more advanced tasks in container management.

+
+

Configure Apptainer

+

Explore the online Apptainer documentation and search for the bash environment variables that apptainer uses. +1. Do you have any apptainer variables set in your shell environment? +2. How do you set the variables for the CACHEDIR and TMPDIR so that they are pointing to a disk where you have enough free space? (e.g. your work folder)

+ +
+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/branch/maikens_comments/webapp/index.html b/branch/maikens_comments/webapp/index.html new file mode 100644 index 0000000..e4aaca6 --- /dev/null +++ b/branch/maikens_comments/webapp/index.html @@ -0,0 +1,187 @@ + + + + + + + Running Web Applications — Container on HPC with Apptainer documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Running Web Applications

+
+

Objectives

+
    +

  • Understand how to configure and run web applications within Apptainer containers.

    • +

  • Learn to set up network settings that allow web applications to run effectively inside containers.

    • +

  • Develop skills to leverage container technology for deploying networked applications in an HPC environment.

    • +
+

This demo will show you how to deploy a simple web application inside an Apptainer container, highlighting how to configure network settings to support web services. Running web applications in containers is a common scenario in many fields, including data science and web development, as it allows for scalable, consistent environments that are isolated from the host system.

+
+
+

Prerequisites

+
    +

  • Access to an HPC system with Apptainer installed.

    • +

  • Basic knowledge of web technologies and network configurations.

    • +

  • Familiarity with container networking and security settings.

    • +
+
+

Containers provide a lightweight, efficient means of deploying web applications, ensuring that they run the same way on any system. This is particularly useful in HPC environments where maintaining consistency across numerous nodes is critical. In this demo, you will set up a basic Python web server inside an Apptainer container to explore this functionality.

+

First, we’ll create a container definition file that includes a Python web application.

+
# Example Apptainer definition file for a Python web server
+Bootstrap: library
+From: ubuntu:20.04
+
+%post
+    apt-get update && apt-get install -y python3 python3-pip
+    pip3 install flask
+    mkdir /webapp
+    echo "from flask import Flask, request" > /webapp/app.py
+    echo "app = Flask(__name__)" >> /webapp/app.py
+    echo "@app.route('/', methods=['GET'])" >> /webapp/app.py
+    echo "def home():" >> /webapp/app.py
+    echo "    return 'Hello from Flask inside Apptainer!'" >> /webapp/app.py
+    echo "if __name__ == '__main__':" >> /webapp/app.py
+    echo "    app.run(host='0.0.0.0', port=5000)" >> /webapp/app.py
+
+%environment
+    export FLASK_APP=/webapp/app.py
+
+%runscript
+    echo "Starting the Flask web server..."
+    python3 /webapp/app.py
+
+
+

This block constructs the webapp_container.sif from the webapp.def definition file, which sets up a basic Flask application in the container. The Flask server is configured to listen on all network interfaces at port 5000, allowing external access.

+

This command runs the container with network settings that map port 5000 inside the container to port 5000 on the host. This setup allows you to access the Flask web server from outside the container, demonstrating the container’s network capabilities.

+
+

Summary

+

In this tutorial, you’ve learned how to set up and run a simple web application within an Apptainer container, configuring it to be accessible over a network. This capability is key for deploying scalable, reproducible web services across different computing environments, making it an essential skill for developers and system administrators working in HPC contexts.

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

© Copyright 2024-, The contributors.

+
+ + Built with Sphinx using a + theme + provided by Read the Docs. + + +
+
+
+
+
+ + + + \ No newline at end of file diff --git a/branch/maikens_comments/workflow/index.html b/branch/maikens_comments/workflow/index.html new file mode 100644 index 0000000..48130a6 --- /dev/null +++ b/branch/maikens_comments/workflow/index.html @@ -0,0 +1,186 @@ + + + + + + + Workflow Integration — Container on HPC with Apptainer documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Workflow Integration

+
+

Objectives

+
    +

  • Understand the benefits of integrating container technology into HPC workflows.

    • +

  • Learn to integrate an Apptainer container into an existing workflow on an HPC system.

    • +

  • Develop the ability to streamline and standardize computational workflows using containers.

    • +
+

This demo illustrates how to integrate Apptainer containers into an existing HPC workflow. Containers can encapsulate environments and dependencies, making workflows more reproducible and portable across different computational systems. This integration is particularly beneficial in HPC settings where consistency and scalability are critical.

+
+
+

Prerequisites

+
    +

  • Access to an HPC system with Apptainer installed.

    • +

  • An existing workflow or application that will be containerized.

    • +

  • Basic knowledge of shell scripting and command line operations on Linux.

    • +
+
+

Integrating containers into HPC workflows involves encapsulating the application and its dependencies into a container, which can then be executed consistently across various environments. This process not only simplifies the deployment and management of applications but also enhances their portability and reproducibility.

+

Let’s start by creating an Apptainer definition file that encapsulates a typical scientific application, then proceed to integrate this container into a sample HPC workflow.

+
# Create a directory for the workflow
+mkdir -p /home/user/hpc_workflow
+
+# Example Apptainer definition file for a scientific application
+Bootstrap: library
+From: ubuntu:20.04
+
+%post
+    apt-get update && apt-get install -y python3 python3-pip
+    pip3 install numpy scipy matplotlib
+
+%environment
+    export PATH=/usr/local/bin:$PATH
+
+%runscript
+    echo "Running the scientific application..."
+    python3 -c "import numpy as np; import scipy; import matplotlib.pyplot as plt; x = np.linspace(0, 10, 100); y = np.sin(x); plt.plot(x, y); plt.savefig('/workflow/output/plot.png');"
+
+
+
# Build the container for the scientific application
+apptainer build sci_app_container.sif sci_app.def
+
+
+

This block creates the sci_app_container.sif from the sci_app.def definition file. This container includes Python and popular scientific libraries, setting up an environment capable of running complex scientific computations.

+

This command runs the container and binds a directory from the host system (/home/user/hpc_workflow/output) to the container. This setup allows the container to output results directly to the host filesystem, integrating the containerized application’s output with other components of the HPC workflow.

+
+

Summary

+

In this tutorial, you’ve learned how to integrate an Apptainer container into an existing HPC workflow. By containerizing applications, you standardize the execution environment, reducing inconsistencies and enhancing reproducibility across different computational platforms. This practice is essential for maintaining the integrity and reliability of complex scientific workflows in high-performance computing environments.

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

© Copyright 2024-, The contributors.

+
+ + Built with Sphinx using a + theme + provided by Read the Docs. + + +
+
+
+
+
+ + + + \ No newline at end of file diff --git a/building_images/index.html b/building_images/index.html new file mode 100644 index 0000000..4039548 --- /dev/null +++ b/building_images/index.html @@ -0,0 +1,527 @@ + + + + + + + Building Apptainer images — Container on HPC with Apptainer documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Building Apptainer images

+
+

Objectives

+
    +

  • Learn how you can build container images

    • +
+
+

In this session we’ll discuss various ways you can create Apptainer images.

+
+

Pulling an existing image from a container registry

+

We have already seen how to pull a +Python image from Docker Hub.

+
$ apptainer pull python.sif docker://python
+
+
+

We could have alternatively used the full registry specification URL:

+
$ apptainer pull python.sif docker://docker.io/library/python:latest
+
+
+

The format for these registry specifications is:

+

docker://REGISTRY_URL/USER_NAMESPACE/IMAGE_NAME:IMAGE_TAG

+

Here docker:// means that we use a Docker Hub compatible container +registry. There are other compatible registries such as +quay and +GitHub container registry.

+

You can read the command like this:

+
+../_images/pull_example.png +
+

Figure 1: Pulling an image from a repository

+
+
+
+
+

Handling temporary layers needed by the build process

+

When Apptainer creates a .sif-image it needs to first download any layers +it uses for the building. Then it will squash all of these layers to one +.sif-image.

+

These are stored in a folder specified by an environment variable +APPTAINER_CACHEDIR. By default, Apptainer will use +$HOME/.apptainer/cache. This can result in you running out of quota +during the image creation process if the home folder quota is not big.

+

You can set the cache directory with:

+
$ mkdir apptainer_cache
+$ export APPTAINER_CACHEDIR=$PWD/apptainer_cache
+
+
+

It is adviced to select a location in some filesystem that has enough space available. +For instance a type of “scratch” area on your HPC.

+

You can check the cache status with:

+
$ apptainer cache list
+
+
+

and you can clean the cache with:

+
$ apptainer cache clean
+
+
+

See this page +for more documentation.

+
+
+

Creating an image using a specification file

+

Let’s say we want to create an apptainer image for the following +summation.py-script:

+
import argparse
+
+parser = argparse.ArgumentParser()
+parser.add_argument(
+    "numbers", help="Numbers to sum", type=int, nargs='*'
+)
+args = parser.parse_args()
+
+numbers = args.numbers
+
+if len(numbers) > 1:
+   print(f'Sum of numbers was: {sum(numbers)}')
+else:
+   print('You did not give me any numbers to sum!')
+
+
+

Let’s create a definition file for this image:

+
Bootstrap: docker
+From: python:latest
+
+%files
+    summation.py /opt
+
+%runscript
+    echo "Got arguments: $*"
+    exec python /opt/summation.py "$@"
+
+
+

In this definition file we specify:

+
    +

  1. The bootstrapping method we want to use to build the image.

    2. +

  2. The base image we want to use for bootstrapping.

    3. +

  3. Files we want to copy to the image in the %files-block.

    4. +

  4. Commands we want to run when the image is ran in the %runscript-block.

    5. +
+

Now we can built this image with:

+
$ apptainer build my_container.sif my_container_definition.def
+
+
+
+../_images/build_example.png +
+

Figure 2: Building an image from a definition file

+
+
+

After building the image we can test out the image with:

+
$ apptainer run my_container.sif 1 2
+
+
+

This will run the default set of commands specified in the %runscript block in +the Apptainer definition file. The two arguments we send into the +shell environment of the container, namely the numbers 1 and 2 are used by the +executable in the runscript.

+
+

Expected result

+

Building container should result in a container image +my_container.sif being created.

+

Running the container should produce the following output:

+
$ apptainer run my_container.sif 1 2
+Got arguments: 1 2
+Sum of numbers was: 3
+
+
+
+
+

Key points to remember

+
    +

  • Bootstrap settings are analogous to what you would use with +apptainer pull.

    • +

  • The application inside the container could be much more complex. +By creating a apptainer run-interface via %runscript-block +you can convert a big and complex installation into what is +basically a single executable.

    • +
+
+
+
+

Running additional installation commands during image creation

+

More often than not, creating an image involves more than +just using an existing image.

+

If you want to run additional installation commands, +you can do them in a %post-block. These commands will +be run once during the building procedure.

+

For example, let’s modify our definition file so that we get an installation +of numpy-package in the image:

+
Bootstrap: docker
+From: python:latest
+
+%files
+    summation.py /opt
+
+%runscript
+    echo "Got arguments: $*"
+    exec python /opt/summation.py "$@"
+
+%post
+    pip install numpy
+
+
+

After re-building the image we can test the numpy installation with:

+
$ apptainer exec my_container.sif python -c 'import numpy; print(numpy.__version__)'
+
+
+
+

Expected result

+

During the build process we should see that the numpy-package is +being installed.

+

Running the container should produce the following output:

+
$ apptainer exec my_container.sif python -c 'import numpy; print(numpy.__version__)'
+1.26.4
+
+
+
+
+

Image building is done as a fake root-user

+

Commands that are run in the %post step and in other setup steps +are run in a state called +fakeroot where +the user looks like the root-user inside the container when in reality +the user is a normal user.

+

This means that use of sudo is not needed when installing packages via +package managers.

+

When converting installation instructions written for normal +non-containerized installations to definition files +one should usually remove sudo from the front of commands.

+
+
+

Warning

+

Remember that images should not contain any secrets +(passwords, sensitive code or data etc.)!

+

Anybody who has access to the image can access all files +in the image.

+
+
+
+

Setting environment variables in the image

+

We can also specify that additional environment variables should be set +when the image is being launched with an %environment-block.

+

While %runscript only applies when we apptainer run the image, +commands specified in the %environment-block will be executed when +the image is launched.

+

Let’s use this opportunity to set the terminal language options +in the container. Usually containers do not have all available language +settings installed, so setting these environment variables is very common.

+
Bootstrap: docker
+From: python:latest
+
+%files
+    summation.py /opt
+
+%runscript
+    echo "Got arguments: $*"
+    exec python /opt/summation.py "$@"
+
+%post
+    pip install numpy
+
+%environment
+    export LC_ALL=C
+    export LANGUAGE=C
+    export LANG=C
+
+
+

After re-building the image we can test that the environment values is set with:

+
$ apptainer exec my_container.sif python -c 'import os; print(os.getenv("LANG"))'
+
+
+
+

Expected result

+

After rebuilding the container running the container should produce the following output:

+
$ apptainer exec my_container.sif python -c 'import os; print(os.getenv("MYVAR"))'
+yes
+
+
+
+

You can also set environment variables when running an image by +setting APPTAINERENV_MYVAR=myvalue outside of the container or +by giving --env MYVAR=myvalue as a flag to the +run/exec/shell-command.

+

For more info on how to set environment variables when running containers, +see this page +from Apptainer’s documentation.

+
+
+

Adding documentation to your image

+

If you’re planning on sharing your image with other people or you want to +keep tabs on multiple images you can use labels to mark your image with +a %labels-block.

+

You can also add a %help-block that will tell users on how to use your +image.

+

Let’s add these blocks to the definition file:

+
Bootstrap: docker
+From: python:latest
+
+%files
+    summation.py /opt
+
+%runscript
+    echo "Got arguments: $*"
+    exec python /opt/summation.py "$@"
+
+%post
+    pip install numpy
+
+%environment
+    export LC_ALL=C
+    export LANGUAGE=C
+    export LANG=C
+
+%labels
+   Author: CodeRefinery
+   Version: v0.0.1
+   Description: This is an example image
+
+%help
+   This container sums up numbers.
+
+   Example:
+
+      apptainer run my_container.sif 1 2
+
+
+

Let’s check the help message with:

+
$ apptainer run-help my_container.sif
+
+
+
+

Expected result

+

The output should look something like this:

+
$ apptainer run-help my_container.sif
+    This container sums up numbers.
+
+    Example:
+
+       apptainer run my_container.sif 1 2
+
+
+
+
+
+

Examining the container

+

Now that we have a container with some software in it we can examine it with

+
$ apptainer inspect my_container.sif
+
+
+
+

Expected result

+

The output should look something like this:

+
$ apptainer inspect my_container.sif
+Author:: CodeRefinery
+Description:: This is an example image
+Version:: v0.0.1
+org.label-schema.build-arch: amd64
+org.label-schema.build-date: Thursday_25_April_2024_21:45:51_EEST
+org.label-schema.schema-version: 1.0
+org.label-schema.usage.apptainer.version: 1.3.0
+org.label-schema.usage.singularity.deffile.bootstrap: docker
+org.label-schema.usage.singularity.deffile.from: python:latest
+
+
+
+

We can also see the image contents with

+
$ apptainer sif list my_container.sif
+
+
+
+

Expected result

+

Output of the command should be something like this:

+
$ apptainer sif list my_container.sif
+------------------------------------------------------------------------------
+ID   |GROUP   |LINK    |SIF POSITION (start-end)  |TYPE
+------------------------------------------------------------------------------
+1    |1       |NONE    |32176-32385               |Def.FILE
+2    |1       |NONE    |32385-34957               |JSON.Generic
+3    |1       |NONE    |34957-35407               |JSON.Generic
+4    |1       |NONE    |36864-394522624           |FS (Squashfs/-System/amd64)
+
+
+
+

From the output of the previous command we see that at position 1 of the file we have +the definition file used to build the image. We can examine that with

+
$ apptainer sif dump 1 my_container.sif
+
+
+
+
+

Additional definition file options

+

There are plenty of other sections that can be used in the definition +file. For a great and comprehensive documentation, see +Apptainer’s documentation for definition files.

+
+
These features include:
    +

  • Creating multiple callable applications in the image

    • +

  • Creating services that can be started and stopped

    • +

  • Creating tests for the image build

    • +
+
+
+
+

Key points to remember

+
    +

  • Use apptainer pull to pull existing Docker images.

    • +

  • Use apptainer build to build custom images from definition files.

    • +

  • Do not store secret information in images.

    • +

  • There are plenty of additional features provided. Check documentation +for more info.

    • +
+
+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/container_images/index.html b/container_images/index.html new file mode 100644 index 0000000..7bb425a --- /dev/null +++ b/container_images/index.html @@ -0,0 +1,270 @@ + + + + + + + Intro to container images — Container on HPC with Apptainer documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Intro to container images

+
+

Objectives

+
    +

  • Learn what container image means

    • +
+
+
+

Traditional container images (Docker etc.)

+

When containers launch they need a file system with a linux operating system. +This filesystem is provided by a container image.

+

This naming comes from an analogy with a traditional image or a painting.

+
+https://upload.wikimedia.org/wikipedia/commons/6/6d/Saint_Jerome_Leonardo_-_image_only_%28Q972196%29.jpg +
+

Figure 1: Saint Jerome in the Wilderness by Leonardo da Vinci

+
+
+

Let’s consider the image above. It is an unfinished painting by Leonardo da Vinci.

+

From the unfinished nature of this painting you can see the following:

+
    +

  • Some areas of the background panel are not touched at all (e.g. hands).

    • +

  • The base background is in some places covered by sketches (e.g the lion) and in most places by the background colors.

    • +

  • The background colors are sometimes covered in sketches as well (e.g. top left).

    • +
+

From these things we can gather that the image is constructed from layers where +paint or sketches cover what is hidden underneath.

+

This analogy happens with traditional container images as well (e.g. docker images): +container images consist of multiple layers where top layers can hide preceding layers.

+

A typical image might look something like this:

+
+../_images/image_explanation.png +
+

Figure 2: Typical container image consists of individual layers

+
+
+

In practice this overwriting behaviour is done by using a file format called SquashFS, +where file systems are stored in one single layer.

+

In a traditional image the image is built in this fashion:

+
    +

  1. The build starts from a base image. This is often an OS image, but it does not have to +be. It can be some other image that has a OS image as its base image.

    2. +

  2. This layer is started up in a container.

    3. +

  3. Modifications are done. For example, an application is installed.

    4. +

  4. The difference of what files were modified is stored into a new layer.

    5. +

  5. This new image with the modifications is now used as a base image.

    6. +

  6. More modifications are done unless there are no more modifications to do.

    7. +

  7. The last layer is tagged with some human readable name.

    8. +

  8. When image is published to other users, it is sent to some container registry.

    9. +
+

The file that contains the commands that need to be run to build the image +is called a Dockerfile. +This is true for systems other that Docker as well.

+

This way of working with differences of layers reduces the space needed to +store the images and the network capacity needed to transfer the images.

+

When a container is launched these layers are fetched and organized on top of each +other and when a program tries to find a file, it will go through the layers until it +finds it. This is analogous to light bouncing off from the top layer of paint on a +painting. Paint below the top layer is hidden.

+
+

Key points to remember

+
    +

  • Traditional containers are built layer by layer.

    • +

  • Traditional containers are built from Dockerfiles.

    • +

  • Traditional container images are transferred via registries using +client tools or as .tar-files.

    • +
+
+
+
+

Apptainer container images

+

Apptainer works a bit differently than traditional container setups.

+

Apptainer stores the container image in one file in +Singularity image format or .sif. This file is a SquashFS file with +additional metadata included.

+

This means that Apptainer does not store image as multiple layers. +Instead it writes all of the layers into one single layer. This is analogous +to printing an image of a painting on a piece of paper. The hidden layers +of paint are not replicated and only the topmost layer is visible.

+
+../_images/image_explanation_apptainer.png +
+

Figure 3: Apptainer container image is a single unchanging image layer

+
+
+

This way of working has some upsides and some downsides.

+

Upsides include:

+
    +

  • The image is more portable. One image can be easily transferred across +systems using normal file copying tools.

    • +

  • The image is more reproducible. The metadata stored in the file gives +information on when the image was created and what commands were used +to create it.

    • +

  • The image is easier to archive. One just needs to keep track of a single +file.

    • +
+

Downsides include:

+
    +

  • Image creation takes longer as all operations need to be done in one go. +Traditional container images can be built layer by layer.

    • +

  • Images cannot be stored in traditional registries like Docker Hub.

    • +
+

Apptainer images can use Docker images as their starting point. +Additional build steps and runtime behaviour can be specified in a +definition file (.def).

+
+

Key points to remember

+
    +

  • Apptainer images are a single image layer which is stored in a .sif-file.

    • +

  • When built from traditional image, Apptainer images squash all layers to a single one.

    • +

  • Apptainer images are built from definition file (.def).

    • +

  • Apptainer images are transferred as normal files.

    • +
+
+
+
+

Image sources

+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/first_build/index.html b/first_build/index.html new file mode 100644 index 0000000..ca9f0c9 --- /dev/null +++ b/first_build/index.html @@ -0,0 +1,205 @@ + + + + + + + Building Your First Container — Container on HPC with Apptainer documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Building Your First Container

+
+

Objectives

+
    +

  • Understand the basic concept and utility of containerization in HPC environments.

    • +

  • Learn to create an Apptainer container using a definition file.

    • +

  • Apply this knowledge to build reproducible computing environments.

    • +
+

In this demo, you will learn how to build your first container using Apptainer, starting from a simple definition file. Containers are crucial for creating reproducible, portable, and scalable environments that are isolated from the underlying infrastructure. This hands-on example will guide you through the process of defining and building a basic container, which is a foundational skill in using containers effectively in high-performance computing.

+
+
+

Prerequisites

+
    +

  • No prerequisites for following the demo

    • +
+
+

Building your first container is a significant first step to test the technology and make sure it works in the cluster(s) you use. This example is based on the typical case when you need to install and run a specific tool which cannot be easily installed by your HPC cluster admins. This can happen if certain tools are really tight to some specific system-wide dependencies (e.g. certain versions of libraries, compilers, operating system).

+

For the sake of learning, assume that the three tools fortune, cowsay, and lolcat cannot be installed by your cluster admins, and have strict requirements that you cannot just install them by yourself without root privileges.

+
# Example definition file content for Apptainer
+Bootstrap: docker
+From: ubuntu:24.04
+
+%post
+    apt-get -y update
+    apt-get -y install fortune cowsay lolcat
+
+%environment
+    export LC_ALL=C
+    export PATH=/usr/games:$PATH
+
+%runscript
+    fortune | cowsay | lolcat
+
+# Save the above content into a file named 'mydefinition.def'
+
+
+

Next we need to build the container image.

+
# Build an Apptainer container from a definition file
+apptainer build mycontainer.sif mydefinition.def
+
+
+

This command constructs a container named ‘mycontainer.sif’ from the definition file ‘mydefinition.def’. The .sif file format is a portable container format used by Apptainer. This step is essential as it compiles all the necessary components and software specified in your definition file into a single executable container.

+
+

Summary

+

This example showed you how to build a basic container using Apptainer from a definition file. You’ve learned a critical skill in containerization, enabling you to create reproducible and portable environments for a wide range of scientific applications. This capability is foundational in leveraging the full potential of HPC resources while ensuring consistency across different computing environments.

+
+

Build a simple container and test it

+

Build a simple container on your cluster. You do not have to use the example above. Test the following:

+
+
    +

  1. Start a terminal shell on the container and run a command such as date

    2. +

  2. Test the runscript part for the container above. How do you run it and what is the output?

    3. +

  3. Add the %labels and %help block and test them as explained in the “Building Apptainer Images” section

    4. +

  4. Copy paste all terminal commands and output from the three point above into a text file that you can submit as homework.

    5. +
+
+
+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/genindex/index.html b/genindex/index.html new file mode 100644 index 0000000..216f146 --- /dev/null +++ b/genindex/index.html @@ -0,0 +1,142 @@ + + + + + + Index — Container on HPC with Apptainer documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ + +

Index

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

© Copyright 2024-, The contributors.

+
+ + Built with Sphinx using a + theme + provided by Read the Docs. + + +
+
+
+
+
+ + + + \ No newline at end of file diff --git a/gpus/index.html b/gpus/index.html new file mode 100644 index 0000000..a4d04be --- /dev/null +++ b/gpus/index.html @@ -0,0 +1,284 @@ + + + + + + + Running containers that use GPUs — Container on HPC with Apptainer documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Running containers that use GPUs

+
+

Objectives

+
    +

  • Learn how you can use GPUs with containers

    • +
+
+

If your program uses GPUs, you’ll need to make the GPUs visible in +the container. This is done by giving additional flag to the +apptainer command.

+

The container itself must have the correct GPU computing libraries +installed inside the image (CUDA toolkit for NVIDIA and ROCm for AMD). +Code inside the image needs to be installed with GPU support as well. +Apptainer will only mount the driver libraries and the GPU devices +that these toolkits need to run the code on GPUs.

+
+

Using NVIDIA’s GPUs

+

When using NVIDIA’s GPUs that use the CUDA-framework the flag is --nv.

+

As an example, let’s get a CUDA-enabled PyTorch-image:

+

accelerate_cuda.def:

+

Now when we launch the image, we can give the image GPU access with

+
$ apptainer exec --nv pytorch-cuda.sif python -c 'import torch; print(torch.cuda.is_available())'
+
+
+
+../_images/nv_example.png +
+

Figure 1: Enabling NVIDIA’s GPUs in containers

+
+
+
+

Expected result

+

If you run this in a system with an NVIDIA GPU, you should see the following result:

+
$ apptainer exec --nv pytorch-cuda.sif python -c 'import torch; print(torch.cuda.is_available())'
+True
+
+
+
+
+
+

Using AMD’s GPUs

+

When using AMD’s GPUs that use the ROCm-framework the flag is --rocm.

+

As an example, let’s get a ROCm-enabled PyTorch-image:

+
$ apptainer pull pytorch-rocm.sif docker://docker.io/rocm/pytorch:rocm6.1_ubuntu22.04_py3.10_pytorch_2.1.2
+
+
+

Now when we launch the image, we can give the image GPU access with

+
$ apptainer exec --rocm pytorch-rocm.sif python -c 'import torch; print(torch.cuda.is_available())'
+
+
+
+../_images/rocm_example.png +
+

Figure 2: Enabling AMD’s GPUs in containers

+
+
+
+

Expected result

+

If you run this in a system with an AMD GPU, you should see the following result:

+
$ apptainer exec --rocm pytorch-rocm.sif python -c 'import torch; print(torch.cuda.is_available())'
+True
+
+
+
+
+
+

Example container: Model training with accelerate

+

Accelerate +is a library designed for running distributed PyTorch code.

+

Let’s create a container that can run a simple training example +that can utilizes multiple GPUs.

+

Container starts from an existing container with PyTorch installed +and installs a few missing Python packages:

+

accelerate_cuda.def:

+
Bootstrap: docker
+From: pytorch/pytorch:2.2.2-cuda12.1-cudnn8-runtime
+
+%post
+
+  pip install accelerate evaluate datasets scipy scikit-learn transformers
+
+
+

Submission script that launches the container looks like this:

+

run_accelerate_cuda.sh:

+
#!/bin/bash
+#SBATCH --mem=32G
+#SBATCH --nodes=1
+#SBATCH --ntasks-per-node=1
+#SBATCH --gpus-per-task=2
+#SBATCH --cpus-per-task=12
+#SBATCH --time=00:10:00
+#SBATCH --output=accelerate_cuda.out
+
+export OMP_NUM_THREADS=$(( $SLURM_CPUS_PER_TASK / $SLURM_GPUS_ON_NODE ))
+
+apptainer exec --nv accelerate_cuda.sif \
+  torchrun \
+    --nproc_per_node $SLURM_GPUS_ON_NODE \
+    ./nlp_example.py \
+    --mixed_precision fp16
+
+
+
+

To build the image:

+
$ srun --mem=32G --cpus-per-task=4 --time=01:00:00 apptainer build accelerate_cuda.sif accelerate_cuda.def
+
+
+

To run the example:

+
$ wget https://raw.githubusercontent.com/huggingface/accelerate/refs/heads/main/examples/nlp_example.py
+$ sbatch run_accelerate_cuda.sh
+$ cat accelerate_cuda.out
+Some weights of BertForSequenceClassification were not initialized from the model checkpoint at bert-base-cased and are newly initialized: ['classifier.bias', 'classifier.weight']
+You should probably TRAIN this model on a down-stream task to be able to use it for predictions and inference.
+You're using a BertTokenizerFast tokenizer. Please note that with a fast tokenizer, using the `__call__` method is faster than using a method to encode the text followed by a call to the `pad` method to get a padded encoding.
+epoch 0: {'accuracy': 0.7598039215686274, 'f1': 0.8032128514056225}
+epoch 1: {'accuracy': 0.8480392156862745, 'f1': 0.8931034482758621}
+epoch 2: {'accuracy': 0.8406862745098039, 'f1': 0.888507718696398}
+
+
+
+
+
+

Review of this session

+
+

Key points to remember

+
    +

  • Code inside the container image needs to support GPU calculations.

    • +

  • Container image should have a working CUDA / ROCm toolkit installed.

    • +

  • Use --nv / --rocm-flag to mount the device drivers inside of the image.

    • +
+
+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/index.html b/index.html new file mode 100644 index 0000000..3d284cf --- /dev/null +++ b/index.html @@ -0,0 +1,257 @@ + + + + + + + Containers on HPC with Apptainer — Container on HPC with Apptainer documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Containers on HPC with Apptainer

+
+

Course instance in May 2024

+

You can follow the dates this course is given on the course page. +Dates are not yet known and registration is not yet open, though.

+
+

Improve your cluster workflows! You’ve had a basic course on working +with a cluster - but what do people actually do? This course shows +practical examples and tips which may help you, but aren’t usually +covered in either basic or advanced courses.

+

We won’t go so deep into each topic that you know everything about it, +but you learn what is possible, see some examples, and know where to +follow up on the tools that are right for you. The format is +designed to be “fireside chat with experts”, a combination of demos, +type-along, and independent exercises. You can engage at different +levels, depending on your interest.

+
+

Prerequisites

+
    +

  • Basic HPC usage course (if you don’t have, many of the things we +talk about won’t make sense, but you might pick up something +anyway).

    • +

  • A bit of experience using a HPC cluster (technically optional, +but will allow you to engage with the material at a deeper +level).

    • +

  • Access to some HPC computer cluster to do most exercises. +(Slurm-based, but most are these days). (If you don’t have, you +can’t do all exercises - but still might learn something!)

    • +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +

15 min

Intro to containers (on HPC)

20 min

Basics of running containers

15 min

Intro to container images

10 min

Break

25 min

Building Apptainer images

15 min

Binding folders into your container

05 min

Open discussion and where to go next

+
+

The lesson

+ +
+
+

Extras

+ +
+
+

Exercises

+ +
+
+

Who is the course for?

+

This course is for people using clusters or other larger computing +resources. It’s not a basic course, but also not extremely advanced. +It lets you see some examples and know what people actually do, and +then you can follow up with more reading, courses, or direct help +later on.

+

Some learner personas:

+
    +

  • You’ve just taken a basic HPC course, and while you mostly +understand how the basic pices work, you are left wondering “How +does this all fit together? How do people combine all of these +tools into an actual whole workflow?”.

    +

    You care about some real examples and things you can use right now, +but wouldn’t mind seeing some advanced or out-of-scope stuff as long +as you don’t have to spend too much mental effort on it.

    +

    You’ll probably do the more basic exercises and watch the rest as a +demo until you come back to it later (if needed).

    +
    • +

  • You’ve been using the cluster for a while and doing your work just +fine - or so you think. It works well, but you know there must be +some other tricks out there that can make your life (if not work) +even better.

    +

    You’ll probably attend and do the more advanced exercises, while +passively watching some of the more basic demos.

    +
    • +
+
+
+

About the course

+

This lesson is part of Tuesday Tools & Techniques for High Performance Computing.

+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/intro_and_motivation/index.html b/intro_and_motivation/index.html new file mode 100644 index 0000000..46a7a46 --- /dev/null +++ b/intro_and_motivation/index.html @@ -0,0 +1,278 @@ + + + + + + + Intro to containers (on HPC) — Container on HPC with Apptainer documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Intro to containers (on HPC)

+
+

Objectives

+
    +

  • Understand the basic logic and terms behind container technology

    • +

  • Learn about the possible use cases for containers on HPC clusters

    • +
+
+
+

What even is a container?

+

Containers take their name from shipping containers:

+
+https://upload.wikimedia.org/wikipedia/commons/3/36/Shipping_container%2C_Bellarena_-_geograph.org.uk_-_1859736.jpg +
+

Figure 1: A shipping container in its natural habitat

+
+
+

This analogue is based on the idea is that containers have a barrier +between the insides of the container and outside of the container. +This makes shipping them between ports easy.

+

Based on this analogue one might think that the container is just a +storage format. It is that as well: containers are stored in container +images (more on this in a later chapter).

+

Instead it is a way of running an application in a self-contained +environment with all the tools that this specific application needs.

+

More traditional container launchers like Docker, Podman and Kubernetes +also manage containers’ resource usage, networking and various other aspects. +When using Apptainer, we do not need to worry about these features.

+
+

More technical information on how traditional containers work

+

Traditional containers use +linux namespaces +when they implement various features. These features include:

+
    +

  • Creating a separate process identifier (PID) namespace: +This means that process id’s are not shared in the container and on +the host.

    • +

  • Creating a virtual network for the containers: +Container runtimes such as docker often create virtual network +interfaces that the containers can use to communicate like actual +virtual machines.

    • +

  • Limiting container resources: +Container runtimes usually limit container resource usage +(CPU usage, RAM usage) via Linux control groups (cgroups).

    • +
+

Apptainer does none of these as it is meant to be run as a normal +user and not as a superuser.

+

Apptainer does use +user namespaces +for launching the container without giving the user additional privileges.

+
+

Let’s consider the following case:

+
    +

  1. User installs and runs an application on a their home computer

    2. +

  2. They want to run the exact same application on their HPC cluster

    3. +

  3. The operating system / available software is different on the HPC cluster

    4. +

  4. Even if the program runs, it is necessarily not the exact same program as operating system has changed

    5. +
+
+../_images/normal_application.png +
+

Figure 2: Without containers, your program uses libraries from the host system

+
+
+

With containers the user would run the exact same container on both systems:

+
+../_images/containerized_application.png +
+

Figure 3: With containers, your program uses libraries from the container image

+
+
+

The OS that launches the container is often called the host and +the container that is launched is called a guest.

+
+

Key points to remember

+

Containers are a way of launching applications in a self-contained +environment with their own OS and program libraries.

+

The filesystem used by containers is stored in container images. We’ll talk +more on container images later.

+
+
Remember that the word container can refer to:
    +

  • a running container with it’s own environment

    • +

  • the container image that defines the container environment

    • +
+
+
+

Host refers to the OS that launches the container, guest +refers to the launched container.

+
+
+
+

What is the intended use case of Apptainer?

+

Apptainer is meant for running complex applications in various systems such +as HPC systems in a reproducible and portable way.

+

There are many uses, but here are some example:

+
    +

  • Installing an application that has installation instructions designed for a specific operating system different than the one you are on.

    • +

  • Creating a self-contained application that can be used as a part of your +workflow in multiple different systems and can easily be shared with colleagues

    • +

  • Creating a finished application that can be shared with your paper

    • +

  • Reducing the amount of files needed to install an application by putting +all files in the image (especially useful for Python environments)

    • +
+
+
+

Apptainer vs. Singularity

+

Singularity started as an open source project from Lawrence Berkeley National +Laboratory in 2015. In 2018 a company called Sylabs was founded to provide +commercial support for sites that use it.

+

In 2021 the project joined Linux Foundation and was renamed Apptainer.

+

Sylabs is still present and they maintain their own fork of the project called +SingulartyCE.

+

For more info, see the +Singularity wikipedia article.

+
+

Key points to remember

+

Your site might be running Singularity, SingularityCE or Apptainer.

+

In most cases the user interface is completely the same.

+

If you’re running singularity you can just rename any +apptainer-commands to singularity.

+
+
+
+

Image sources

+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/mpi/index.html b/mpi/index.html new file mode 100644 index 0000000..e31897a --- /dev/null +++ b/mpi/index.html @@ -0,0 +1,827 @@ + + + + + + + MPI programs and containers — Container on HPC with Apptainer documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

MPI programs and containers

+
+

Objectives

+
    +

  • Learn what complications are involved with MPI containers

    • +

  • Learn how to generate a MPI container for your HPC system

    • +
+
+
+

What to consider when creating a container for MPI programs?

+

Message Passing Interface (MPI) is a standardized API and a programming +paradigm where programs can use MPI directives to send messages +across thousands of processes. It is commonly used in traditional +HPC computing.

+

To handle the scale of the MPI programs the MPI installations +are typically tied to the high-speed interconnect available in +the computational cluster and to the queue system that the cluster +uses.

+

This can create the following problems when an MPI program +is containerized:

+
    +

  1. Launching of the MPI job can fail if the program does not +communicate with the queue system.

    2. +

  2. The MPI communication performance can be bad if the program +does not utilize the high-speed interconnects correctly.

    3. +

  3. The container can have portability issues when taking it to +a different cluster with different MPI, queue system or +interconnect.

    4. +
+

To solve these problems we first need to know how MPI works.

+
+
+

How MPI works

+

The launch process for an MPI program works like this:

+
    +

  1. A reservation is done in the queue system for some number +of MPI tasks.

    2. +

  2. When the reservation gets the resources, individual MPI +programs are launched by the queue system (srun) or +by an MPI launcher (mpirun).

    3. +

  3. User’s MPI program calls the MPI librarires it was built +against.

    4. +

  4. These libraries ask the queue system how many other MPI +tasks there are.

    5. +

  5. Individual MPI tasks start running the program collectively. +Communication between tasks is done via fast interconnects.

    6. +
+
+../_images/mpi_job_structure.png +
+

Figure 1: How MPI programs launch

+
+
+

To make this work with various different queue systems and +various different interconnects MPI installations often +utilize Process Management Interface (PMI/PMI2/PMIx) when +they connect to the queue system and Unified Communication X +when they connect to the interconnects.

+
+../_images/mpi_install_structure.png +
+

Figure 2: How MPI installations are usually constructed

+
+
+
+
+

How to use MPI with a container

+

Most common way of running MPI programs in containers is +to utilize a +hybrid model, +where the container contains the same MPI version as the host system.

+

When using this model the MPI launcher will call the MPI +within the container and use it to launch the application.

+
+../_images/mpi_job_structure_hybrid.png +
+

Figure 3: Hybrid MPI job launch

+
+
+

Do note that the MPI inside the container does not necessarily +know how to utilize the fast interconnects. We’ll talk about +solving this later.

+
+
+

Creating a simple MPI container

+

Let’s construct an example container that runs a simple +MPI benchmark from +OSU Micro-Benchmarks. +This benchmark suite is useful for testing whether the MPI +installation works and whether the MPI can utilize the fast +interconnect.

+

Because different sites have different MPI versions the definition +files differ as well. Pick a definition file for your site.

+
+

triton-openmpi.def:

+
Bootstrap: docker
+From: ubuntu:latest
+
+%arguments
+
+  NPROCS=4
+  OPENMPI_VERSION=4.1.6
+  OSU_MICRO_BENCHMARKS_VERSION=7.4
+
+%post
+
+  ### Install OpenMPI dependencies
+
+  apt-get update
+  apt-get install -y wget bash gcc gfortran g++ make file bzip2 ca-certificates libucx-dev
+
+  ### Build OpenMPI
+
+  OPENMPI_VERSION_SHORT=$(echo {{ OPENMPI_VERSION }} | cut -f 1-2 -d '.')
+  cd /opt
+  mkdir ompi
+  wget -q https://download.open-mpi.org/release/open-mpi/v${OPENMPI_VERSION_SHORT}/openmpi-{{ OPENMPI_VERSION }}.tar.bz2
+  tar -xvf openmpi-{{ OPENMPI_VERSION }}.tar.bz2
+  # Compile and install
+  cd openmpi-{{ OPENMPI_VERSION }}
+  ./configure --prefix=/opt/ompi --with-ucx=/usr
+  make -j{{ NPROCS }}
+  make install
+  cd ..
+  rm -rf openmpi-{{ OPENMPI_VERSION }} openmpi-{{ OPENMPI_VERSION }}.tar.bz2
+
+  ### Build example application
+  
+  export OMPI_DIR=/opt/ompi
+  export PATH="$OMPI_DIR/bin:$PATH"
+  export LD_LIBRARY_PATH="$OMPI_DIR/lib:$LD_LIBRARY_PATH"
+
+  # Build osu benchmarks
+  cd /opt
+  wget -q http://mvapich.cse.ohio-state.edu/download/mvapich/osu-micro-benchmarks-{{ OSU_MICRO_BENCHMARKS_VERSION }}.tar.gz
+  tar xf osu-micro-benchmarks-{{ OSU_MICRO_BENCHMARKS_VERSION }}.tar.gz
+  cd osu-micro-benchmarks-{{ OSU_MICRO_BENCHMARKS_VERSION }}
+  ./configure --prefix=/opt/osu-micro-benchmarks CC=/opt/ompi/bin/mpicc CFLAGS=-O3
+  make -j{{ NPROCS }}
+  make install
+  cd ..
+  rm -rf osu-micro-benchmarks-{{ OSU_MICRO_BENCHMARKS_VERSION }} osu-micro-benchmarks-{{ OSU_MICRO_BENCHMARKS_VERSION }}.tar.gz
+
+%environment
+  export OMPI_DIR=/opt/ompi
+  export PATH="$OMPI_DIR/bin:$PATH"
+  export LD_LIBRARY_PATH="$OMPI_DIR/lib:$LD_LIBRARY_PATH"
+  export MANPATH="$OMPI_DIR/share/man:$MANPATH"
+
+%runscript
+  /opt/osu-micro-benchmarks/libexec/osu-micro-benchmarks/mpi/pt2pt/osu_bw
+
+
+

To build:

+
srun --mem=16G --cpus-per-task=4 --time=01:00:00 apptainer build triton-openmpi.sif triton-openmpi.def
+
+
+

To run (some extra parameters are needed to prevent launch errors):

+
$ module load openmpi/4.1.6
+$ export PMIX_MCA_gds=hash
+$ export UCX_POSIX_USE_PROC_LINK=n
+$ export OMPI_MCA_orte_top_session_dir=/tmp/$USER/openmpi
+$ srun --partition=batch-milan --mem=2G --nodes=2-2 --ntasks-per-node=1 --time=00:10:00 apptainer run openmpi-triton.sif
+srun: job 3521915 queued and waiting for resources
+srun: job 3521915 has been allocated resources
+
+# OSU MPI Bandwidth Test v7.4
+# Datatype: MPI_CHAR.
+# Size      Bandwidth (MB/s)
+1                       3.98
+2                       8.05
+4                      15.91
+8                      32.03
+16                     64.24
+32                    125.47
+64                    245.52
+128                   469.00
+256                   877.69
+512                  1671.24
+1024                 3218.11
+2048                 5726.91
+4096                 8096.24
+8192                10266.18
+16384               11242.78
+32768               11298.70
+65536               12038.27
+131072              12196.28
+262144              12202.05
+524288              11786.58
+1048576             12258.48
+2097152             12179.43
+4194304             12199.89
+
+
+
+
+
+

Utilizing the fast interconnects

+

In order to get the fast interconnects to work with the hybrid model +one can either:

+
    +

  1. Install the interconnect drivers into the image and build the MPI to +use them. This is the normal Hybrid approach described in Figure 3.

    2. +

  2. Mount cluster’s MPI and other network libraries into the image and use +them instead of the container’s MPI while running the MPI program. +This is described in Figure 4.

    3. +
+
+../_images/mpi_job_structure_bound.png +
+

Figure 4: Container with bound system MPI and network libraries

+
+
+

Below are explanations on how the interconnect libraries were provided.

+
+

The interconnect support was provided by the libucx-dev-package that +provides Infiniband drivers.

+

triton-openmpi.def, line 15:

+

The OpenMPI installation was then configured to use these drivers:

+

triton-openmpi.def, line 26:

+
  ./configure --prefix=/opt/ompi --with-ucx=/usr
+
+
+
+
+
+

ABI compatibility in MPI

+

Different MPI installations do not have necessarily have +application binary interface (ABI) compatibility. This means +that software built with certain MPI installation does not +necessarily run with another MPI installation.

+

Quite often MPI programs are built with the same version +of MPI that will be used to run the program. However, in +containerized applications the runtime MPI version might change +if an outside MPI is bound into the container.

+

This can work as there is some ABI compatibility +within an MPI family (OpenMPI, MPICH). For more info, see +OpenMPI’s page on version compatibility +and +MPICH’s ABI Compatibility Initiative.

+

There are also projects like +E4S Container Launcher +and +WI4MPI (Wrapper Interface for MPI) +that aim to bypass this problem by creating a wrapper interfaces +that the program in the container can be built against. This +wrapper can then use different MPI implementations during +runtime.

+
+
+

Example on portability: LAMMPS

+

LAMMPS is a classical molecular dynamics simulation code with a focus +on materials modeling.

+

Let’s build a container with LAMMPS in it:

+

lammps-openmpi.def:

+
Bootstrap: docker
+From: ubuntu:latest
+
+%arguments
+
+  NPROCS=4
+  OPENMPI_VERSION=4.1.6
+  LAMMPS_VERSION=29Aug2024
+
+%post
+
+  ### Install OpenMPI dependencies
+
+  apt-get update
+  apt-get install -y wget bash gcc gfortran g++ make file bzip2 ca-certificates libucx-dev
+
+  ### Build OpenMPI
+
+  OPENMPI_VERSION_SHORT=$(echo {{ OPENMPI_VERSION }} | cut -f 1-2 -d '.')
+  cd /opt
+  mkdir ompi
+  wget -q https://download.open-mpi.org/release/open-mpi/v${OPENMPI_VERSION_SHORT}/openmpi-{{ OPENMPI_VERSION }}.tar.bz2
+  tar -xvf openmpi-{{ OPENMPI_VERSION }}.tar.bz2
+  # Compile and install
+  cd openmpi-{{ OPENMPI_VERSION }}
+  ./configure --prefix=/opt/ompi --with-ucx=/usr
+  make -j{{ NPROCS }}
+  make install
+  cd ..
+  rm -rf openmpi-{{ OPENMPI_VERSION }} openmpi-{{ OPENMPI_VERSION }}.tar.bz2
+
+  ### Build example application
+
+  # Install LAMMPS dependencies
+  apt-get install -y cmake
+
+  export OMPI_DIR=/opt/ompi
+  export PATH="$OMPI_DIR/bin:$PATH"
+  export LD_LIBRARY_PATH="$OMPI_DIR/lib:$LD_LIBRARY_PATH"
+  export CMAKE_PREFIX_PATH="$OMPI_DIR:$CMAKE_PREFIX_PATH"
+ 
+  # Build LAMMPS
+  cd /opt
+  wget -q https://download.lammps.org/tars/lammps-{{ LAMMPS_VERSION }}.tar.gz
+  tar xf lammps-{{ LAMMPS_VERSION }}.tar.gz
+  cd lammps-{{ LAMMPS_VERSION }}
+  cmake -S cmake -B build \
+    -DCMAKE_INSTALL_PREFIX=/opt/lammps \
+    -DBUILD_MPI=yes \
+    -DBUILD_OMP=yes
+  cmake --build build --parallel {{ NPROCS }} --target install
+  cp -r examples /opt/lammps/examples
+  cd ..
+  rm -rf lammps-{{ LAMMPS_VERSION }} lammps-{{ LAMMPS_VERSION }}.tar.gz
+
+%environment
+  export OMPI_DIR=/opt/ompi
+  export PATH="$OMPI_DIR/bin:$PATH"
+  export LD_LIBRARY_PATH="$OMPI_DIR/lib:$LD_LIBRARY_PATH"
+  export MANPATH="$OMPI_DIR/share/man:$MANPATH"
+
+  export LAMMPS_DIR=/opt/lammps
+  export PATH="$LAMMPS_DIR/bin:$PATH"
+  export LD_LIBRARY_PATH="$LAMMPS_DIR/lib:$LD_LIBRARY_PATH"
+  export MANPATH="$LAMMPS_DIR/share/man:$MANPATH"
+
+%runscript
+  exec /opt/lammps/bin/lmp "$@"
+
+
+

Let’s also create a submission script that runs a LAMMPS example +where an indent will pushes against a material:

+

run_lammps_indent.sh:

+
#!/bin/bash
+#SBATCH --time=00:10:00
+#SBATCH --mem=2G
+#SBATCH --nodes=1
+#SBATCH --ntasks-per-node=4
+#SBATCH --output=lammps_indent.out
+
+# Copy example from image
+apptainer exec lammps-openmpi.sif cp -r /opt/lammps/examples/indent .
+
+cd indent
+
+# Load OpenMPI module
+module load openmpi
+
+# Run simulation
+srun apptainer run ../lammps-openmpi.sif -in in.indent
+
+
+

Now this exact same container can be run in both Triton / Puhti that have +OpenMPI installed because both clusters use Slurm and InfiniBand +interconnects.

+
+

To build the image:

+
$ srun --mem=16G --cpus-per-task=4 --time=01:00:00 apptainer build lammps-openmpi.sif lammps-openmpi.def
+
+
+

To run the example:

+
$ export PMIX_MCA_gds=hash
+$ export UCX_POSIX_USE_PROC_LINK=n
+$ export OMPI_MCA_orte_top_session_dir=/tmp/$USER/openmpi
+$ sbatch run_lammps_indent.sh
+$ tail -n 27 lammps_indent.out
+Loop time of 0.752293 on 4 procs for 30000 steps with 420 atoms
+
+Performance: 10336396.152 tau/day, 39878.072 timesteps/s, 16.749 Matom-step/s
+99.6% CPU use with 4 MPI tasks x 1 OpenMP threads
+
+MPI task timing breakdown:
+Section |  min time  |  avg time  |  max time  |%varavg| %total
+---------------------------------------------------------------
+Pair    | 0.31927    | 0.37377    | 0.42578    |   7.5 | 49.68
+Neigh   | 0.016316   | 0.020162   | 0.023961   |   2.3 |  2.68
+Comm    | 0.19882    | 0.25882    | 0.31814    |  10.2 | 34.40
+Output  | 0.00033215 | 0.00038609 | 0.00054361 |   0.0 |  0.05
+Modify  | 0.044981   | 0.049941   | 0.054024   |   1.7 |  6.64
+Other   |            | 0.04921    |            |       |  6.54
+
+Nlocal:            105 ave         112 max          98 min
+Histogram: 1 0 1 0 0 0 0 1 0 1
+Nghost:           92.5 ave          96 max          89 min
+Histogram: 1 0 1 0 0 0 0 1 0 1
+Neighs:         892.25 ave        1003 max         788 min
+Histogram: 2 0 0 0 0 0 0 0 1 1
+
+Total # of neighbors = 3569
+Ave neighs/atom = 8.497619
+Neighbor list builds = 634
+Dangerous builds = 0
+Total wall time: 0:00:01
+
+
+
+
+
+

Review of this session

+
+

Key points to remember

+
    +

  • MPI version should match the version installed to the cluster

    • +

  • Cluster MPI module should be loaded for maximum compatibility with job launching

    • +

  • Care must be taken to make certain that the container utilizes +fast interconnects

    • +
+
+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/objects.inv b/objects.inv new file mode 100644 index 0000000..1d1cf9f Binary files /dev/null and b/objects.inv differ diff --git a/python_exercise/index.html b/python_exercise/index.html new file mode 100644 index 0000000..e336e7d --- /dev/null +++ b/python_exercise/index.html @@ -0,0 +1,264 @@ + + + + + + + Python environment in a container — Container on HPC with Apptainer documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Python environment in a container

+
+

Objectives

+
    +

  • Learn how to create a Python environment in an apptainer image

    • +
+
+
+

Background

+

Python environments are nowadays very popular due to the popularity of +Python as a scientific programming language. These environments can sometimes +be problematic for the filesystem as they require thousands of files.

+
+
+

Exercise 1: Creating Python image with image’s pip

+
+

Install Python environment to base python image

+
+
Use the base python image and install following packages to the image:
    +

  • python

    • +

  • numpy

    • +

  • pandas

    • +
+
+
+ +
+
+
+

Exercise 2: Creating conda/mamba environment in an image

+
+

Install an environment to an apptainer image using an optimized definition file

+

Create an environment with this definition file customized for +environment creation:

+

https://github.com/simo-tuomisto/micromamba-apptainer

+
+
Install the following packages to the environment:
    +

  • python

    • +

  • numpy

    • +

  • pandas

    • +
+
+
+ +
+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/search/index.html b/search/index.html new file mode 100644 index 0000000..1414a4d --- /dev/null +++ b/search/index.html @@ -0,0 +1,156 @@ + + + + + + Search — Container on HPC with Apptainer documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+
    +
    • +
  • Search
    • +
  • +
    • +
+
+
+
+
+ + + + +
+ +
+ +
+
+
+ +
+ +
+

© Copyright 2024-, The contributors.

+
+ + Built with Sphinx using a + theme + provided by Read the Docs. + + +
+
+
+
+
+ + + + + + + + + \ No newline at end of file diff --git a/searchindex.js b/searchindex.js new file mode 100644 index 0000000..a053eb9 --- /dev/null +++ b/searchindex.js @@ -0,0 +1 @@ +Search.setIndex({"docnames": ["basics_running_containers", "binding_folders", "building_images", "container_images", "first_build", "gpus", "index", "intro_and_motivation", "mpi", "python_exercise", "services_apps", "sharing", "tips_tricks", "verify_installation"], "filenames": ["basics_running_containers.rst", "binding_folders.rst", "building_images.rst", "container_images.rst", "first_build.rst", "gpus.rst", "index.rst", "intro_and_motivation.rst", "mpi.rst", "python_exercise.rst", "services_apps.rst", "sharing.rst", "tips_tricks.rst", "verify_installation.rst"], "titles": ["Basics of running containers", "Binding folders into your container", "Building Apptainer images", "Intro to container images", "Building Your First Container", "Running containers that use GPUs", "Containers on HPC with Apptainer", "Intro to containers (on HPC)", "MPI programs and containers", "Python environment in a container", "Services and apps", "Sharing reproducible containers", "Tips, tricks and frequently asked questions", "Verify Apptainer Installation"], "terms": {"learn": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 11, 13], "what": [0, 2, 3, 4, 6, 9, 11], "method": [0, 1, 2, 5], "ar": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 11, 12, 13], "avail": [0, 2, 7, 8, 13], "multipl": [0, 2, 3, 5, 7, 10], "applic": [0, 2, 3, 4, 7, 8, 10, 11, 12, 13], "get": [0, 2, 4, 5, 8, 11], "termin": [0, 2, 4], "within": [0, 8], "we": [0, 2, 3, 4, 5, 6, 7, 8, 10, 11], "ll": [0, 1, 2, 5, 6, 7, 8, 10], "cover": [0, 3, 6], "individu": [0, 3, 8, 10], "section": [0, 2, 4, 8, 10, 11], "below": [0, 3, 8, 11], "": [0, 2, 3, 4, 6, 7, 8, 10, 11, 12, 13], "sometim": [0, 3, 9, 12], "have": [0, 1, 2, 3, 4, 5, 6, 7, 8, 10, 11, 13], "flag": [0, 2, 5], "which": [0, 3, 4, 6, 8, 11, 12, 13], "make": [0, 4, 5, 6, 7, 8, 10, 11, 13], "hard": [0, 11], "pars": 0, "line": [0, 8, 11], "A": [0, 3, 6, 7, 8, 11], "typic": [0, 3, 4, 8, 11], "ha": [0, 2, 3, 7, 8, 10, 11, 12], "i": [0, 1, 3, 4, 5, 8, 9, 10, 11, 13], "start": [0, 2, 3, 4, 5, 7, 8, 10, 11], "becaus": [0, 8, 11], "us": [0, 1, 3, 4, 6, 10, 12, 13], "client": [0, 3, 10], "subcommand": 0, "like": [0, 2, 3, 5, 7, 8, 10, 11], "pull": [0, 5, 11], "build": [0, 3, 5, 6, 8, 9, 10], "exec": [0, 1, 2, 5, 8, 10, 11, 12], "etc": [0, 2, 8], "tell": [0, 2], "featur": [0, 2, 7, 11, 13], "want": [0, 1, 2, 7, 10, 11], "often": [0, 2, 3, 7, 8, 10, 12], "after": [0, 2, 10, 11], "name": [0, 2, 3, 4, 7, 9, 10, 11], "imag": [0, 1, 4, 5, 6, 8, 10, 12], "At": 0, "end": [0, 2], "might": [0, 1, 3, 6, 7, 8, 10, 11, 12], "addit": [0, 1, 3, 5, 7, 11], "ignor": 0, "digest": 0, "itself": [0, 5, 11], "For": [0, 2, 3, 4, 7, 8, 10, 11, 12], "legibl": 0, "reason": [0, 11, 12], "mani": [0, 6, 7, 8, 11], "lesson": [0, 11, 13], "highlight": 0, "format": [0, 2, 3, 4, 6, 7, 11], "figur": [0, 1, 2, 3, 5, 7, 8, 10], "1": [0, 1, 2, 3, 5, 7, 8, 10], "comprehens": [0, 2], "list": [0, 2, 8, 9, 10, 11], "see": [0, 2, 3, 5, 6, 7, 8, 9, 10, 11, 12], "cli": 0, "refer": [0, 7, 11], "page": [0, 2, 6, 8, 10, 11], "exampl": [0, 1, 2, 3, 4, 6, 7, 12], "let": [0, 2, 3, 5, 6, 7, 8, 10, 11], "python": [0, 2, 5, 6, 7, 11], "docker": [0, 2, 4, 5, 7, 8, 9, 10, 11, 12], "hub": [0, 2, 3, 11], "now": [0, 2, 3, 5, 6, 8, 10, 11], "just": [0, 2, 3, 4, 6, 7, 11], "consid": [0, 3, 7], "creat": [0, 3, 4, 5, 7, 10, 11, 13], "follow": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13], "sif": [0, 1, 2, 3, 4, 5, 8, 9, 10, 11, 12], "talk": [0, 6, 7, 8], "about": [0, 7, 8, 11], "later": [0, 6, 7, 8, 11], "enough": [0, 2, 11, 13], "know": [0, 6, 8, 11, 13], "file": [0, 1, 3, 4, 7, 8, 10, 11, 12, 13], "instal": [0, 3, 4, 5, 6, 7, 8, 11], "mean": [0, 1, 2, 3, 7, 8, 11], "some": [0, 1, 2, 3, 4, 5, 6, 7, 8, 11], "specif": [0, 4, 7, 10], "creator": 0, "set": [0, 1, 8, 10, 11, 13], "default": [0, 1, 2, 8, 11], "when": [0, 1, 2, 3, 4, 5, 7, 10, 11], "execut": [0, 2, 4], "so": [0, 1, 2, 6, 8, 11, 13], "call": [0, 1, 2, 3, 5, 7, 8, 10, 12], "entri": [0, 10], "script": [0, 2, 5, 8, 10, 11], "runscript": [0, 2, 4, 8, 11], "specifi": [0, 2, 3, 4, 10, 11], "onli": [0, 1, 2, 3, 5, 11, 12, 13], "sourc": [0, 8, 11, 12], "trust": 0, "interpret": 0, "3": [0, 2, 3, 7, 8, 11], "12": [0, 5, 11], "main": [0, 5, 11], "apr": 0, "10": [0, 5, 6, 8], "2024": 0, "14": [0, 8], "35": [0, 8, 11], "18": [0, 8, 11], "gcc": [0, 8, 11], "2": [0, 1, 2, 3, 5, 7, 8, 10], "0": [0, 2, 5, 7, 8, 11], "linux": [0, 3, 7, 8, 11], "type": [0, 2, 6, 11], "help": [0, 1, 2, 4, 6, 9, 10, 11, 13], "copyright": 0, "credit": 0, "licens": 0, "more": [0, 2, 3, 6, 8, 10, 11, 12, 13], "inform": [0, 2, 3, 10, 13], "should": [0, 1, 2, 5, 8, 10, 11], "simpl": [0, 5, 11], "syntax": 0, "seem": 0, "self": [0, 7, 11], "evid": 0, "complex": [0, 2, 7, 13], "case": [0, 4, 5, 10, 11, 13], "give": [0, 1, 2, 3, 5, 7, 11], "variou": [0, 2, 7, 8, 13], "part": [0, 4, 6, 7], "bash": [0, 5, 8, 13], "echo": [0, 2, 8, 11], "bin": [0, 5, 8, 11], "The": [0, 1, 2, 3, 4, 5, 7, 8, 10, 11, 12, 13], "base": [0, 2, 3, 4, 5, 6, 7, 8], "debian": [0, 11], "distribut": [0, 5], "check": [0, 2, 10, 11, 13], "version": [0, 2, 4, 8, 13], "cat": [0, 5, 9], "debian_vers": 0, "With": [0, 7, 11], "print": [0, 2, 3, 5], "content": [0, 2, 4], "5": [0, 8, 11], "4": [0, 2, 5, 8], "my_imag": 0, "my_program": 0, "arg1": 0, "arg2": 0, "how": [1, 2, 4, 5, 6, 9, 10, 11, 12, 13], "you": [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13], "can": [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13], "launch": [1, 2, 3, 5, 7, 8, 10], "program": [1, 3, 5, 6, 7, 9, 12], "run": [1, 3, 4, 6, 7, 8, 9, 10, 11, 12], "environ": [1, 4, 6, 7, 8, 10, 11, 13], "system": [1, 2, 3, 4, 5, 7, 8, 11, 12, 13], "same": [1, 7, 8, 11], "structur": 1, "machin": [1, 7, 8], "work": [1, 3, 4, 5, 6, 11, 13], "data": [1, 2, 10], "need": [1, 3, 4, 5, 6, 7, 8, 10, 11], "bring": 1, "thi": [1, 2, 3, 4, 6, 7, 9, 10, 11, 12, 13], "world": 1, "insid": [1, 2, 5, 7, 8, 11, 12], "done": [1, 3, 5, 8, 10, 11], "via": [1, 2, 3, 7, 8, 11], "mount": [1, 5, 8, 10, 11, 12], "from": [1, 3, 4, 5, 7, 8, 9, 10, 11, 12], "host": [1, 7, 8, 11, 12], "map": 1, "By": [1, 2], "home": [1, 2, 7, 11, 12], "cwd": 1, "current": 1, "directori": [1, 2, 8, 10, 12, 13], "tmp": [1, 8], "few": [1, 5, 11], "other": [1, 2, 3, 6, 7, 8, 10, 11, 13], "path": [1, 4, 8, 11, 12], "bound": [1, 8, 12], "If": [1, 2, 5, 6, 7, 11, 12], "do": [1, 2, 3, 4, 6, 7, 8, 10, 11, 13], "an": [1, 3, 4, 5, 6, 7, 8, 10, 11, 13], "extra": [1, 8, 11], "argument": [1, 2, 8, 10, 11], "command": [1, 3, 4, 5, 7, 10, 13], "re": [1, 2, 5, 7, 10, 12], "would": [1, 2, 7, 10, 11], "scratch": [1, 2, 11], "apptain": [1, 4, 5, 8, 10, 11, 12], "l": [1, 10], "shell": [1, 2, 4, 13], "well": [1, 3, 5, 6, 7, 8, 10, 11], "also": [1, 2, 6, 7, 8, 10, 11, 12, 13], "differ": [1, 3, 4, 6, 7, 8, 11, 12, 13], "place": [1, 3, 11], "especi": [1, 7], "code": [1, 2, 5, 8, 10, 11, 13], "expect": [1, 11], "outsid": [1, 2, 7, 8, 11, 12], "delet": 1, "complet": [1, 7], "manual": [1, 12], "them": [1, 2, 4, 7, 8, 10, 11, 12], "In": [2, 3, 4, 7, 8, 10, 11, 13], "session": 2, "discuss": [2, 6, 11], "wai": [2, 3, 7, 8, 11], "alreadi": [2, 9], "seen": [2, 11], "could": [2, 11], "altern": 2, "full": [2, 4], "url": 2, "io": [2, 5, 11], "librari": [2, 4, 5, 7, 8, 11], "latest": [2, 8, 9, 11], "registry_url": 2, "user_namespac": 2, "image_nam": 2, "image_tag": 2, "here": [2, 7, 11], "compat": [2, 11, 13], "There": [2, 7, 8, 11], "quai": [2, 11], "github": [2, 9], "read": [2, 6], "repositori": [2, 8, 9, 11, 12], "first": [2, 6, 8, 13], "download": [2, 8, 11], "ani": [2, 7, 12, 13], "Then": 2, "squash": [2, 3], "all": [2, 3, 4, 6, 7, 8, 9, 10, 11, 13], "one": [2, 3, 7, 8, 10, 11, 12], "These": [2, 7, 8, 9, 10, 12], "store": [2, 3, 7, 11, 13], "folder": [2, 6, 10, 11, 12, 13], "apptainer_cachedir": [2, 13], "cach": [2, 11], "out": [2, 5, 6, 8, 9, 11], "quota": 2, "big": [2, 11], "mkdir": [2, 8, 10, 11, 13], "apptainer_cach": 2, "export": [2, 4, 5, 8, 10, 11, 13], "pwd": 2, "It": [2, 3, 6, 7, 8, 11], "advic": 2, "select": [2, 11], "locat": [2, 10], "filesystem": [2, 3, 7, 9, 12], "space": [2, 3, 13], "instanc": [2, 10, 11], "area": [2, 3], "hpc": [2, 4, 8, 13], "statu": 2, "clean": [2, 9, 11, 12], "sai": 2, "summat": [2, 11], "py": [2, 5, 11], "import": [2, 5, 8, 11, 13], "argpars": 2, "parser": 2, "argumentpars": 2, "add_argu": 2, "number": [2, 8, 11, 13], "sum": 2, "int": 2, "narg": 2, "arg": 2, "parse_arg": 2, "len": 2, "f": [2, 8, 9], "wa": [2, 3, 7, 8, 11], "els": 2, "did": [2, 10, 11], "me": 2, "bootstrap": [2, 4, 5, 8, 9, 10, 11, 12], "opt": [2, 8, 9, 11, 12], "got": [2, 11], "copi": [2, 3, 4, 8, 11, 12], "block": [2, 4, 10, 11, 12], "ran": [2, 10, 11], "built": [2, 3, 8, 11, 12], "my_contain": [2, 11, 12], "my_container_definit": 2, "def": [2, 3, 4, 5, 8, 9], "test": [2, 8, 9, 10], "two": [2, 11], "send": [2, 8, 11], "being": 2, "produc": 2, "output": [2, 4, 5, 8, 11], "analog": [2, 3], "much": [2, 6, 11], "interfac": [2, 7, 8], "convert": 2, "basic": [2, 4, 6, 7], "singl": [2, 3, 4, 10], "than": [2, 3, 5, 7, 10], "involv": [2, 8, 13], "post": [2, 4, 5, 8, 9, 11, 12], "onc": [2, 10, 11, 12], "procedur": 2, "modifi": [2, 3, 8, 10, 11, 12], "our": [2, 10, 11], "numpi": [2, 9, 11], "packag": [2, 5, 8, 9, 11, 12], "pip": [2, 5, 11], "c": [2, 4, 5, 8, 10, 11], "__version__": 2, "26": [2, 8, 11], "step": [2, 3, 4, 8, 13], "setup": [2, 3, 10], "state": [2, 8], "fakeroot": 2, "where": [2, 3, 6, 8, 11, 13], "look": [2, 3, 5, 10], "realiti": 2, "normal": [2, 3, 7, 8], "sudo": 2, "manag": [2, 7, 8, 11, 13], "instruct": [2, 7, 8], "written": [2, 11], "non": 2, "container": [2, 4, 8, 13], "usual": [2, 6, 7, 8], "remov": [2, 12], "front": 2, "secret": 2, "password": [2, 10], "sensit": [2, 11], "anybodi": [2, 11], "who": [2, 11, 12], "access": [2, 5, 6, 11, 12], "while": [2, 4, 6, 8], "appli": [2, 4], "opportun": 2, "languag": [2, 9, 10], "veri": [2, 9, 10, 11], "common": [2, 3, 7, 8, 11], "lc_all": [2, 4, 10, 11], "lang": [2, 10, 11], "valu": 2, "o": [2, 3, 7, 11], "getenv": 2, "rebuild": 2, "myvar": 2, "ye": [2, 8, 9], "apptainerenv_myvar": 2, "myvalu": 2, "env": 2, "info": [2, 7, 8, 12], "plan": [2, 10, 11], "share": [2, 6, 7, 8], "peopl": [2, 6], "keep": [2, 3], "tab": [2, 11], "label": [2, 4, 9, 11], "mark": 2, "add": [2, 4, 11], "author": [2, 11], "coderefineri": 2, "v0": 2, "descript": [2, 11], "up": [2, 3, 6, 10, 11, 12], "messag": [2, 8], "someth": [2, 3, 6, 11], "softwar": [2, 4, 7, 8, 11, 13], "inspect": [2, 11], "org": [2, 8], "schema": 2, "arch": 2, "amd64": 2, "date": [2, 4, 6], "thursday_25_april_2024_21": 2, "45": 2, "51_eest": 2, "usag": [2, 6, 7, 10, 11], "singular": [2, 3, 8, 11], "deffil": 2, "id": [2, 7], "group": [2, 7], "link": [2, 11], "posit": 2, "none": [2, 7], "32176": 2, "32385": 2, "34957": 2, "json": 2, "gener": [2, 8, 11], "35407": 2, "36864": 2, "394522624": 2, "squashf": [2, 3], "previou": 2, "dump": 2, "plenti": 2, "great": 2, "includ": [2, 3, 7, 11], "callabl": 2, "servic": [2, 6, 11], "stop": [2, 10], "custom": [2, 9, 11], "provid": [2, 3, 7, 8, 11], "thei": [3, 7, 8, 9, 10, 11, 13], "oper": [3, 4, 7, 12, 13], "come": [3, 6], "analogi": 3, "paint": 3, "saint": 3, "jerom": 3, "wilder": 3, "leonardo": 3, "da": 3, "vinci": 3, "abov": [3, 4, 11], "unfinish": 3, "natur": [3, 7], "background": [3, 10], "panel": 3, "touch": 3, "e": [3, 4, 11, 13], "g": [3, 4, 8, 11, 13], "hand": [3, 4, 11], "sketch": 3, "lion": 3, "most": [3, 6, 7, 8, 10, 11], "color": 3, "top": [3, 11], "left": [3, 6], "thing": [3, 6, 11], "gather": 3, "construct": [3, 4, 8], "layer": 3, "hidden": 3, "underneath": 3, "happen": [3, 4], "consist": [3, 4], "hide": [3, 12], "preced": 3, "practic": [3, 6, 13], "overwrit": 3, "behaviour": 3, "fashion": 3, "doe": [3, 6, 7, 8, 11, 12], "its": [3, 7, 11, 13], "modif": 3, "were": [3, 5, 8, 11], "new": [3, 10, 11, 12], "unless": [3, 11], "last": 3, "tag": [3, 11], "human": 3, "readabl": 3, "publish": [3, 11], "user": [3, 7, 8, 10, 11, 12], "sent": 3, "registri": 3, "dockerfil": [3, 11], "true": [3, 5], "reduc": [3, 7], "network": [3, 7, 8], "capac": 3, "transfer": 3, "fetch": [3, 10], "organ": [3, 12], "each": [3, 6, 10, 11], "tri": 3, "find": [3, 11], "go": [3, 6, 11], "through": [3, 4, 11, 13], "until": [3, 6, 10, 11], "light": 3, "bounc": 3, "off": 3, "tool": [3, 4, 6, 7, 8, 13], "tar": [3, 8], "bit": [3, 6, 11], "metadata": 3, "instead": [3, 7, 8, 10, 11, 12], "write": [3, 9], "piec": [3, 12], "paper": [3, 7], "replic": 3, "topmost": 3, "visibl": [3, 5, 12], "unchang": [3, 11], "upsid": 3, "downsid": 3, "portabl": [3, 4, 7], "One": [3, 11], "easili": [3, 4, 7], "across": [3, 4, 8], "reproduc": [3, 4, 6, 7], "easier": 3, "archiv": 3, "track": [3, 11], "creation": [3, 9, 11], "take": [3, 7, 8], "longer": [3, 11], "cannot": [3, 4], "runtim": [3, 5, 7, 8], "definit": [3, 4, 8, 10, 11, 12, 13], "cc0": 3, "wikimedia": [3, 7], "understand": [4, 6, 7, 13], "concept": 4, "util": [4, 5, 11, 13], "knowledg": 4, "comput": [4, 5, 6, 7, 8, 11, 13], "demo": [4, 6, 13], "crucial": [4, 13], "scalabl": 4, "isol": 4, "underli": 4, "infrastructur": 4, "guid": [4, 13], "process": [4, 7, 8, 13], "defin": [4, 7, 10], "foundat": [4, 7, 13], "skill": [4, 11, 13], "effect": 4, "high": [4, 6, 8, 13], "perform": [4, 6, 8, 13], "No": [4, 11, 13], "signific": 4, "technologi": [4, 7], "sure": [4, 11, 13], "cluster": [4, 6, 7, 8, 13], "admin": 4, "certain": [4, 8, 10], "realli": [4, 12], "tight": 4, "wide": 4, "depend": [4, 6, 8, 9, 12], "compil": [4, 8, 11, 12], "sake": 4, "assum": 4, "three": 4, "fortun": 4, "cowsai": 4, "lolcat": 4, "strict": 4, "requir": [4, 9, 10, 11, 12], "yourself": [4, 11], "without": [4, 7, 12], "root": [4, 12], "privileg": [4, 7, 12], "ubuntu": [4, 8, 11, 12], "24": [4, 8], "04": [4, 8, 12], "apt": [4, 8, 11], "y": [4, 8, 9, 11], "updat": [4, 8, 11], "usr": [4, 8, 11, 12], "game": 4, "save": 4, "mydefinit": 4, "next": [4, 6, 11], "mycontain": 4, "essenti": [4, 11, 13], "necessari": [4, 13], "compon": [4, 8], "show": [4, 6, 11], "ve": [4, 6], "critic": [4, 12, 13], "enabl": [4, 5, 8], "rang": 4, "scientif": [4, 9, 11, 13], "capabl": [4, 13], "leverag": 4, "potenti": [4, 11], "resourc": [4, 6, 7, 8, 11], "ensur": [4, 13], "explain": 4, "past": 4, "point": [4, 12, 13], "text": [4, 5, 11], "submit": 4, "homework": 4, "your": [5, 6, 7, 8, 10, 12, 13], "must": [5, 6, 8, 11], "correct": 5, "cuda": 5, "toolkit": 5, "rocm": 5, "support": [5, 7, 8, 11], "driver": [5, 8], "devic": 5, "framework": 5, "nv": 5, "As": [5, 11], "pytorch": 5, "accelerate_cuda": 5, "torch": 5, "is_avail": 5, "rocm6": 5, "1_ubuntu22": 5, "04_py3": 5, "10_pytorch_2": 5, "design": [5, 6, 7], "exist": [5, 11], "miss": 5, "cuda12": 5, "cudnn8": 5, "evalu": 5, "dataset": [5, 10, 11], "scipi": 5, "scikit": 5, "transform": 5, "submiss": [5, 8], "run_accelerate_cuda": 5, "sh": [5, 8, 10], "sbatch": [5, 8], "mem": [5, 8], "32g": 5, "node": [5, 8, 11], "ntask": [5, 8], "per": [5, 8], "task": [5, 8, 13], "cpu": [5, 7, 8], "time": [5, 8], "00": [5, 8], "omp_num_thread": 5, "slurm_cpus_per_task": 5, "slurm_gpus_on_nod": 5, "torchrun": 5, "nproc_per_nod": 5, "nlp_exampl": 5, "mixed_precis": 5, "fp16": 5, "triton": [5, 8], "aalto": [5, 8], "To": [5, 8, 9, 11], "srun": [5, 8], "01": [5, 8], "wget": [5, 8], "http": [5, 8, 9, 11], "raw": 5, "githubusercont": 5, "com": [5, 8, 9, 11], "huggingfac": 5, "ref": 5, "head": 5, "weight": 5, "bertforsequenceclassif": 5, "initi": [5, 8], "checkpoint": 5, "bert": 5, "newli": [5, 10], "classifi": 5, "bia": 5, "probabl": [5, 6, 11], "down": [5, 10, 11], "stream": 5, "abl": [5, 11], "predict": 5, "infer": 5, "berttokenizerfast": 5, "token": 5, "pleas": [5, 11], "note": [5, 8, 10, 11], "fast": 5, "__call__": 5, "faster": 5, "encod": 5, "pad": 5, "epoch": 5, "accuraci": 5, "7598039215686274": 5, "f1": 5, "8032128514056225": 5, "8480392156862745": 5, "8931034482758621": 5, "8406862745098039": 5, "888507718696398": 5, "calcul": 5, "given": 6, "yet": 6, "known": 6, "registr": 6, "open": [6, 7, 8, 11], "though": 6, "improv": 6, "workflow": [6, 7, 13], "had": 6, "actual": [6, 7], "tip": [6, 11], "aren": 6, "t": [6, 11], "either": [6, 8, 12], "advanc": [6, 11, 13], "won": 6, "deep": 6, "topic": 6, "everyth": [6, 11], "possibl": [6, 7, 10, 11], "right": [6, 11], "firesid": 6, "chat": 6, "expert": 6, "combin": 6, "along": 6, "independ": 6, "engag": 6, "level": 6, "interest": 6, "don": [6, 11], "sens": 6, "pick": [6, 8], "anywai": 6, "experi": 6, "technic": 6, "option": 6, "allow": [6, 8, 10], "materi": [6, 8, 11], "deeper": 6, "slurm": [6, 8], "dai": [6, 8], "still": [6, 7, 11, 12], "15": [6, 8], "min": [6, 8], "intro": 6, "20": [6, 8], "break": 6, "25": [6, 8], "bind": [6, 8, 10, 11, 12], "05": [6, 8], "mpi": 6, "gpu": 6, "app": [6, 11], "trick": 6, "frequent": 6, "ask": [6, 8, 11], "question": [6, 11], "verifi": 6, "larger": [6, 10], "extrem": 6, "direct": [6, 8], "learner": 6, "persona": 6, "taken": [6, 8], "mostli": 6, "pice": 6, "wonder": 6, "fit": 6, "togeth": 6, "whole": 6, "care": [6, 8, 11], "real": [6, 11], "wouldn": 6, "mind": 6, "scope": 6, "stuff": 6, "long": 6, "spend": 6, "too": [6, 11, 12], "mental": 6, "effort": 6, "watch": 6, "rest": 6, "back": [6, 12], "been": [6, 8, 10, 11, 12], "fine": 6, "think": [6, 7, 11], "life": 6, "even": 6, "better": [6, 11], "attend": 6, "passiv": 6, "tuesdai": 6, "techniqu": 6, "logic": 7, "term": 7, "behind": 7, "ship": [7, 11], "habitat": 7, "analogu": 7, "idea": [7, 11], "barrier": 7, "between": [7, 8], "port": 7, "easi": 7, "storag": 7, "chapter": 7, "launcher": [7, 8], "podman": 7, "kubernet": [7, 11], "aspect": 7, "worri": 7, "namespac": 7, "implement": [7, 8], "separ": 7, "identifi": 7, "pid": 7, "virtual": [7, 11], "commun": [7, 8], "limit": 7, "ram": 7, "control": 7, "cgroup": 7, "meant": 7, "superus": 7, "exact": [7, 8], "necessarili": [7, 8], "chang": [7, 8, 11], "both": [7, 8, 11], "guest": [7, 12], "own": [7, 8, 10, 12], "word": 7, "colleagu": 7, "finish": 7, "amount": 7, "put": [7, 11, 12], "project": [7, 8, 11], "lawrenc": 7, "berkelei": 7, "nation": 7, "laboratori": 7, "2015": 7, "2018": 7, "compani": [7, 11], "sylab": 7, "found": [7, 10, 11], "commerci": 7, "site": [7, 8], "2021": 7, "join": 7, "renam": 7, "present": 7, "maintain": 7, "fork": 7, "singulartyc": 7, "wikipedia": 7, "articl": 7, "singularityc": 7, "bellarena": 7, "rossograph": 7, "cc": [7, 8], "BY": 7, "sa": 7, "complic": [8, 10], "pass": 8, "standard": [8, 12], "api": 8, "paradigm": 8, "thousand": [8, 9], "commonli": [8, 12], "tradit": 8, "handl": 8, "scale": 8, "ti": 8, "speed": 8, "queue": 8, "problem": [8, 11], "job": 8, "fail": 8, "bad": [8, 12], "correctli": [8, 13], "issu": 8, "solv": 8, "reserv": 8, "mpirun": 8, "librarir": 8, "against": [8, 10], "collect": 8, "pmi": 8, "pmi2": 8, "pmix": 8, "connect": [8, 10], "unifi": 8, "x": 8, "hybrid": 8, "model": [8, 11], "benchmark": 8, "osu": 8, "micro": 8, "suit": [8, 11], "whether": [8, 13], "puhti": 8, "csc": 8, "lumi": 8, "sigma2": 8, "norwai": 8, "openmpi": 8, "nproc": 8, "openmpi_vers": 8, "6": 8, "osu_micro_benchmarks_vers": 8, "7": [8, 11], "gfortran": 8, "bzip2": 8, "ca": 8, "certif": 8, "libucx": 8, "dev": [8, 11], "openmpi_version_short": 8, "cut": 8, "d": 8, "cd": [8, 11], "ompi": 8, "q": [8, 9], "releas": 8, "v": 8, "bz2": 8, "xvf": 8, "configur": 8, "prefix": 8, "ucx": 8, "j": 8, "rm": [8, 11], "rf": [8, 11], "ompi_dir": 8, "ld_library_path": 8, "lib": [8, 10, 11], "mvapich": 8, "cse": 8, "ohio": 8, "edu": 8, "gz": 8, "xf": 8, "mpicc": 8, "cflag": 8, "o3": 8, "manpath": 8, "man": 8, "libexec": 8, "pt2pt": 8, "osu_bw": 8, "16g": 8, "paramet": 8, "prevent": 8, "error": 8, "modul": 8, "load": 8, "pmix_mca_gd": 8, "hash": 8, "ucx_posix_use_proc_link": 8, "n": [8, 9], "ompi_mca_orte_top_session_dir": 8, "partit": 8, "batch": 8, "milan": 8, "2g": 8, "3521915": 8, "queu": 8, "wait": 8, "alloc": 8, "bandwidth": 8, "v7": 8, "datatyp": 8, "mpi_char": 8, "size": 8, "mb": 8, "98": 8, "8": [8, 11], "91": 8, "32": 8, "03": 8, "16": [8, 10, 12], "64": 8, "125": 8, "47": 8, "245": 8, "52": 8, "128": 8, "469": 8, "256": 8, "877": 8, "69": 8, "512": 8, "1671": 8, "1024": 8, "3218": 8, "11": [8, 11], "2048": 8, "5726": 8, "4096": 8, "8096": 8, "8192": 8, "10266": 8, "16384": 8, "11242": 8, "78": 8, "32768": 8, "11298": 8, "70": 8, "65536": 8, "12038": 8, "27": 8, "131072": 8, "12196": 8, "28": 8, "262144": 8, "12202": 8, "524288": 8, "11786": 8, "58": 8, "1048576": 8, "12258": 8, "48": 8, "2097152": 8, "12179": 8, "43": 8, "4194304": 8, "12199": 8, "89": 8, "rockylinux": 8, "os_vers": 8, "4rc1": 8, "gcc_version": 8, "9": [8, 11], "ucx_vers": 8, "13": 8, "os_nam": 8, "rhel": 8, "ofed_vers": 8, "newer": 8, "dnf": 8, "plugin": 8, "core": 8, "epel": 8, "config": [8, 11], "powertool": 8, "gdb": 8, "numactl": 8, "devel": 8, "toolset": 8, "rh": 8, "mellanox": 8, "OFED": 8, "rpm": 8, "repo": [8, 11], "www": 8, "ofed": 8, "gpg": 8, "yum": 8, "public": 8, "mlnx_ofe": 8, "mellanox_mlnx_of": 8, "rdma": 8, "ib": 8, "knem": 8, "cma": 8, "rdmacm": 8, "account": 8, "project_xxxxxxx": 8, "larg": [8, 11], "23736111": 8, "17": 8, "41": 8, "63": 8, "82": 8, "166": 8, "40": 8, "310": 8, "73": 8, "477": 8, "56": 8, "1162": 8, "51": 8, "2250": 8, "29": 8, "3941": 8, "94": 8, "6174": 8, "39": 8, "8029": 8, "10120": 8, "93": 8, "10632": 8, "10892": 8, "60": 8, "11609": 8, "92": 8, "11778": 8, "12015": 8, "96": 8, "11970": 8, "12008": 8, "62": 8, "12050": 8, "12058": 8, "36": 8, "mpich": 8, "mpich_vers": 8, "strace": 8, "recommend": 8, "static": 8, "disabl": 8, "fortran": 8, "ldconfig": 8, "laptop": 8, "afterward": 8, "easybuild": 8, "23": 8, "09": 8, "eb": 8, "cpegnu": 8, "noglibc": 8, "r": [8, 11, 12], "singularity_bind": 8, "lib64": 8, "libnl": 8, "200": 8, "project_xxxxxxxxx": 8, "8108520": 8, "65": 8, "57": 8, "130": 8, "49": 8, "260": 8, "55": 8, "492": 8, "983": 8, "37": 8, "1965": 8, "42": 8, "3924": 8, "7823": 8, "14349": 8, "54": 8, "17373": 8, "18896": 8, "90": 8, "20906": 8, "21811": 8, "68": 8, "22228": 8, "22430": 8, "80": 8, "22537": 8, "22592": 8, "50": 8, "22619": 8, "order": [8, 11], "approach": [8, 11, 12], "describ": 8, "explan": [8, 12], "infiniband": 8, "38": 8, "crai": 8, "var": [8, 10, 11], "spool": 8, "conf": 8, "nsswitch": 8, "resolv": 8, "ssl": 8, "openssl": [8, 11], "cnf": 8, "cxi": 8, "libbrotlicommon": 8, "libbrotlidec": 8, "libcrypto": 8, "libcurl": 8, "libcxi": 8, "libgssapi_krb5": 8, "libidn2": 8, "libjansson": 8, "libjitterentropi": 8, "libjson": 8, "libk5crypto": 8, "libkeyutil": 8, "libkrb5": 8, "libkrb5support": 8, "liblber": 8, "libldap_r": 8, "libnghttp2": 8, "libpcr": 8, "libpsl": 8, "libsasl2": 8, "libssh": 8, "libssl": [8, 11], "libunistr": 8, "libzstd": 8, "libselinux": 8, "singularityenv_ld_library_path": 8, "pe": 8, "ofi": 8, "gnu": 8, "libfabr": 8, "xpmem": 8, "explicitli": 8, "binari": [8, 12], "anoth": [8, 11, 12], "quit": [8, 10, 12], "howev": [8, 11], "famili": 8, "e4": 8, "wi4mpi": 8, "wrapper": 8, "aim": 8, "bypass": 8, "dure": [8, 11], "classic": 8, "molecular": 8, "dynam": 8, "simul": 8, "focu": [8, 11], "lammps_vers": 8, "29aug2024": 8, "cmake": 8, "cmake_prefix_path": 8, "b": 8, "dcmake_install_prefix": 8, "dbuild_mpi": 8, "dbuild_omp": 8, "parallel": 8, "target": [8, 11], "cp": [8, 12], "lammps_dir": 8, "lmp": 8, "indent": 8, "push": [8, 11], "run_lammps_ind": 8, "lammps_ind": 8, "tail": 8, "loop": 8, "752293": 8, "proc": 8, "30000": 8, "420": 8, "atom": 8, "10336396": 8, "152": 8, "tau": 8, "39878": 8, "072": 8, "timestep": 8, "749": 8, "matom": 8, "99": 8, "openmp": 8, "thread": 8, "breakdown": 8, "avg": 8, "max": 8, "varavg": 8, "total": 8, "pair": 8, "31927": 8, "37377": 8, "42578": 8, "neigh": 8, "016316": 8, "020162": 8, "023961": 8, "comm": 8, "19882": 8, "25882": 8, "31814": 8, "34": 8, "00033215": 8, "00038609": 8, "00054361": 8, "044981": 8, "049941": 8, "054024": 8, "04921": 8, "nlocal": 8, "105": 8, "av": 8, "112": 8, "histogram": 8, "nghost": 8, "892": 8, "1003": 8, "788": 8, "neighbor": 8, "3569": 8, "497619": 8, "634": 8, "danger": 8, "wall": 8, "527178": 8, "14750222": 8, "558": 8, "56906": 8, "723": 8, "901": 8, "22956": 8, "26147": 8, "28984": 8, "012471": 8, "015646": 8, "018613": 8, "97": 8, "13816": 8, "17729": 8, "2192": 8, "33": [8, 11], "00023943": 8, "00024399": 8, "00025267": 8, "03212": 8, "035031": 8, "037378": 8, "0375": 8, "match": 8, "maximum": 8, "nowadai": 9, "popular": 9, "due": 9, "problemat": 9, "panda": 9, "python_definit": 9, "python_environ": 9, "simo": 9, "tuomisto": 9, "micromamba": 9, "yml": 9, "channel": 9, "forg": 9, "obtain": 9, "micromamba_apptain": 9, "mambaorg": 9, "environmentfil": 9, "my_environ": 9, "databas": [10, 11], "subset": 10, "kind": 10, "variabl": [10, 11, 13], "entrypoint": 10, "server": [10, 11], "postgr": 10, "startscript": 10, "postgres_us": 10, "pguser": 10, "postgres_password": 10, "pgpassword": 10, "pghost": 10, "hostnam": 10, "pgport": 10, "19200": 10, "runfil": 10, "postgres_data": 10, "postgres_run": 10, "postgres_contain": 10, "postgres_serv": 10, "apprun": 10, "psql": 10, "apphelp": 10, "beforehand": 10, "coupl": 10, "u": [10, 11], "document": [10, 12, 13], "notic": 10, "again": [10, 11], "made": 10, "shut": 10, "good": 11, "guidelin": 11, "todai": 11, "hopefulli": 11, "year": 11, "futur": 11, "encourag": 11, "And": 11, "final": 11, "pack": 11, "upon": 11, "try": [11, 12], "customis": 11, "offici": 11, "extens": 11, "detect": 11, "mai": [11, 13], "luck": 11, "dockerhub": 11, "click": 11, "bookworm": 11, "lead": 11, "buildpack": 11, "dep": 11, "navig": 11, "tree": 11, "origin": 11, "scm": 11, "curl": 11, "suitabl": 11, "almost": 11, "whatev": 11, "web": 11, "search": [11, 13], "best": 11, "ones": 11, "alpin": 11, "slim": 11, "busybox": 11, "nginx": 11, "postgresql": 11, "develop": [11, 12], "mysql": 11, "jupyt": 11, "datasci": 11, "notebook": 11, "chose": 11, "explor": [11, 13], "exactli": 11, "But": 11, "move": [11, 13], "mayb": 11, "Or": 11, "spoil": 11, "parti": 11, "massiv": 11, "alwai": 11, "proof": 11, "compar": 11, "further": 11, "recogn": 11, "tempt": 11, "conveni": 11, "analysi": 11, "input": 11, "favourit": 11, "editor": 11, "fulfil": 11, "benefit": 11, "least": 11, "fold": 11, "lighter": 11, "quicker": 11, "smaller": 11, "carbon": 11, "footprint": 11, "less": 11, "clearer": 11, "sever": 11, "why": 11, "becom": 11, "heavi": 11, "resid": 11, "privat": 11, "secur": 11, "detail": 11, "result": 11, "exemplifi": 11, "directli": 11, "process_data": 11, "input_data": 11, "output_data": 11, "chmod": 11, "777": 11, "writabl": 11, "tmpf": 11, "this_contain": 11, "That": 11, "said": 11, "particular": 11, "avoid": 11, "obviou": 11, "ad": 11, "under": [11, 12], "rememb": [11, 12], "minim": 11, "gitlab": 11, "findabl": 11, "principl": 11, "theori": 11, "pre": [11, 12], "anymor": 11, "everi": 11, "tech": 11, "offer": 11, "ci": 11, "integr": 11, "googl": 11, "gcr": 11, "gcp": 11, "tightli": 11, "cloud": 11, "azur": 11, "acr": 11, "fulli": 11, "ak": 11, "devop": 11, "red": 11, "hat": 11, "scan": 11, "openshift": 11, "jfrog": 11, "artifactori": 11, "univers": 11, "artifact": 11, "harbor": 11, "role": 11, "vulner": 11, "sign": 11, "digitalocean": 11, "seamlessli": 11, "pipelin": 11, "warn": 11, "free": [11, 13], "tomorrow": 11, "backup": 11, "price": 11, "stabl": 11, "zenodo": 11, "excel": 11, "doi": 11, "unlik": 11, "academ": 11, "close": 11, "recip": [11, 13], "demonstr": 11, "imagin": 11, "situat": 11, "research": 11, "nice": 11, "adapt": 11, "upload": 11, "luckili": 11, "anticip": 11, "reusabl": 11, "virtual_env": 11, "venv": 11, "libgomp1": 11, "python3": 11, "distutil": 11, "m": 11, "activ": 11, "dir": 11, "upgrad": 11, "txt": 11, "myself": 11, "workaround": 11, "fix": 11, "fancylib": 11, "utf": 11, "evolv": 11, "30": 11, "disk": [11, 13], "person": 11, "somewher": 11, "contact": 11, "address": 11, "contribut": 11, "debian_frontend": 11, "noninteract": 11, "git": 11, "pkg": 11, "libz": 11, "libbz2": 11, "liblzma": 11, "libcurl4": 11, "libgsl": 11, "clone": 11, "recurs": 11, "someus": 11, "sometool": 11, "action": 11, "advantag": 11, "inspir": 11, "rather": 11, "request": 11, "goal": 11, "era": 12, "old": 12, "glibc": 12, "third": 12, "wrong": 12, "assumpt": 12, "caus": 12, "permiss": 12, "headach": 12, "thu": 12, "local": 12, "hierarchi": 12, "persist": 12, "overlai": 12, "decid": 12, "everyon": 12, "src": 12, "unnecessari": 12, "header": 12, "multi": 12, "stage": 12, "those": [12, 13], "gain": 13, "befor": 13, "affect": 13, "contain": 13, "properli": 13, "confirm": 13, "subsequ": 13, "relat": 13, "presenc": 13, "teach": 13, "troubleshoot": 13, "determin": 13, "displai": 13, "function": 13, "proce": 13, "confid": 13, "onlin": 13, "cachedir": 13, "tmpdir": 13, "environemnt": 13, "subfold": 13, "temporari": 13, "wrkdir": 13, "apptainercach": 13, "apptainertemp": 13, "apptainer_tmpdir": 13}, "objects": {}, "objtypes": {}, "objnames": {}, "titleterms": {"basic": 0, "run": [0, 2, 5], "contain": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12], "object": [0, 1, 2, 3, 4, 5, 7, 8, 9, 11, 13], "differ": 0, "wai": 0, "you": 0, "can": 0, "your": [0, 1, 2, 4, 11], "how": [0, 7, 8], "read": 0, "apptain": [0, 2, 3, 6, 7, 9, 13], "command": [0, 2], "obtain": 0, "from": [0, 2], "registri": [0, 2, 11], "expect": [0, 2, 5], "result": [0, 2, 5], "launch": 0, "an": [0, 2, 9, 12], "interact": 0, "shell": 0, "singl": 0, "program": [0, 8], "review": [0, 5, 8], "thi": [0, 5, 8], "session": [0, 5, 8], "kei": [0, 1, 2, 3, 5, 7, 8, 10, 11], "point": [0, 1, 2, 3, 5, 7, 8, 10, 11], "rememb": [0, 1, 2, 3, 5, 7, 8, 10], "bind": 1, "folder": 1, "build": [2, 4, 11, 12], "imag": [2, 3, 7, 9, 11], "pull": 2, "exist": [2, 12], "handl": 2, "temporari": 2, "layer": 2, "need": [2, 12], "process": 2, "creat": [2, 8, 9], "us": [2, 5, 7, 8, 9, 11], "specif": [2, 11], "file": [2, 9], "addit": 2, "instal": [2, 9, 12, 13], "dure": 2, "creation": 2, "i": [2, 6, 7, 12], "done": 2, "fake": 2, "root": 2, "user": 2, "set": 2, "environ": [2, 9, 12], "variabl": 2, "ad": 2, "document": [2, 11], "examin": 2, "definit": [2, 9], "option": 2, "intro": [3, 7], "tradit": [3, 7], "docker": 3, "etc": 3, "sourc": [3, 7], "first": 4, "prerequisit": [4, 6, 13], "summari": [4, 13], "simpl": [4, 8], "test": 4, "gpu": 5, "nvidia": 5, "": [5, 9], "amd": 5, "exampl": [5, 8, 10, 11], "model": 5, "train": 5, "acceler": 5, "hpc": [6, 7], "cours": 6, "instanc": 6, "mai": 6, "2024": 6, "The": 6, "lesson": 6, "extra": 6, "exercis": [6, 9, 11], "who": 6, "about": 6, "what": [7, 8, 10], "even": 7, "more": 7, "technic": 7, "inform": 7, "work": [7, 8], "intend": 7, "case": 7, "v": 7, "singular": 7, "mpi": 8, "consid": 8, "when": [8, 12], "util": 8, "fast": 8, "interconnect": 8, "abi": 8, "compat": 8, "portabl": 8, "lammp": 8, "python": 9, "background": 9, "1": [9, 11], "pip": 9, "base": [9, 11], "solut": [9, 11, 13], "2": [9, 11], "conda": [9, 12], "mamba": 9, "optim": 9, "servic": 10, "app": 10, "ar": 10, "postgresql": 10, "share": 11, "reproduc": 11, "reus": 11, "depend": 11, "take": 11, "awai": 11, "messag": 11, "popular": 11, "Be": 11, "separ": 11, "concern": 11, "purpos": 11, "stai": 11, "data": 11, "practic": 11, "version": 11, "control": 11, "public": 11, "recommend": 11, "guarante": 11, "long": 11, "term": 11, "avail": 11, "time": 11, "travel": 11, "github": 11, "tip": 12, "trick": 12, "frequent": 12, "ask": 12, "question": 12, "m": 12, "have": 12, "problem": 12, "e": 12, "g": 12, "fakeroot": 12, "error": 12, "where": 12, "should": 12, "my": 12, "softwar": 12, "sensit": 12, "code": 12, "would": 12, "want": 12, "do": 12, "small": 12, "modif": 12, "start": 12, "becom": 12, "huge": 12, "verifi": 13, "configur": 13}, "envversion": {"sphinx.domains.c": 2, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 8, "sphinx.domains.index": 1, "sphinx.domains.javascript": 2, "sphinx.domains.math": 2, "sphinx.domains.python": 3, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx": 57}, "alltitles": {"Basics of running containers": [[0, "basics-of-running-containers"]], "Objectives": [[0, "objectives-0"], [1, "objectives-0"], [2, "objectives-0"], [3, "objectives-0"], [4, "objectives-0"], [5, "objectives-0"], [7, "objectives-0"], [8, "objectives-0"], [9, "objectives-0"], [11, "objectives-0"], [13, "objectives-0"]], "Different ways you can run your containers": [[0, "different-ways-you-can-run-your-containers"]], "How to read Apptainer commands?": [[0, "how-to-read-apptainer-commands"]], "Obtaining a container from container registry": [[0, "obtaining-a-container-from-container-registry"]], "Running the container": [[0, "running-the-container"]], "Expected result": [[0, null], [0, null], [0, null], [2, null], [2, null], [2, null], [2, null], [2, null], [2, null], [5, null], [5, null]], "Launching an interactive shell in the container": [[0, "launching-an-interactive-shell-in-the-container"]], "Running a single program from the container": [[0, "running-a-single-program-from-the-container"]], "Review of this session": [[0, "review-of-this-session"], [5, "review-of-this-session"], [8, "review-of-this-session"]], "Key points to remember": [[0, null], [1, null], [2, null], [2, null], [3, null], [3, null], [5, null], [7, null], [7, null], [8, null], [10, null]], "Binding folders into your container": [[1, "binding-folders-into-your-container"]], "Building Apptainer images": [[2, "building-apptainer-images"]], "Pulling an existing image from a container registry": [[2, "pulling-an-existing-image-from-a-container-registry"]], "Handling temporary layers needed by the build process": [[2, "handling-temporary-layers-needed-by-the-build-process"]], "Creating an image using a specification file": [[2, "creating-an-image-using-a-specification-file"]], "Running additional installation commands during image creation": [[2, "running-additional-installation-commands-during-image-creation"]], "Image building is done as a fake root-user": [[2, null]], "Setting environment variables in the image": [[2, "setting-environment-variables-in-the-image"]], "Adding documentation to your image": [[2, "adding-documentation-to-your-image"]], "Examining the container": [[2, "examining-the-container"]], "Additional definition file options": [[2, "additional-definition-file-options"]], "Intro to container images": [[3, "intro-to-container-images"]], "Traditional container images (Docker etc.)": [[3, "traditional-container-images-docker-etc"]], "Apptainer container images": [[3, "apptainer-container-images"]], "Image sources": [[3, "image-sources"], [7, "image-sources"]], "Building Your First Container": [[4, "building-your-first-container"]], "Prerequisites": [[4, "prerequisites-0"], [6, "prerequisites-0"], [13, "prerequisites-0"]], "Summary": [[4, "summary"], [13, "summary"]], "Build a simple container and test it": [[4, "exercise-0"]], "Running containers that use GPUs": [[5, "running-containers-that-use-gpus"]], "Using NVIDIA\u2019s GPUs": [[5, "using-nvidia-s-gpus"]], "Using AMD\u2019s GPUs": [[5, "using-amd-s-gpus"]], "Example container: Model training with accelerate": [[5, "example-container-model-training-with-accelerate"]], "Containers on HPC with Apptainer": [[6, "containers-on-hpc-with-apptainer"]], "Course instance in May 2024": [[6, null]], "The lesson": [[6, null]], "Extras": [[6, null]], "Exercises": [[6, null], [11, "exercises"]], "Who is the course for?": [[6, "who-is-the-course-for"]], "About the course": [[6, "about-the-course"]], "Intro to containers (on HPC)": [[7, "intro-to-containers-on-hpc"]], "What even is a container?": [[7, "what-even-is-a-container"]], "More technical information on how traditional containers work": [[7, null]], "What is the intended use case of Apptainer?": [[7, "what-is-the-intended-use-case-of-apptainer"]], "Apptainer vs. Singularity": [[7, "apptainer-vs-singularity"]], "MPI programs and containers": [[8, "mpi-programs-and-containers"]], "What to consider when creating a container for MPI programs?": [[8, "what-to-consider-when-creating-a-container-for-mpi-programs"]], "How MPI works": [[8, "how-mpi-works"]], "How to use MPI with a container": [[8, "how-to-use-mpi-with-a-container"]], "Creating a simple MPI container": [[8, "creating-a-simple-mpi-container"]], "Utilizing the fast interconnects": [[8, "utilizing-the-fast-interconnects"]], "ABI compatibility in MPI": [[8, "abi-compatibility-in-mpi"]], "Example on portability: LAMMPS": [[8, "example-on-portability-lammps"]], "Python environment in a container": [[9, "python-environment-in-a-container"]], "Background": [[9, "background"]], "Exercise 1: Creating Python image with image\u2019s pip": [[9, "exercise-1-creating-python-image-with-image-s-pip"]], "Install Python environment to base python image": [[9, "exercise-0"]], "Solution": [[9, "solution-0"], [9, "solution-1"], [11, "solution-0"], [11, "solution-1"], [13, "solution-0"]], "Exercise 2: Creating conda/mamba environment in an image": [[9, "exercise-2-creating-conda-mamba-environment-in-an-image"]], "Install an environment to an apptainer image using an optimized definition file": [[9, "exercise-1"]], "Services and apps": [[10, "services-and-apps"]], "What are services?": [[10, "what-are-services"]], "What are apps?": [[10, "what-are-apps"]], "Example: PostgreSQL container": [[10, "example-postgresql-container"]], "Sharing reproducible containers": [[11, "sharing-reproducible-containers"]], "Reuse": [[11, "reuse"]], "Example image dependency": [[11, "example-image-dependency"]], "Take-away message": [[11, null], [11, null]], "Popular base images": [[11, "popular-base-images"]], "Be specific": [[11, "be-specific"]], "Separate concerns": [[11, "separate-concerns"]], "Purpose": [[11, "purpose"]], "Stay to the point": [[11, null]], "Data": [[11, "data"]], "Data key practices": [[11, null]], "Document your image": [[11, "document-your-image"]], "Documentation key practices": [[11, null]], "Use version control and public registries": [[11, "use-version-control-and-public-registries"]], "Key practices": [[11, null]], "Recommendation to \u201cguarantee\u201d long-term availability": [[11, null]], "Exercise Sharing-1: Time-travel with containers": [[11, "exercise-0"]], "Exercise Sharing-2: Building a container on GitHub": [[11, "exercise-1"]], "Tips, tricks and frequently asked questions": [[12, "tips-tricks-and-frequently-asked-questions"]], "I\u2019m having problems when building a container (e.g. fakeroot-errors)": [[12, "i-m-having-problems-when-building-a-container-e-g-fakeroot-errors"]], "Where should I install my software?": [[12, "where-should-i-install-my-software"]], "I have sensitive code that I would need to have in the container": [[12, "i-have-sensitive-code-that-i-would-need-to-have-in-the-container"]], "I have an existing container, but I would want to do small modifications to the code": [[12, "i-have-an-existing-container-but-i-would-want-to-do-small-modifications-to-the-code"]], "My container starts to become huge": [[12, "my-container-starts-to-become-huge"]], "I would want to install my conda environment in a container": [[12, "i-would-want-to-install-my-conda-environment-in-a-container"]], "Verify Apptainer Installation": [[13, "verify-apptainer-installation"]], "Configure Apptainer": [[13, "exercise-0"]]}, "indexentries": {}}) \ No newline at end of file diff --git a/services_apps/index.html b/services_apps/index.html new file mode 100644 index 0000000..182daac --- /dev/null +++ b/services_apps/index.html @@ -0,0 +1,310 @@ + + + + + + + Services and apps — Container on HPC with Apptainer documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Services and apps

+
+

What are services?

+

You can use Apptainer to launch services that run in +the background. Service might be, for example, a database +application that your code uses to fetch subsets from a +larger dataset.

+

Creating containers for these kinds of services can +often be quite complicated as they might need specific +folders to be created or specific environment variables +to be set.

+
+
+

What are apps?

+

When we’re launching a complicated services or making +containers with more than one application we might also +want to specify multiple run scripts and entrypoints to +the container.

+

This can be done in Apptainer containers by specifying +multiple apps in the definition file.

+
+
+

Example: PostgreSQL container

+

The following example uses a +PostgreSQL image to +set up a PostgreSQL server. Launching the server requires +that certain directory mounts and environment variables are set.

+

These have been found by looking at the +docker-entrypoint.sh-script +that would start the image when using Docker.

+

In the case of PostgreSQL, we’ll most likely +want to use the PostgreSQL client to modify our databases. +We can do this by specifying an app for it.

+

Let’s look at the definition file:

+
Bootstrap: docker
+From: postgres:16
+
+%environment
+    export LC_ALL=C
+    export LANG=C
+    export LANGUAGE=C
+
+%startscript
+    export POSTGRES_USER=$PGUSER
+    export POSTGRES_PASSWORD=$PGPASSWORD
+    export PGHOST=$HOSTNAME
+    export PGPORT=${PGPORT:-19200}
+
+    # Run the entry script for PostgreSQL Docker image
+    exec docker-entrypoint.sh postgres "$@"
+
+%help
+
+    This is a postgres container.
+
+    The following data locations need to be mounted into the container:
+
+    - Data location for the postgres: /var/lib/postgresql/data
+    - Location for the runfiles for postgres: /var/run/postgresql
+
+    The start script needs the following arguments:
+
+    - postgres user name
+    - postgres user password
+
+    Usage:
+
+        mkdir postgres_data
+        mkdir postgres_run
+
+        export PGUSER=postgres_user
+        export PGPASSWORD=postgres_password
+        apptainer instance start --bind postgres_data:/var/lib/postgresql/data --bind postgres_run:/var/run/postgresql postgres_container.sif postgres_server
+
+        apptainer instance list
+
+%apprun psql
+    export POSTGRES_USER=$PGUSER
+    export POSTGRES_PASSWORD=$PGPASSWORD
+    export PGHOST=$HOSTNAME
+    export PGPORT=${PGPORT:-19200}
+    exec psql "$@"
+
+%apphelp psql
+    Run psql-client in image
+
+    PostgreSQL instance needs to be started beforehand
+
+    Usage:
+
+        export PGUSER=postgres_user
+        export PGPASSWORD=postgres_password
+        apptainer run --app psql instance://postgres_server -c 'create database test;'
+        apptainer run --app psql instance://postgres_server -c '\l'
+
+
+

The definition file has couple of new blocks:

+
    +

  • %startscript: This block defines what commands will be run when we start up the service.

    • +

  • %apprun: This block allows us to specify individual applications in our image. In this +case we have an application called psql for the PostgreSQL client. This block specifies +how we run this specific application.

    • +

  • %apphelp: Each app in a container can have it’s own help section as well as other +setup sections. See documentation for all possibilities.

    • +
+

For more information on how to specify multiple apps in a container, see +this documentation page.

+

After building the image we can start the database with:

+
$ mkdir postgres_data
+$ mkdir postgres_run
+$ export POSTGRES_USER=postgres_user
+$ export POSTGRES_PASSWORD=postgres_password
+$ apptainer instance start --bind postgres_data:/var/lib/postgresql/data --bind postgres_run:/var/run/postgresql postgres_container.sif postgres_server
+
+
+
+../_images/instance_example.png +
+

Figure 1: Starting container as an instance

+
+
+

Now that we have started the instance we can check that the instance is running with:

+
$ apptainer instance list
+
+
+

Let’s use the psql-app that we have specified. We can use it to make a +connection to the server and to create a new database. Let’s also list the +newly created database:

+
$ export PGUSER=postgres_user
+$ export PGPASSWORD=postgres_password
+$ apptainer run --app psql instance://postgres_server -c 'create database test;'
+$ apptainer run --app psql instance://postgres_server -c '\l'
+
+
+
+../_images/app_run_example.png +
+

Figure 2: Running an app from a container

+
+
+

You’ll notice that we did not start a new container. Instead ran the application in +the running instance by specifying instance://postgres_server instead of the +.sif-image. You’ll also note that we did not need to specify the bind-mounts +again: once the instance is started, bind mounts are made and they are there until +the instance is stopped.

+

We can then shut down the server with:

+
$ apptainer instance stop postgres_server
+
+
+
+

Key points to remember

+
    +

  • You can start containers as instances.

    • +

  • You can use %startscript-block to specify how an instance should start.

    • +

  • You can create multiple apps in a container with %app*-blocks

    • +

  • Started instances with bind mounts have them until instance is stopped. +This is very useful if you plan on running multiple commands against a +single container.

    • +
+
+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/sharing/index.html b/sharing/index.html new file mode 100644 index 0000000..af00762 --- /dev/null +++ b/sharing/index.html @@ -0,0 +1,682 @@ + + + + + + + Sharing reproducible containers — Container on HPC with Apptainer documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Sharing reproducible containers

+
+

Objectives

+
    +

  • Know about good practices for creating reproducible containers

    • +

  • Know about some popular services to share container definition files and images

    • +
+
+

In this lesson we will go through a handful of guidelines and tips that will help you to create reproducible containers which can be shared today and hopefully years into the future.

+

We will encourage you to

+ +

And finally we will give you an exercise to practice your new skills.

+
+

Reuse

+

As we have learned, building a container means that you pack the OS and all +the applications you need into a file. We have also learned that typically we +don’t do everything from scratch, we build upon base containers.

+

This means that when building containers we try to:

+
    +

  • Use available base containers

    • +

  • Add customisation on top of that

    • +
+

An example was using an official python image for our python container:

+
Bootstrap: docker
+From: python:latest
+
+%files
+    summation.py /opt
+
+%runscript
+    echo "Got arguments: $*"
+    exec python /opt/summation.py "$@"
+
+%post
+    pip install numpy
+
+
+

Here we use a python base image and in addition we install some more +software: numpy (and we copy our custom python script into the image).

+

Building upon base-images is used extensively: The python image is not just python, it is again based on an another image, which itself is based on another image, and so on.

+

To find the image dependency, you will need to do a bit of detective work, finding the image in a registry, and inspecting its Dockerfile which hopefully is linked from the registry. If there is no Dockerfile linked from the registry page, you may be out of luck.

+
+

Example image dependency

+

Let’s check the Dockerhub python registry. We can click on the link of the latest bookworm tag (see DockerHub python tab below) which leads us to its Dockerfile on Github (as seen in the Dockerfile python tab).

+
+
+../_images/dockerhub_python.png +
+
+

Inspecting this Dockerfile, we see that it again is based on a another image, namely buildpack-deps:bookworm.

+

We can do the same exercise for the image buildpack-deps:bookworm by finding the image in a registry like Dockerhub, navigating to the Dockerfile linked from that registry, and so on.

+

After all that, this is the image dependency tree we find for the original python docker base image:

+
--> From: python:latest
+  --> FROM: buildpack-deps:bookworm
+    --> FROM buildpack-deps:bookworm-scm
+      --> FROM buildpack-deps:bookworm-curl
+        --> FROM debian:bookworm
+          --> FROM scratch
+
+
+
+

Take-away message

+

Check if there is a suitable official base image for the applications you need, and build upon that.

+
+
+ +
+
+

Be specific

+

One of the main objectives of using images is that the users gets exactly what +they expect, and everything should just work. The container is after all +self-contained!

+

During development you might want to have “latest” versions of software. But +“latest” is a moving target: “latest” today is not the same as “latest” in 2 +years. And now you can get into problems! Maybe the latest version of your +base image is not compatible with the other software the image has included. +Or which you are including. This can spoil the party massively!

+
+

Take-away message

+

When sharing/publishing a container, try to be as specific as you can! Always specify software versions.

+
+

Taking our python image as an example, a more future-proof definition file would specify the base image version as well as the numpy version. Compare these two:

+
+
Bootstrap: docker
+From: python:3.12.7-bookworm
+
+%files
+    summation.py /opt
+
+%runscript
+    echo "Got arguments: $*"
+    exec python /opt/summation.py "$@"
+
+%post
+    pip install numpy==1.26.0
+
+
+
+

Further below we have an exercise where we can practice recognizing future +problems in container definition files.

+
+
+

Separate concerns

+
+

Purpose

+

When creating you image definition file - have a think about what the image should contain based on what purpose it has. Do not be tempted to add software just because it is convenient for general use.

+

For instance: an image that is used to run some specific scientific analysis on a specific input type of data may not need your favourite text editor inside. Or that extra python package just in case.

+

Slim the image down to just what it needs for the purpose it fulfills. The benefit will be at least two-fold: the image will be lighter meaning it will be quicker to download and have smaller carbon-footprint. But in addition there is less software to potentially get into software dependency problems with. Another benefit: it will be clearer for the user what is the purpose of the image, and how to use it.

+
+

Stay to the point

+
    +

  • Try to make your image as specific as possible

    • +

  • Only add software that is needed for the specific purpose of the container

    • +
+
+
+
+

Data

+

The main purpose of a software image is exactly that - to provide software, not datasets. There are several reasons why it is not a good idea to include (potentially large) datasets, here are a few:

+
    +

  • The image could become very heavy

    • +

  • The data may better be stored in a suited data registry

    • +

  • The data may be different from user to user

    • +

  • The data may be sensitive and should only reside in a private and secure computing environment

    • +
+

Instead of shipping the data with the image, let the user bind mount it into the container. Check out the Binding folders into your container lesson for details.

+

Compare the two apptainer definition files and how to run the resulting my_container.sif container. The right tab also exemplifies bind-mounting a folder for output data, which is useful in order to access the resulting output data directly from the host server.

+
+
Bootstrap: docker
+From: python:3.9-slim
+
+%files
+   process_data.py /app/process_data.py
+   input_data /app/input_data
+
+%post
+   mkdir /app/output_data
+   chmod 777 /app/output_data
+
+%runscript
+   python /app/process_data.py /app/input_data /app/output_data
+
+%help
+   Usage: apptainer run --writable-tmpfs this_container.sif
+
+
+
+

That said, there may be reasons why some particular data is better copied into the container. For instance some reference data that stays unchanged and that is needed for all analysis.

+
+

Data key practices

+
    +

  • Avoid copying data into the container unless there are obvious benefits

    • +
+
+
+
+
+

Document your image

+

In the example above you can see that some documentation is added in the image itself under the %help block. This is not only important for sharing, but also for yourself to help remember how to use the container. See more details in the Adding documentation to your image.

+
+

Documentation key practices

+

Always add documentation to your image.

+
    +

  • Minimally how to use the container via the %help block

    • +

  • In addition author, version, description via the %label block

    • +
+
+
+
+

Use version control and public registries

+
+

Key practices

+
    +

  • Track the changes to the definition file with version control. In practice: Put the definition file on GitHub or GitLab.

    • +

  • Make the container image findable by others. In practice: Put the image on a public registry.

    • +

  • Make sure one can find and inspect the definition file from the registry. In practice: Link the repo to the public registry.

    • +
+
+

In principle a definition file is enough to build a container image and in +theory we would not need to share pre-built images. But in practice it is very +useful to share the pre-built image as well. This is because:

+
    +

  • Building a container image can take time and resources.

    • +

  • If we were not careful specifying versions, the image might not build again +in the same way.

    • +

  • Some dependencies might not be available anymore.

    • +
+

There are many popular services to share container images and almost every +big-tech company offers one:

+
    +

  • Docker Hub: Default Docker registry with public/private repositories and CI/CD integration.

    • +

  • Google Container Registry (GCR): GCP service, tightly integrated with Google Cloud services and Kubernetes.

    • +

  • Azure Container Registry (ACR): Fully managed, integrated with Azure services like AKS and DevOps.

    • +

  • Quay.io: Red Hat service, security scanning, OpenShift/Kubernetes integration, public/private repositories.

    • +

  • JFrog Artifactory: Universal artifact repository supporting Docker and other formats, advanced security features.

    • +

  • Harbor: Open-source registry, role-based access control, vulnerability scanning, and image signing.

    • +

  • DigitalOcean Container Registry: Integrated with DigitalOcean Kubernetes.

    • +

  • GitLab Container Registry: Built into GitLab, works seamlessly with GitLab CI/CD pipelines.

    • +
+

What many projects do (however, note the warning below):

+
    +

  • Track their container definition files in a public repository on GitHub or GitLab.

    • +

  • From these repositories, they build the container images and push them to a public registry (above list).

    • +
+
+

Warning

+

A public registry that is free today might not be free tomorrow. Make sure +you have a backup plan for your images and make sure the image can still be +found 5 years from now if the service provider changes their pricing model.

+
+
+

Recommendation to “guarantee” long-term availability

+
    +

  • There are no guarantees, however:

    • +

  • One of the most stable services is Zenodo which +is an excellent place to publish your container image as supporting +material for a publication and also get a DOI for it. It is unlikely to +change pricing for academic use.

    • +

  • Make sure to also publish the definition file with it.

    • +
+
+

It is possible to host both the definition file and the image on GitHub:

+
+
    +

  • You don’t need to host it yourself.

    • +

  • The image stays close to its sources and is not on a different service.

    • +

  • Anybody can inspect the recipe and how it was built.

    • +

  • Every time you make a change to the recipe, it builds a new image.

    • +

  • We can practice/demonstrate this in the exercise below.

    • +
+
+
+
+

Exercises

+
+

Exercise Sharing-1: Time-travel with containers

+

Imagine the following situation: A researcher has written and published their research code which +requires a number of libraries and system dependencies. They ran their code +on a Linux computer (Ubuntu). One very nice thing they did was to publish +also a container image with all dependencies included, as well as the +definition file (below) to create the container image.

+

Now we travel 3 years into the future and want to reuse their work and adapt +it for our data. The container registry where they uploaded the container +image however no longer exists. But luckily (!) we still have the definition +file (below). From this we should be able to create a new container image.

+
    +

  • Can you anticipate problems using the definition file here 3 years after its +creation? Which possible problems can you point out?

    • +

  • Discuss possible take-aways for creating more reusable containers.

    • +
+
+
 1Bootstrap: docker
+ 2From: ubuntu:latest
+ 3
+ 4%post
+ 5    # Set environment variables
+ 6    export VIRTUAL_ENV=/app/venv
+ 7
+ 8    # Install system dependencies and Python 3
+ 9    apt-get update && \
+10    apt-get install -y --no-install-recommends \
+11        gcc \
+12        libgomp1 \
+13        python3 \
+14        python3-venv \
+15        python3-distutils \
+16        python3-pip && \
+17    apt-get clean && \
+18    rm -rf /var/lib/apt/lists/*
+19
+20    # Set up the virtual environment
+21    python3 -m venv $VIRTUAL_ENV
+22    . $VIRTUAL_ENV/bin/activate
+23
+24    # Install Python libraries
+25    pip install --no-cache-dir --upgrade pip && \
+26    pip install --no-cache-dir -r /app/requirements.txt
+27
+28%files
+29    # Copy project files
+30    ./requirements.txt /app/requirements.txt
+31    ./app.py /app/app.py
+32    # Copy data
+33    /home/myself/data /app/data
+34    # Workaround to fix dependency on fancylib
+35    /home/myself/fancylib /usr/lib/fancylib
+36
+37%environment
+38    # Set the environment variables
+39    export LANG=C.UTF-8 LC_ALL=C.UTF-8
+40    export VIRTUAL_ENV=/app/venv
+41
+42%runscript
+43    # Activate the virtual environment
+44    . $VIRTUAL_ENV/bin/activate
+45    # Run the application
+46    python /app/app.py
+
+
+ +
+
+
+

Exercise Sharing-2: Building a container on GitHub

+

You can build a container on GitHub (using GitHub Actions) or GitLab (using +GitLab CI) and host the image on GitHub/GitLab. This has the following +advantages:

+
    +

  • You don’t need to host it yourself.

    • +

  • The image stays close to its sources and is not on a different service.

    • +

  • Anybody can inspect the recipe and how it was built.

    • +

  • Every time you make a change to the recipe, it builds a new image.

    • +
+

If you want to try this out:

+
    +

  • Take this repository as starting point and inspiration.

    • +

  • We don’t need to focus too much on what this container does, but rather how it is built.

    • +

  • To build a new version, one needs to send a pull request which updates +the file VERSION and modifies the definition file.

    • +

  • Using this approach, try to build a very simple container definition +directly on GitHub where the goal is to have both the definition file +and the image file in the same place.

    • +
+
+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/tips_tricks/index.html b/tips_tricks/index.html new file mode 100644 index 0000000..a0ad9cb --- /dev/null +++ b/tips_tricks/index.html @@ -0,0 +1,226 @@ + + + + + + + Tips, tricks and frequently asked questions — Container on HPC with Apptainer documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Tips, tricks and frequently asked questions

+
+

I’m having problems when building a container (e.g. fakeroot-errors)

+

Sometimes when the host system and the guest container have operating systems +from different eras (e.g. Ubuntu 16.04 is really old), you might want to +use the +pre-built Apptainer binaries. +These can be installed without any privileges.

+

The reason for this errors is that a critical piece of software called GLIBC +might be too new in the host system. For more info, see the third point in +Apptainer’s fakeroot documentation.

+
+
+

Where should I install my software?

+

Quite often in Docker images software is installed under root-user’s +home folder (/root). This is the wrong approach. Installing software +there with the assumption that the container will be run by root-user +can cause permission headaches.

+

Folders under /home are also bad as that is commonly mounted by Apptainer +and thus the bind mount hides software installed there.

+

You should install manual installations of software to, for example, +/opt or /usr/local. See +Filesystem Hierarchy Standard +for explanation on how different folders are organized.

+
+
+

I have sensitive code that I would need to have in the container

+

Instead of installing your sensitive application to the image +you can instead mount the application directory inside the container.

+

If your program requires compilations or installations, you can +install dependencies into the container image and then install software +in a bound folder or on a +persistent overlay.

+

If you still decide to put sensitive code in your image, +remember that it is visible to everyone who has access to the image.

+
+
+

I have an existing container, but I would want to do small modifications to the code

+

If you want to do you’re own modifications to the code +you can either use +persistent overlays +or you can use the following trick:

+
    +

  1. Copy the code that you want to modify from the container to a folder outside +of the container:

    +
    $ apptainer exec my_container.sif cp -r /path/to/code/src src
+
    +
    +
    2. +

  2. Modify the code outside of the container

    3. +

  3. Bind mount modified code from outside of the container back into the container

    +
    $ apptainer run --bind src:/path/to/code/src my_container.sif
+
    +
    +
    4. +
+
+
+

My container starts to become huge

+

Remember to clean up any unnecessary source code or software in your +%post-block. If your program does not need e.g. development headers +once it has been installed, you can remove them.

+

You can also try +multi-stage builds +where one container is used to build a software, which is then copied +to another container that has only those packages required to run the software.

+
+
+

I would want to install my conda environment in a container

+

See +this repository +for an example definition file that can be used to bootstrap +conda environment into a Apptainer container image.

+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/verify_installation/index.html b/verify_installation/index.html new file mode 100644 index 0000000..1d9b3cb --- /dev/null +++ b/verify_installation/index.html @@ -0,0 +1,197 @@ + + + + + + + Verify Apptainer Installation — Container on HPC with Apptainer documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

Verify Apptainer Installation

+
+

Objectives

+
    +

  • Understand the importance of verifying tool installation on HPC systems.

    • +

  • Learn how to check the installation and version of Apptainer on an HPC cluster.

    • +

  • Gain practical skills in verifying software prerequisites for scientific computing environments.

    • +
+

This demo guides you through the process of verifying whether Apptainer is installed on your HPC cluster and checking its version. This is a critical first step in ensuring that the necessary tools are correctly configured before moving on to more complex containerization tasks. Knowing the version of Apptainer is essential as it may affect compatibility with container recipes or other tools used in your workflows.

+
+
+

Prerequisites

+
    +

  • No prerequisites for following the demo

    • +
+
+

The first step in utilizing containers on any high-performance computing (HPC) cluster involves ensuring that the container management software, in this case, Apptainer, is properly installed. This demo is crucial as it confirms the foundational tool’s availability, which is necessary for all subsequent container-related operations.

+

This demo will not only verify the presence of Apptainer on your system but will also teach you how to check its version. Knowing the installed version is important as it helps in troubleshooting and in ensuring compatibility with various container definitions and configurations used in scientific applications.

+
# Check if Apptainer is installed and determine its version
+apptainer --version
+
+
+

This command checks if Apptainer is installed and displays the version number. This information is useful for understanding which features and functionalities are available to you, as different versions may have different capabilities.

+
+

Summary

+

In this lesson, you learned how to verify the installation of Apptainer on your HPC cluster and how to check its version. This is a foundational skill that ensures you can proceed with confidence in using Apptainer for more advanced tasks in container management.

+
+

Configure Apptainer

+

Explore the online Apptainer documentation and search for the bash environment variables that apptainer uses.

+
+
    +

  1. Do you have any apptainer variables set in your shell environment?

    2. +

  2. How do you set the variables for the CACHEDIR and TMPDIR so that they are pointing to a disk where you have enough free space? (e.g. your work folder)

    3. +
+
+ +
+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file