diff --git a/.github/workflows/static.yml b/.github/workflows/documentation.yml similarity index 78% rename from .github/workflows/static.yml rename to .github/workflows/documentation.yml index 23b2d4d..2ba3039 100644 --- a/.github/workflows/static.yml +++ b/.github/workflows/documentation.yml @@ -1,12 +1,10 @@ -# Simple workflow for deploying static content to GitHub Pages -name: Deploy static content to Pages +# Deploy Velocity documentation +name: Deploy documentation to Pages on: - # Runs on pushes targeting the default branch + # trigger on push to develop also allow manual runs push: branches: ["develop"] - - # Allows you to run this workflow manually from the Actions tab workflow_dispatch: # Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages @@ -22,7 +20,6 @@ concurrency: cancel-in-progress: false jobs: - # Single deploy job since we're just deploying deploy: environment: name: github-pages @@ -32,7 +29,7 @@ jobs: - name: Checkout uses: actions/checkout@v4 with: - ref: "release/0.1" + ref: "develop" - name: Setup Pages uses: actions/configure-pages@v5 - name: Set up Python @@ -46,10 +43,9 @@ jobs: - name: Build Docs run: | cd docs && make html - - name: Upload artifact + - name: Upload documentation HTML files uses: actions/upload-pages-artifact@v3 with: - # Upload entire repository path: './docs/build/html' - name: Deploy to GitHub Pages id: deployment diff --git a/.gitignore b/.gitignore index 4201467..2071964 100644 --- a/.gitignore +++ b/.gitignore @@ -11,3 +11,4 @@ tmp *__pycache__ dist *\.egg-info +docs/build \ No newline at end of file diff --git a/docs/build/doctrees/environment.pickle b/docs/build/doctrees/environment.pickle deleted file mode 100644 index d75c8d1..0000000 Binary files a/docs/build/doctrees/environment.pickle and /dev/null differ diff --git a/docs/build/doctrees/index.doctree b/docs/build/doctrees/index.doctree deleted file mode 100644 index 58d112f..0000000 Binary files a/docs/build/doctrees/index.doctree and /dev/null differ diff --git a/docs/build/doctrees/reference/build.doctree b/docs/build/doctrees/reference/build.doctree deleted file mode 100644 index 0aef238..0000000 Binary files a/docs/build/doctrees/reference/build.doctree and /dev/null differ diff --git a/docs/build/doctrees/reference/config.doctree b/docs/build/doctrees/reference/config.doctree deleted file mode 100644 index 389f0c7..0000000 Binary files a/docs/build/doctrees/reference/config.doctree and /dev/null differ diff --git a/docs/build/doctrees/reference/index.doctree b/docs/build/doctrees/reference/index.doctree deleted file mode 100644 index 86d4366..0000000 Binary files a/docs/build/doctrees/reference/index.doctree and /dev/null differ diff --git a/docs/build/doctrees/reference/specs.doctree b/docs/build/doctrees/reference/specs.doctree deleted file mode 100644 index e3bdc01..0000000 Binary files a/docs/build/doctrees/reference/specs.doctree and /dev/null differ diff --git a/docs/build/doctrees/reference/vtmp.doctree b/docs/build/doctrees/reference/vtmp.doctree deleted file mode 100644 index 472c86d..0000000 Binary files a/docs/build/doctrees/reference/vtmp.doctree and /dev/null differ diff --git a/docs/build/doctrees/starting/basic.doctree b/docs/build/doctrees/starting/basic.doctree deleted file mode 100644 index 038f7d5..0000000 Binary files a/docs/build/doctrees/starting/basic.doctree and /dev/null differ diff --git a/docs/build/doctrees/starting/index.doctree b/docs/build/doctrees/starting/index.doctree deleted file mode 100644 index 4e355b7..0000000 Binary files a/docs/build/doctrees/starting/index.doctree and /dev/null differ diff --git a/docs/build/doctrees/starting/tutorial.doctree b/docs/build/doctrees/starting/tutorial.doctree deleted file mode 100644 index b67ba94..0000000 Binary files a/docs/build/doctrees/starting/tutorial.doctree and /dev/null differ diff --git a/docs/build/html/.buildinfo b/docs/build/html/.buildinfo deleted file mode 100644 index 521b502..0000000 --- a/docs/build/html/.buildinfo +++ /dev/null @@ -1,4 +0,0 @@ -# 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: 0a1eabe490da9bb3c4034782d390d609 -tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/docs/build/html/_sources/index.rst.txt b/docs/build/html/_sources/index.rst.txt deleted file mode 100644 index fcb521a..0000000 --- a/docs/build/html/_sources/index.rst.txt +++ /dev/null @@ -1,20 +0,0 @@ -.. Velocity documentation master file, created by - sphinx-quickstart on Mon Mar 18 12:43:01 2024. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. - - -Velocity Container Build Management -=================================== -Velocity is a tool to help with the maintenance of container build scripts on multiple systems, backends -(e.g podman or apptainer) and distros. - -.. toctree:: - :maxdepth: 2 - - starting/index - -.. toctree:: - :maxdepth: 2 - - reference/index diff --git a/docs/build/html/_sources/reference/build.rst.txt b/docs/build/html/_sources/reference/build.rst.txt deleted file mode 100644 index 6003d21..0000000 --- a/docs/build/html/_sources/reference/build.rst.txt +++ /dev/null @@ -1,49 +0,0 @@ -************* -Build Process -************* - -This page describes the steps that velocity goes through when building an image. - -Setup -##### -After selecting images to build and ordering them Velocity will also create a directory BSD (Build Sub Dir) -named ``--`` in build directory. - -.. _files: - -Files -##### -Next Velocity will copy any files that you specified. - -Parse Template -############## -Velocity will then parse the correct template and generate a file called `script` in the BSD. - -Create Build Script -################### -At this point Velocity will piece together the build command and append it to the end of the prolog (if a prolog was -specified). It will place the resulting script in the BSD with the name `build`. - -Build -##### -Finally velocity will run the `build` script and log the output to a file called `log` in the BSD. - -Build Directory Layout -###################### -At the end of a build the build dir should look somthing like this. With the addition of any other files that -got copied in the :ref:`files` step. - -.. code-block:: bash - - . - ├── fedora-41-8a9a360 - │ ├── 8a9a360.sif - │ ├── build - │ ├── log - │ └── script - └── hello-world-1.0-de9c02b - ├── build - ├── de9c02b.sif - ├── hello_world.py - ├── log - └── script diff --git a/docs/build/html/_sources/reference/config.rst.txt b/docs/build/html/_sources/reference/config.rst.txt deleted file mode 100644 index 50a83c3..0000000 --- a/docs/build/html/_sources/reference/config.rst.txt +++ /dev/null @@ -1,64 +0,0 @@ -************* -Configuration -************* - -Configuration for Velocity comes from three places. Command line options, environment variables and the configuration file. - -Commandline Options -################### -These take the highest level of precedence and can be viewed by using the ``--help`` option in the command line. - -Variables -######### -Variables are the second highest level of configuration. - -`VELOCITY_IMAGE_PATH` ---------------------- - -This variable points to the directories containing the the image definitions. - -`VELOCITY_SYSTEM` ------------------ -This variable specifies what computer system you are building for (e.g. frontier). - -`VELOCITY_BACKEND` ------------------- -This variable specifies the container backend that should be used (e.g podman). - -`VELOCITY_DISTRO` ------------------ -This variable specifies the distro of the container images that will be built. This name is flexable and completely -up to the user. It is used purely for organizational purposes. - -`VELOCITY_BUILD_DIR` --------------------- -This variable specifies a scratch space for Velocity to preform builds in. - -`VELOCITY_CONFIG_DIR` ---------------------- -This variable specifies where to look for the configuration file. - -Configuration File -################## -The configuration file is the lowest level of configuration. By default Velocity looks for ``config.yaml`` in -``~/.velocity`` unless ``VELOCITY_CONFIG_DIR`` is set. A number of configuration option for velocity can be set. - -.. code-block:: yaml - - velocity: - system: frontier - backend: apptainer - distro: ubuntu - debug: INFO # set the debug level - image_path: # a list of : seperated paths - build_dir: # path to a scratch space - -Additionally you can set :ref:`arguments` and :ref:`specVariables` at a global level in the constraints section. As an example here -we are adding ``--disable-cache`` as an argument for every image build we do with apptainer. - -.. code-block:: yaml - - constraints: - arguments: - - value: --disable-cache - when: backend=apptainer diff --git a/docs/build/html/_sources/reference/index.rst.txt b/docs/build/html/_sources/reference/index.rst.txt deleted file mode 100644 index 0c01598..0000000 --- a/docs/build/html/_sources/reference/index.rst.txt +++ /dev/null @@ -1,14 +0,0 @@ - -############## -Technical Docs -############## - - - -.. toctree:: - :maxdepth: 2 - - config - vtmp - specs - build diff --git a/docs/build/html/_sources/reference/specs.rst.txt b/docs/build/html/_sources/reference/specs.rst.txt deleted file mode 100644 index d3667f4..0000000 --- a/docs/build/html/_sources/reference/specs.rst.txt +++ /dev/null @@ -1,114 +0,0 @@ -******************* -Specs.yaml -******************* - -About -##### -The `specs.yaml` file defines image availability, dependencies and a number of other available -options for an image. - -Config Options -############## - -versions --------- -The `versions` section defines a list of versions and their availability. - -.. code-block:: yaml - - versions: - - spec: 45 - when: distro=ubuntu - - spec: - - 46 - - 47 - when: backend=podman - -dependencies ------------- -The `dependencies` section is used to specify prerequist images. - -.. code-block:: yaml - - dependencies: - - spec: ubuntu - when: distro=ubuntu - - spec: - - "gcc@12:" - - pytorch - when: myapp@:2.3 - -templates ---------- -By default velocity looks for a template called ``default.vtmp``, but using the `templates` section you can specify an -alternate template. - -.. code-block:: yaml - - templates: - - name: second_tmp - when: "myapp@2:" - -.. _arguments: - -arguments ---------- -Use the `argument` section to add build time arguments to an image. - -.. code-block:: yaml - - arguments: - - value: --disable-cache - when: backend=apptainer - -.. _specVariables: - -variables ---------- -Use the `variables` section to set template variables. - -.. code-block:: yaml - - variables: - - name: test_var - value: "Test value." - -files ------ -Use the `files` section to specify files or directories in the `files` folder that you want copied to the build directory. - -.. code-block:: yaml - - files: - - name: config.json - -prologs -------- -Use the `prologs` section to bash commands that you want to run before the build. - -.. code-block:: yaml - - prologs: - - script: | - git clone ... - when: system=summit - -Using ``when`` -############## -A few notes about using ``when`` to filter config options. The ``when`` option can be used to filter configs as shown -above by system, backend, distro and dependencies. The only exception to this is the `versions` section which cannot -be filtered by dependencies. List each item that you want to filter by separated by a space e.g. ``gcc@12.3 system=frontier``. -Additionally you can specify the scope of a ``when`` by specifying the ``scope``. The default scope is ``image`` which means -that the when statement is evaluated on the current image. So say you want to apply a config in the gcc `specs.yaml` file -to every gcc version greater than 10.3.0, you would use ``when: ^ubuntu:``. Alternatively you can set the scope to ``build`` -when you want the when statement evaluated on the current build. - -.. code-block:: yaml - - variable: - - name: TEST - value: "1 2 3 4" - when: ubuntu - scope: build - -This can be read as "If the ubuntu image is in the current set of images to be built then add the TEST variable." diff --git a/docs/build/html/_sources/reference/vtmp.rst.txt b/docs/build/html/_sources/reference/vtmp.rst.txt deleted file mode 100644 index 2c05c5a..0000000 --- a/docs/build/html/_sources/reference/vtmp.rst.txt +++ /dev/null @@ -1,141 +0,0 @@ -*********** -VTMP Format -*********** - -VTMP files are used by Velocity to generate the appropriate script for a particular backend. -The goal of the VTMP files are to provide a unified API for -container images across multiple backends but they are not feature exhaustive. -VTMP files are split up into a number of sections. - -.. code-block:: text - :caption: Example VTMP - - >>> this is a comment - @from - >>> can only take one of these examples - docker.io/ubuntu:20.04 - /example.sif >>> only works for apptainer backend - {{ __base__ }} >>> build on the previous image - - @pre - >>> anything here is taken literally - >>> optionally denote the start of a line with | (helpful for white space) - echo 'Without tab' - | echo 'With tab' - - @copy - >>> list files to copy, format - /external/file /internal/file - - @run - >>> list of commands to run in container - echo 'Hello world' - ?? distro=podman |> echo 'podman' ?? >>> conditional - ?? distro=apptainer |> echo 'apptainer' ?? - echo {{ template_variable }} - echo @@ example_arg @@ >>> define an argument - !envar TEST_VAR I want this here and in the @env section >>> the !envar directive - - @env - >>> set env variables - PATH /something:$PATH - - @label - >>> set container labels - IMAGE_NAME {{ __name__ }} - - @entry - >>> set ENTRYPOINT or %runscript - >>> only one line allowed - - /bin/bash - - @post >>> same as pre but placed after everything else - -.. _variables: - -Variables -######### -The first thing that is done to a VTMP file is the substitution of any variables found in the script. Variables are indicated -by ``{{ }}``. In Velocity variables can be defined by the user in the `specs.yaml` file, but Velocity also -provides a set of build time variables. - -.. code-block:: text - - __backend__ - __distro__ - __base__ >>> previous image to build on - __name__ >>> current image name e.g. cuda - __system__ - __version__ >>> image "version" e.g. 11.7.1 - __version_major__ - __version_minor__ - __version_patch__ - __version_suffix__ - __timestamp__ - >>> the versions of all images in a build are also available in the following format - ____version__ - ____version_major__ - ____version_minor__ - ____version_patch__ - ____version_suffix__ - -Arguments -######### -You can also pass in arguments at build time using the form ``@@ @@``, but don't forget to add the -argument in ``specs.yaml`` so that is gets added to the build command or the build will fail. - -Conditionals -############ -If there is a line in a template that you only want under certain conditions use ``?? |> ??``. -The whole conditional will be replaced with the section if the condition is true; otherwise, it will substitute -an empty string. The conditionals can include the following components, ``system=``, ``backend=``, -``distro=`` and a dependency in the form ``^``. - -Sections -######## - -@from ------ -The `@from` section is used to specify the base image to build on top of. Both Podman and Apptainer support pulling -from docker registries. Apptainer also supports building from a sif file. The `@from` section can only have one line in it. - -.. _pre_section: - -@pre ----- -This section and the related `@post` section enable a user to insert a literal section of text into the generated script. -One added feature in this section is the ability to denote the beginning of a line with the | character. This -allows you to add white space to the beginning of a line. The only difference between the `@pre` and `@post` section -are where they are placed in the script the `@pre` section is placed at the beginning of the script -right after the `@from` section. - -@copy ------ -The `@copy` section takes a list of files/dir to be copied in the format. - -@run ----- -The `@run` section takes a list of commands to be run in the container. These commands should be written as if they all -occur one after the other in the same shell. One added feature to the @run section is the ``!envar`` directive. This -directive will add the following variable definition to the @env section as well as to the current @run section. Use -the format ``!envar ``. - -@env ----- -The `@env` section sets environment variables. These variables will only be available when the container is run or in -the next build so if there is a variable that is needed in the run section use the ``!envar`` directive in the @run section. - -@label ------- -A list of labels for the container. The key is separated from the value by the first space. Everything to the right of -the first space is included in the value. - -@entry ------- -This `@entry` section is converted to `ENTRYPOINT` for podman and `%runscript` for apptainer. You can only have one line -in the `@entry` section. - -@post ------ -See :ref:`@pre `. The `@post` section is placed at the end of the script after all other sections. diff --git a/docs/build/html/_sources/starting/basic.rst.txt b/docs/build/html/_sources/starting/basic.rst.txt deleted file mode 100644 index 99d4beb..0000000 --- a/docs/build/html/_sources/starting/basic.rst.txt +++ /dev/null @@ -1,170 +0,0 @@ - -******** -Overview -******** - -How it Works -############ -Velocity works by building a set of containers in a chain so that the final container has all of the needed components. -Velocity maintains a very hands off approach. It is only as good as the templates/configuration that you write. -In general it will assume that a particular build will work unless you tell it otherwise. It is important to note -that while Velocity has many features that are similar to those provided by a package manager, it is NOT a -package manager. Rather it should be viewed as a templating and build orchestration tool. - -Installation -############ - -The easiest way to install velocity is to install prebuilt python packages using pip. - -.. code-block:: bash - - pip install olcf-velocity - -You can also clone the velocity repository and build/install velocity from source. - -.. code-block:: bash - - git clone https://github.com/olcf/velocity.git - cd velocity - python3 -m build - # install the built python wheel package - pip install dist/olcf-velocity-*.whl - -Now you can use Velocity as a python module! We recommend setting a bash alias for convenience. - -.. code-block:: bash - - user@hostname:~$ alias velocity="python3 -m velocity" - user@hostname:~$ velocity - usage: velocity [-h] [-v] [-D {TRACE,DEBUG,INFO,SUCCESS,WARNING,ERROR,CRITICAL}] [-b BACKEND] [-s SYSTEM] [-d DISTRO] {build,avail,spec} ... - - build tool for OLCF containers - - positional arguments: - {build,avail,spec} - build build specified container image - avail lookup available images - spec lookup image dependencies - - options: - -h, --help show this help message and exit - -v, --version program version - -D {TRACE,DEBUG,INFO,SUCCESS,WARNING,ERROR,CRITICAL}, --debug {TRACE,DEBUG,INFO,SUCCESS,WARNING,ERROR,CRITICAL} - set debug output level - -b BACKEND, --backend BACKEND - -s SYSTEM, --system SYSTEM - -d DISTRO, --distro DISTRO - - See https://github.com/olcf/velocity - -.. _configuration: - -Configuration -############# -Velocity has a number of configuration options. The basic ones are setting the system name, container backend, -container distro, the path(s) to your image definitions and the build scratch directory. -To see more configuration options go to the :doc:`configuration ` page. The easiest way to configure velocity is to -edit ``~/.velocity/config.yaml``. - -.. code-block:: - - velocity: - system: frontier - backend: apptainer - distro: ubuntu - image_path: # a list of : seperated paths - build_dir: # path to a scratch space - -.. note:: - - Image definitions can be created by the user as needed but a base set for usage at OLCF are provided at - https://github.com/olcf/velocity-images - -Basic Usage -########### - -`avail` -------- - -The `avail` command prints the defined images that can be built. - -.. code-block:: bash - - user@hostname:~$ velocity avail - ==> gcc - 12.3.0 - 13.2.0 - 14.1.0 - ==> mpich - 3.4.3 - ==> rocm - 5.7.1 - ==> ubuntu - 20.04 - 22.04 - 24.04 - -Each image is listed and then indented underneath is a list of the available versions. - -`spec` ------- - -The `spec` command shows the dependencies for a given image (or list of images) in a tree like structure. - -.. code-block:: bash - - user@hostname:~$ velocity spec pytorch - > pytorch@latest - ^cuda@11.7.1 - ^centos@stream8 - ^cudnn@8.5.0.96 - ^cuda@11.7.1 - ^centos@stream8 - ^spectrum-mpi@10.4.0.6 - ^centos@stream8 - ^gcc@11.2.0 - ^centos@stream8 - ^miniforge3@23.11.0 - ^centos@stream8 - - -`build` -------- - -The `build` command can be used to build an container image from one or more image definitions. - -.. code-block:: bash - - user@hostname:~$ velocity build centos - ==> Build Order: - centos@=stream8 - - ==> iarfnxer: BUILD centos@=stream8 ... - ==> iarfnxer: GENERATING SCRIPT ... - ==> iarfnxer: BUILDING ... - ==> iarfnxer: IMAGE localhost/centos__stream8__x86_64__centos:latest (centos@=stream8) BUILT (0:01:22) - -Both the spec and the build command can also take a list of images. - -.. code-block:: bash - - user@hostname:~$ velocity build gcc python - ==> Build Order: - centos@=stream8 - gcc@=11.2.0 - python@=3.11.8 - - ==> pbxpudvh: BUILD centos@=stream8 ... - ==> pbxpudvh: GENERATING SCRIPT ... - ==> pbxpudvh: BUILDING ... - ==> pbxpudvh: IMAGE localhost/pbxpudvh:latest (centos@=stream8) BUILT [0:01:00] - - ==> lxogjapp: BUILD gcc@=11.2.0 ... - ==> lxogjapp: GENERATING SCRIPT ... - ==> lxogjapp: BUILDING ... - ==> lxogjapp: IMAGE localhost/lxogjapp:latest (gcc@=11.2.0) BUILT [0:40:34] - - ==> sunflyhd: BUILD python@=3.11.8 ... - ==> sunflyhd: GENERATING SCRIPT ... - ==> sunflyhd: BUILDING ... - ==> sunflyhd: IMAGE localhost/python__3.11.8__x86_64__centos:latest (python@=3.11.8) BUILT [0:23:19] diff --git a/docs/build/html/_sources/starting/index.rst.txt b/docs/build/html/_sources/starting/index.rst.txt deleted file mode 100644 index 4c37bb8..0000000 --- a/docs/build/html/_sources/starting/index.rst.txt +++ /dev/null @@ -1,12 +0,0 @@ - -############### -Getting Started -############### - - - -.. toctree:: - :maxdepth: 2 - - basic - tutorial diff --git a/docs/build/html/_sources/starting/tutorial.rst.txt b/docs/build/html/_sources/starting/tutorial.rst.txt deleted file mode 100644 index d232464..0000000 --- a/docs/build/html/_sources/starting/tutorial.rst.txt +++ /dev/null @@ -1,519 +0,0 @@ -************************* -Creating Your First Image -************************* - -Base Image -########## -Let's start with a simple base image. This image will pull an fedora docker image and update the packages. For this -tutorial I have created the empty directory ``/tmp/velocity/images`` and configured it as the image directory. I have set -the build directory to ``/tmp/velocity/build``, the backend to ``apptainer`` and the distro as ``fedora``. All -commands are run in ``/tmp/velocity``. -Start by creating a directory in the image directory called ``fedora``. In this directory create a file called -``specs.yaml`` and a directory called ``templates`` with -a file named ``default.vtmp``. Your image directory and files should now look like this. - -.. code-block:: bash - :caption: /tmp/velocity/images - - fedora - ├── specs.yaml - └── templates - └── default.vtmp - - -.. code-block:: yaml - :caption: specs.yaml - - versions: - - spec: 38 - when: distro=fedora - - - -.. code-block:: text - :caption: default.vtmp - - @from - docker.io/fedora:{{ __version__ }} - - @run - dnf -y upgrade - dnf clean all - -Now if you run `velocity avail` you should get the following. - -.. code-block:: bash - - user@hostname:~$ velocity avail - ==> fedora - 38 - -Now build the image. - -.. code-block:: bash - - user@hostname:~$ velocity build fedora - ==> Build Order: - fedora@38-aa51aa7 - - ==> aa51aa7: BUILD fedora@38 ... - ==> aa51aa7: GENERATING SCRIPT ... - ==> aa51aa7: BUILDING ... - ==> aa51aa7: IMAGE /tmp/velocity/build/fedora-38-aa51aa7/aa51aa7.sif (fedora@38) BUILT [0:01:07] - - ==> BUILT: /tmp/velocity/fedora-38__x86_64-fedora.sif - -If you wish to see more output you can add the `-v` flag: - -.. code-block:: bash - - user@hostname:~$ velocity build fedora -v - ==> Build Order: - fedora@38-aa51aa7 - - ==> aa51aa7: BUILD fedora@38 ... - ==> aa51aa7: GENERATING SCRIPT ... - SCRIPT: /tmp/velocity/build/fedora-38-aa51aa7/script - Bootstrap: docker - From: docker.io/fedora:38 - - %post - dnf -y upgrade - dnf clean all - ==> aa51aa7: BUILDING ... - #!/usr/bin/env bash - apptainer build --disable-cache /tmp/velocity/build/fedora-38-aa51aa7/aa51aa7.sif /tmp/velocity/build/fedora-38-aa51aa7/script; - Fedora 38 - x86_64 2.3 MB/s | 83 MB 00:35 - Fedora 38 openh264 (From Cisco) - x86_64 2.8 kB/s | 2.6 kB 00:00 - Fedora Modular 38 - x86_64 1.8 MB/s | 2.8 MB 00:01 - Fedora 38 - x86_64 - Updates 2.8 MB/s | 42 MB 00:14 - Fedora Modular 38 - x86_64 - Updates 257 kB/s | 2.2 MB 00:08 - Dependencies resolved. - ================================================================================ - Package Arch Version Repo Size - ================================================================================ - Upgrading: - fedora-release-common noarch 38-37 updates 20 k - fedora-release-container noarch 38-37 updates 10 k - fedora-release-identity-container noarch 38-37 updates 12 k - glibc x86_64 2.37-19.fc38 updates 2.1 M - glibc-common x86_64 2.37-19.fc38 updates 320 k - glibc-minimal-langpack x86_64 2.37-19.fc38 updates 42 k - gnutls x86_64 3.8.5-1.fc38 updates 1.1 M - libnghttp2 x86_64 1.52.0-3.fc38 updates 75 k - python-pip-wheel noarch 22.3.1-4.fc38 updates 1.4 M - python3 x86_64 3.11.9-2.fc38 updates 28 k - python3-libs x86_64 3.11.9-2.fc38 updates 9.6 M - tpm2-tss x86_64 4.0.2-1.fc38 updates 391 k - vim-data noarch 2:9.1.393-1.fc38 updates 23 k - vim-minimal x86_64 2:9.1.393-1.fc38 updates 810 k - Installing weak dependencies: - libxcrypt-compat x86_64 4.4.36-1.fc38 updates 90 k - - Transaction Summary - ================================================================================ - Install 1 Package - Upgrade 14 Packages - - Total download size: 16 M - Downloading Packages: - (1/15): fedora-release-container-38-37.noarch.r 160 kB/s | 10 kB 00:00 - (2/15): fedora-release-common-38-37.noarch.rpm 228 kB/s | 20 kB 00:00 - (3/15): fedora-release-identity-container-38-37 385 kB/s | 12 kB 00:00 - (4/15): libxcrypt-compat-4.4.36-1.fc38.x86_64.r 648 kB/s | 90 kB 00:00 - (5/15): glibc-minimal-langpack-2.37-19.fc38.x86 1.1 MB/s | 42 kB 00:00 - (6/15): glibc-common-2.37-19.fc38.x86_64.rpm 2.4 MB/s | 320 kB 00:00 - (7/15): libnghttp2-1.52.0-3.fc38.x86_64.rpm 1.7 MB/s | 75 kB 00:00 - (8/15): glibc-2.37-19.fc38.x86_64.rpm 8.1 MB/s | 2.1 MB 00:00 - (9/15): python3-3.11.9-2.fc38.x86_64.rpm 686 kB/s | 28 kB 00:00 - (10/15): python-pip-wheel-22.3.1-4.fc38.noarch. 8.8 MB/s | 1.4 MB 00:00 - (11/15): tpm2-tss-4.0.2-1.fc38.x86_64.rpm 6.1 MB/s | 391 kB 00:00 - (12/15): gnutls-3.8.5-1.fc38.x86_64.rpm 3.1 MB/s | 1.1 MB 00:00 - (13/15): vim-data-9.1.393-1.fc38.noarch.rpm 503 kB/s | 23 kB 00:00 - (14/15): vim-minimal-9.1.393-1.fc38.x86_64.rpm 4.3 MB/s | 810 kB 00:00 - (15/15): python3-libs-3.11.9-2.fc38.x86_64.rpm 11 MB/s | 9.6 MB 00:00 - -------------------------------------------------------------------------------- - Total 11 MB/s | 16 MB 00:01 - Running transaction check - Transaction check succeeded. - Running transaction test - Transaction test succeeded. - Running transaction - Preparing : 1/1 - Upgrading : glibc-common-2.37-19.fc38.x86_64 1/29 - Upgrading : glibc-minimal-langpack-2.37-19.fc38.x86_64 2/29 - Running scriptlet: glibc-2.37-19.fc38.x86_64 3/29 - Upgrading : glibc-2.37-19.fc38.x86_64 3/29 - Running scriptlet: glibc-2.37-19.fc38.x86_64 3/29 - Upgrading : fedora-release-identity-container-38-37.noarch 4/29 - Upgrading : fedora-release-container-38-37.noarch 5/29 - Upgrading : fedora-release-common-38-37.noarch 6/29 - Installing : libxcrypt-compat-4.4.36-1.fc38.x86_64 7/29 - Upgrading : python-pip-wheel-22.3.1-4.fc38.noarch 8/29 - Upgrading : python3-3.11.9-2.fc38.x86_64 9/29 - Upgrading : python3-libs-3.11.9-2.fc38.x86_64 10/29 - Upgrading : vim-data-2:9.1.393-1.fc38.noarch 11/29 - Upgrading : vim-minimal-2:9.1.393-1.fc38.x86_64 12/29 - Upgrading : gnutls-3.8.5-1.fc38.x86_64 13/29 - Upgrading : libnghttp2-1.52.0-3.fc38.x86_64 14/29 - Running scriptlet: tpm2-tss-4.0.2-1.fc38.x86_64 15/29 - Upgrading : tpm2-tss-4.0.2-1.fc38.x86_64 15/29 - Cleanup : fedora-release-common-38-36.noarch 16/29 - Cleanup : gnutls-3.8.4-1.fc38.x86_64 17/29 - Cleanup : tpm2-tss-4.0.1-3.fc38.x86_64 18/29 - Cleanup : vim-minimal-2:9.1.309-1.fc38.x86_64 19/29 - Cleanup : libnghttp2-1.52.0-2.fc38.x86_64 20/29 - Cleanup : python3-3.11.8-2.fc38.x86_64 21/29 - Cleanup : fedora-release-container-38-36.noarch 22/29 - Cleanup : fedora-release-identity-container-38-36.noarch 23/29 - Cleanup : vim-data-2:9.1.309-1.fc38.noarch 24/29 - Cleanup : python3-libs-3.11.8-2.fc38.x86_64 25/29 - Cleanup : python-pip-wheel-22.3.1-3.fc38.noarch 26/29 - Cleanup : glibc-2.37-18.fc38.x86_64 27/29 - Cleanup : glibc-minimal-langpack-2.37-18.fc38.x86_64 28/29 - Cleanup : glibc-common-2.37-18.fc38.x86_64 29/29 - Running scriptlet: glibc-common-2.37-18.fc38.x86_64 29/29 - Verifying : libxcrypt-compat-4.4.36-1.fc38.x86_64 1/29 - Verifying : fedora-release-common-38-37.noarch 2/29 - Verifying : fedora-release-common-38-36.noarch 3/29 - Verifying : fedora-release-container-38-37.noarch 4/29 - Verifying : fedora-release-container-38-36.noarch 5/29 - Verifying : fedora-release-identity-container-38-37.noarch 6/29 - Verifying : fedora-release-identity-container-38-36.noarch 7/29 - Verifying : glibc-2.37-19.fc38.x86_64 8/29 - Verifying : glibc-2.37-18.fc38.x86_64 9/29 - Verifying : glibc-common-2.37-19.fc38.x86_64 10/29 - Verifying : glibc-common-2.37-18.fc38.x86_64 11/29 - Verifying : glibc-minimal-langpack-2.37-19.fc38.x86_64 12/29 - Verifying : glibc-minimal-langpack-2.37-18.fc38.x86_64 13/29 - Verifying : gnutls-3.8.5-1.fc38.x86_64 14/29 - Verifying : gnutls-3.8.4-1.fc38.x86_64 15/29 - Verifying : libnghttp2-1.52.0-3.fc38.x86_64 16/29 - Verifying : libnghttp2-1.52.0-2.fc38.x86_64 17/29 - Verifying : python-pip-wheel-22.3.1-4.fc38.noarch 18/29 - Verifying : python-pip-wheel-22.3.1-3.fc38.noarch 19/29 - Verifying : python3-3.11.9-2.fc38.x86_64 20/29 - Verifying : python3-3.11.8-2.fc38.x86_64 21/29 - Verifying : python3-libs-3.11.9-2.fc38.x86_64 22/29 - Verifying : python3-libs-3.11.8-2.fc38.x86_64 23/29 - Verifying : tpm2-tss-4.0.2-1.fc38.x86_64 24/29 - Verifying : tpm2-tss-4.0.1-3.fc38.x86_64 25/29 - Verifying : vim-data-2:9.1.393-1.fc38.noarch 26/29 - Verifying : vim-data-2:9.1.309-1.fc38.noarch 27/29 - Verifying : vim-minimal-2:9.1.393-1.fc38.x86_64 28/29 - Verifying : vim-minimal-2:9.1.309-1.fc38.x86_64 29/29 - - Upgraded: - fedora-release-common-38-37.noarch - fedora-release-container-38-37.noarch - fedora-release-identity-container-38-37.noarch - glibc-2.37-19.fc38.x86_64 - glibc-common-2.37-19.fc38.x86_64 - glibc-minimal-langpack-2.37-19.fc38.x86_64 - gnutls-3.8.5-1.fc38.x86_64 - libnghttp2-1.52.0-3.fc38.x86_64 - python-pip-wheel-22.3.1-4.fc38.noarch - python3-3.11.9-2.fc38.x86_64 - python3-libs-3.11.9-2.fc38.x86_64 - tpm2-tss-4.0.2-1.fc38.x86_64 - vim-data-2:9.1.393-1.fc38.noarch - vim-minimal-2:9.1.393-1.fc38.x86_64 - Installed: - libxcrypt-compat-4.4.36-1.fc38.x86_64 - - Complete! - 42 files removed - ==> aa51aa7: IMAGE /tmp/velocity/build/fedora-38-aa51aa7/aa51aa7.sif (fedora@38) BUILT [0:01:33] - - ==> BUILT: /tmp/velocity/fedora-38__x86_64-fedora.sif - -Adding Different Versions -######################### -So now we have a base Fedora image. That's great but before we move on let's make some different versions of the image -so that we have more options for building later. Edit the fedora ``specs.yaml`` and add some versions. - -.. code-block:: yaml - :caption: spec.yaml - - versions: - - spec: - - 38 - - 39 - - 40 - - 41 - when: distro=fedora - -.. code-block:: bash - - user@hostname:~$ velocity avail - ==> fedora - 38 - 39 - 40 - 41 - -Specifying Version -################## -When building an image Velocity will default to the latest image. To specify a version use ``@`` e.g. -``fedora@40``. Versions take the form ``..-``. You can also specify greater than, less -than, and in-between via ``@:``, ``@:`` and ``@:`` respectively. - -Hello World! -############ -Now let's get a little more complicated. Let's create an image that runs a python script which prints hello world. You -can give it whatever version you want: - -.. code-block:: bash - :caption: /tmp/velocity/images - - fedora - ├── specs.yaml - └── templates - └── default.vtmp - hello-world - ├── files - │ └── hello_world.py - ├── specs.yaml - └── templates - └── default.vtmp - -Notice that now there is a new folder called ``files`` with a python script in it. - -.. code-block:: bash - :caption: hello_world.py - - #!/usr/bin/env python3 - - print("Hello, World!") - -.. code-block:: yaml - :caption: specs.yaml - - versions: - - spec: 1.0 - dependencies: - - spec: fedora - when: distro=fedora - files: - - name: hello_world.py - - -.. code-block:: text - :caption: default.vtmp - - @from - {{ __base__ }} - - @copy - hello_world.py /hello_world - - @run - dnf -y install python3 - chmod +x /hello_world - - @entry - /hello_world - - -.. code-block:: bash - - user@hostname:~$ velocity avail - ==> fedora - 38 - 39 - 40 - 41 - ==> hello-world - 1.0 - -.. code-block:: bash - - user@hostname:~$ velocity build hello-world -v - ==> Build Order: - fedora@41-8a9a360 - hello-world@1.0-de9c02b - - ==> 8a9a360: BUILD fedora@41 ... - ==> 8a9a360: GENERATING SCRIPT ... - SCRIPT: /tmp/velocity/build/fedora-41-8a9a360/script - Bootstrap: docker - From: docker.io/fedora:41 - - %post - dnf -y upgrade - dnf clean all - ==> 8a9a360: BUILDING ... - #!/usr/bin/env bash - apptainer build --disable-cache /tmp/velocity/build/fedora-41-8a9a360/8a9a360.sif /tmp/velocity/build/fedora-41-8a9a360/script; - Updating and loading repositories: - Fedora 41 openh264 (From Cisco) - x86_ 100% | 6.5 KiB/s | 4.8 KiB | 00m01s - Fedora 41 - x86_64 - Test Updates 100% | 1.8 MiB/s | 3.4 MiB | 00m02s - Fedora 41 - x86_64 100% | 13.9 MiB/s | 35.9 MiB | 00m03s - Fedora 41 - x86_64 - Updates 100% | 50.3 KiB/s | 31.9 KiB | 00m01s - Repositories loaded. - Package Arch Version Repository Size - Upgrading: - libgcc x86_64 14.2.1-3.fc41 updates-testing 274.6 KiB - replacing libgcc x86_64 14.2.1-1.fc41 34086d2996104518800c8d7dcc6139a1 274.6 KiB - libgomp x86_64 14.2.1-3.fc41 updates-testing 523.5 KiB - replacing libgomp x86_64 14.2.1-1.fc41 34086d2996104518800c8d7dcc6139a1 523.4 KiB - libstdc++ x86_64 14.2.1-3.fc41 updates-testing 2.8 MiB - replacing libstdc++ x86_64 14.2.1-1.fc41 34086d2996104518800c8d7dcc6139a1 2.8 MiB - openssl-libs x86_64 1:3.2.2-7.fc41 updates-testing 7.8 MiB - replacing openssl-libs x86_64 1:3.2.2-5.fc41 34086d2996104518800c8d7dcc6139a1 7.8 MiB - rpm x86_64 4.19.94-1.fc41 updates-testing 3.1 MiB - replacing rpm x86_64 4.19.92-6.fc41 34086d2996104518800c8d7dcc6139a1 3.1 MiB - rpm-build-libs x86_64 4.19.94-1.fc41 updates-testing 206.7 KiB - replacing rpm-build-libs x86_64 4.19.92-6.fc41 34086d2996104518800c8d7dcc6139a1 206.7 KiB - rpm-libs x86_64 4.19.94-1.fc41 updates-testing 721.9 KiB - replacing rpm-libs x86_64 4.19.92-6.fc41 34086d2996104518800c8d7dcc6139a1 721.9 KiB - systemd-libs x86_64 256.6-1.fc41 updates-testing 2.0 MiB - replacing systemd-libs x86_64 256.5-1.fc41 34086d2996104518800c8d7dcc6139a1 2.0 MiB - zlib-ng-compat x86_64 2.1.7-3.fc41 updates-testing 134.0 KiB - replacing zlib-ng-compat x86_64 2.1.7-2.fc41 34086d2996104518800c8d7dcc6139a1 134.0 KiB - - Transaction Summary: - Upgrading: 9 packages - Replacing: 9 packages - - Total size of inbound packages is 5 MiB. Need to download 5 MiB. - After this operation 2 KiB will be used (install 17 MiB, remove 17 MiB). - [1/9] libgcc-0:14.2.1-3.fc41.x86_64 100% | 132.2 KiB/s | 133.3 KiB | 00m01s - [2/9] libstdc++-0:14.2.1-3.fc41.x86_64 100% | 583.3 KiB/s | 887.8 KiB | 00m02s - [3/9] libgomp-0:14.2.1-3.fc41.x86_64 100% | 208.5 KiB/s | 354.1 KiB | 00m02s - [4/9] rpm-0:4.19.94-1.fc41.x86_64 100% | 1.6 MiB/s | 547.6 KiB | 00m00s - [5/9] rpm-build-libs-0:4.19.94-1.fc41.x 100% | 2.1 MiB/s | 99.1 KiB | 00m00s - [6/9] openssl-libs-1:3.2.2-7.fc41.x86_6 100% | 2.6 MiB/s | 2.3 MiB | 00m01s - [7/9] rpm-libs-0:4.19.94-1.fc41.x86_64 100% | 1.1 MiB/s | 309.5 KiB | 00m00s - [8/9] zlib-ng-compat-0:2.1.7-3.fc41.x86 100% | 1.0 MiB/s | 77.7 KiB | 00m00s - [9/9] systemd-libs-0:256.6-1.fc41.x86_6 100% | 2.6 MiB/s | 730.9 KiB | 00m00s - -------------------------------------------------------------------------------- - [9/9] Total 100% | 2.2 MiB/s | 5.4 MiB | 00m02s - Running transaction - [ 1/20] Verify package files 100% | 750.0 B/s | 9.0 B | 00m00s - [ 2/20] Prepare transaction 100% | 1.6 KiB/s | 18.0 B | 00m00s - [ 3/20] Upgrading libgcc-0:14.2.1-3.fc4 100% | 14.2 MiB/s | 276.3 KiB | 00m00s - >>> Running post-install scriptlet: libgcc-0:14.2.1-3.fc41.x86_64 - >>> Stop post-install scriptlet: libgcc-0:14.2.1-3.fc41.x86_64 - [ 4/20] Upgrading zlib-ng-compat-0:2.1. 100% | 32.9 MiB/s | 134.8 KiB | 00m00s - [ 5/20] Upgrading rpm-libs-0:4.19.94-1. 100% | 117.7 MiB/s | 723.4 KiB | 00m00s - [ 6/20] Upgrading libgomp-0:14.2.1-3.fc 100% | 170.8 MiB/s | 524.8 KiB | 00m00s - [ 7/20] Upgrading rpm-build-libs-0:4.19 100% | 15.6 MiB/s | 207.5 KiB | 00m00s - >>> Running pre-install scriptlet: rpm-0:4.19.94-1.fc41.x86_64 - >>> Stop pre-install scriptlet: rpm-0:4.19.94-1.fc41.x86_64 - [ 8/20] Upgrading rpm-0:4.19.94-1.fc41. 100% | 104.3 MiB/s | 2.5 MiB | 00m00s - [ 9/20] Upgrading openssl-libs-1:3.2.2- 100% | 190.9 MiB/s | 7.8 MiB | 00m00s - [10/20] Upgrading libstdc++-0:14.2.1-3. 100% | 145.6 MiB/s | 2.8 MiB | 00m00s - [11/20] Upgrading systemd-libs-0:256.6- 100% | 135.3 MiB/s | 2.0 MiB | 00m00s - [12/20] Erasing rpm-build-libs-0:4.19.9 100% | 1.0 KiB/s | 5.0 B | 00m00s - [13/20] Erasing libstdc++-0:14.2.1-1.fc 100% | 6.1 KiB/s | 31.0 B | 00m00s - [14/20] Erasing systemd-libs-0:256.5-1. 100% | 2.4 KiB/s | 20.0 B | 00m00s - [15/20] Erasing rpm-0:4.19.92-6.fc41.x8 100% | 26.7 KiB/s | 273.0 B | 00m00s - [16/20] Erasing rpm-libs-0:4.19.92-6.fc 100% | 2.4 KiB/s | 10.0 B | 00m00s - [17/20] Erasing openssl-libs-1:3.2.2-5. 100% | 9.5 KiB/s | 39.0 B | 00m00s - [18/20] Erasing zlib-ng-compat-0:2.1.7- 100% | 1.2 KiB/s | 5.0 B | 00m00s - [19/20] Erasing libgcc-0:14.2.1-1.fc41. 100% | 647.0 B/s | 11.0 B | 00m00s - >>> Running post-uninstall scriptlet: libgcc-0:14.2.1-1.fc41.x86_64 - >>> Stop post-uninstall scriptlet: libgcc-0:14.2.1-1.fc41.x86_64 - [20/20] Erasing libgomp-0:14.2.1-1.fc41 100% | 43.0 B/s | 9.0 B | 00m00s - >>> Running post-transaction scriptlet: rpm-0:4.19.94-1.fc41.x86_64 - >>> Stop post-transaction scriptlet: rpm-0:4.19.94-1.fc41.x86_64 - >>> Running trigger-install scriptlet: glibc-common-0:2.40-3.fc41.x86_64 - >>> Stop trigger-install scriptlet: glibc-common-0:2.40-3.fc41.x86_64 - >>> Running trigger-post-uninstall scriptlet: glibc-common-0:2.40-3.fc41.x86_64 - >>> Stop trigger-post-uninstall scriptlet: glibc-common-0:2.40-3.fc41.x86_64 - Complete! - Removed 24 files, 13 directories. 0 errors occurred. - ==> 8a9a360: IMAGE /tmp/velocity/build/fedora-41-8a9a360/8a9a360.sif (fedora@41) BUILT [0:00:21] - - ==> de9c02b: BUILD hello-world@1.0 ... - ==> de9c02b: COPYING FILES ... - FILE: /tmp/velocity/images/hello-world/files/hello_world.py -> /tmp/velocity/build/hello-world-1.0-de9c02b/hello_world.py - ==> de9c02b: GENERATING SCRIPT ... - SCRIPT: /tmp/velocity/build/hello-world-1.0-de9c02b/script - Bootstrap: localimage - From: /tmp/velocity/build/fedora-41-8a9a360/8a9a360.sif - - %files - hello_world.py /hello_world - - %post - dnf -y install python3 - chmod +x /hello_world - - %runscript - /hello_world - ==> de9c02b: BUILDING ... - #!/usr/bin/env bash - apptainer build --disable-cache /tmp/velocity/build/hello-world-1.0-de9c02b/de9c02b.sif /tmp/velocity/build/hello-world-1.0-de9c02b/script; - Updating and loading repositories: - Fedora 41 openh264 (From Cisco) - x86_ 100% | 11.1 KiB/s | 6.0 KiB | 00m01s - Fedora 41 - x86_64 100% | 11.7 MiB/s | 35.4 MiB | 00m03s - Fedora 41 - x86_64 - Updates 100% | 50.1 KiB/s | 31.9 KiB | 00m01s - Fedora 41 - x86_64 - Test Updates 100% | 1.8 MiB/s | 2.1 MiB | 00m01s - Repositories loaded. - Package Arch Version Repository Size - Installing: - python3 x86_64 3.13.0~rc2-1.fc41 fedora 31.8 KiB - Installing dependencies: - expat x86_64 2.6.3-1.fc41 updates-testing 291.5 KiB - libb2 x86_64 0.98.1-12.fc41 fedora 42.2 KiB - mpdecimal x86_64 2.5.1-16.fc41 fedora 204.9 KiB - python-pip-wheel noarch 24.2-1.fc41 fedora 1.2 MiB - python3-libs x86_64 3.13.0~rc2-1.fc41 fedora 40.3 MiB - Installing weak dependencies: - python-unversioned-command noarch 3.13.0~rc2-1.fc41 fedora 23.0 B - - Transaction Summary: - Installing: 7 packages - - Total size of inbound packages is 11 MiB. Need to download 11 MiB. - After this operation 42 MiB will be used (install 42 MiB, remove 0 B). - [1/7] libb2-0:0.98.1-12.fc41.x86_64 100% | 94.1 KiB/s | 25.7 KiB | 00m00s - [2/7] python3-0:3.13.0~rc2-1.fc41.x86_6 100% | 95.9 KiB/s | 27.4 KiB | 00m00s - [3/7] mpdecimal-0:2.5.1-16.fc41.x86_64 100% | 408.0 KiB/s | 89.0 KiB | 00m00s - [4/7] expat-0:2.6.3-1.fc41.x86_64 100% | 447.4 KiB/s | 114.1 KiB | 00m00s - [5/7] python-pip-wheel-0:24.2-1.fc41.no 100% | 2.5 MiB/s | 1.2 MiB | 00m00s - [6/7] python-unversioned-command-0:3.13 100% | 125.1 KiB/s | 10.5 KiB | 00m00s - [7/7] python3-libs-0:3.13.0~rc2-1.fc41. 100% | 8.1 MiB/s | 9.1 MiB | 00m01s - -------------------------------------------------------------------------------- - [7/7] Total 100% | 6.7 MiB/s | 10.6 MiB | 00m02s - Running transaction - [1/9] Verify package files 100% | 269.0 B/s | 7.0 B | 00m00s - [2/9] Prepare transaction 100% | 280.0 B/s | 7.0 B | 00m00s - [3/9] Installing expat-0:2.6.3-1.fc41.x 100% | 71.7 MiB/s | 293.6 KiB | 00m00s - [4/9] Installing python-pip-wheel-0:24. 100% | 310.4 MiB/s | 1.2 MiB | 00m00s - [5/9] Installing mpdecimal-0:2.5.1-16.f 100% | 50.3 MiB/s | 206.0 KiB | 00m00s - [6/9] Installing libb2-0:0.98.1-12.fc41 100% | 4.7 MiB/s | 43.3 KiB | 00m00s - [7/9] Installing python3-libs-0:3.13.0~ 100% | 139.9 MiB/s | 40.7 MiB | 00m00s - [8/9] Installing python3-0:3.13.0~rc2-1 100% | 10.9 MiB/s | 33.6 KiB | 00m00s - [9/9] Installing python-unversioned-com 100% | 1.8 KiB/s | 424.0 B | 00m00s - >>> Running trigger-install scriptlet: glibc-common-0:2.40-3.fc41.x86_64 - >>> Stop trigger-install scriptlet: glibc-common-0:2.40-3.fc41.x86_64 - Complete! - ==> de9c02b: IMAGE /tmp/velocity/build/hello-world-1.0-de9c02b/de9c02b.sif (hello-world@1.0) BUILT [0:00:14] - - ==> BUILT: /tmp/velocity/hello-world-1.0_fedora-41__x86_64-fedora.sif - - -Our hello-world image has been built! - -.. code-block:: bash - :emphasize-lines: 7 - - user@hostname:~$ ls - total 190972 - drwxr-xr-x 4 xjv users 4096 Sep 18 10:01 . - drwxrwxrwt 31 root root 131072 Sep 18 10:01 .. - drwxr-xr-x 4 xjv users 4096 Sep 18 10:01 build - -rwxr-xr-x 1 xjv users 66007040 Sep 18 09:42 fedora-38__x86_64-fedora.sif - -rwxr-xr-x 1 xjv users 129392640 Sep 18 10:01 hello-world-1.0_fedora-41__x86_64-fedora.sif - drwxr-xr-x 4 xjv users 4096 Sep 18 09:44 images - - -Now you can run the image! - -.. code-block:: bash - - user@hostname:~$ apptainer run hello-world-1.0_fedora-41__x86_64-fedora.sif - Hello, World! diff --git a/docs/build/html/_static/_sphinx_javascript_frameworks_compat.js b/docs/build/html/_static/_sphinx_javascript_frameworks_compat.js deleted file mode 100644 index 8141580..0000000 --- a/docs/build/html/_static/_sphinx_javascript_frameworks_compat.js +++ /dev/null @@ -1,123 +0,0 @@ -/* Compatability shim for jQuery and underscores.js. - * - * Copyright Sphinx contributors - * Released under the two clause BSD licence - */ - -/** - * 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/docs/build/html/_static/basic.css b/docs/build/html/_static/basic.css deleted file mode 100644 index f316efc..0000000 --- a/docs/build/html/_static/basic.css +++ /dev/null @@ -1,925 +0,0 @@ -/* - * basic.css - * ~~~~~~~~~ - * - * Sphinx stylesheet -- basic theme. - * - * :copyright: Copyright 2007-2024 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; -} - -a:visited { - color: #551A8B; -} - -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; -} - -.sig dd { - margin-top: 0px; - margin-bottom: 0px; -} - -.sig dl { - margin-top: 0px; - margin-bottom: 0px; -} - -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; -} - -.translated { - background-color: rgba(207, 255, 207, 0.2) -} - -.untranslated { - background-color: rgba(255, 207, 207, 0.2) -} - -/* -- 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/docs/build/html/_static/css/badge_only.css b/docs/build/html/_static/css/badge_only.css deleted file mode 100644 index c718cee..0000000 --- a/docs/build/html/_static/css/badge_only.css +++ /dev/null @@ -1 +0,0 @@ -.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/docs/build/html/_static/css/fonts/Roboto-Slab-Bold.woff b/docs/build/html/_static/css/fonts/Roboto-Slab-Bold.woff deleted file mode 100644 index 6cb6000..0000000 Binary files a/docs/build/html/_static/css/fonts/Roboto-Slab-Bold.woff and /dev/null differ diff --git a/docs/build/html/_static/css/fonts/Roboto-Slab-Bold.woff2 b/docs/build/html/_static/css/fonts/Roboto-Slab-Bold.woff2 deleted file mode 100644 index 7059e23..0000000 Binary files a/docs/build/html/_static/css/fonts/Roboto-Slab-Bold.woff2 and /dev/null differ diff --git a/docs/build/html/_static/css/fonts/Roboto-Slab-Regular.woff b/docs/build/html/_static/css/fonts/Roboto-Slab-Regular.woff deleted file mode 100644 index f815f63..0000000 Binary files a/docs/build/html/_static/css/fonts/Roboto-Slab-Regular.woff and /dev/null differ diff --git a/docs/build/html/_static/css/fonts/Roboto-Slab-Regular.woff2 b/docs/build/html/_static/css/fonts/Roboto-Slab-Regular.woff2 deleted file mode 100644 index f2c76e5..0000000 Binary files a/docs/build/html/_static/css/fonts/Roboto-Slab-Regular.woff2 and /dev/null differ diff --git a/docs/build/html/_static/css/fonts/fontawesome-webfont.eot b/docs/build/html/_static/css/fonts/fontawesome-webfont.eot deleted file mode 100644 index e9f60ca..0000000 Binary files a/docs/build/html/_static/css/fonts/fontawesome-webfont.eot and /dev/null differ diff --git a/docs/build/html/_static/css/fonts/fontawesome-webfont.svg b/docs/build/html/_static/css/fonts/fontawesome-webfont.svg deleted file mode 100644 index 855c845..0000000 --- a/docs/build/html/_static/css/fonts/fontawesome-webfont.svg +++ /dev/null @@ -1,2671 +0,0 @@ - - - - -Created by FontForge 20120731 at Mon Oct 24 17:37:40 2016 - By ,,, -Copyright Dave Gandy 2016. All rights reserved. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/build/html/_static/css/fonts/fontawesome-webfont.ttf b/docs/build/html/_static/css/fonts/fontawesome-webfont.ttf deleted file mode 100644 index 35acda2..0000000 Binary files a/docs/build/html/_static/css/fonts/fontawesome-webfont.ttf and /dev/null differ diff --git a/docs/build/html/_static/css/fonts/fontawesome-webfont.woff b/docs/build/html/_static/css/fonts/fontawesome-webfont.woff deleted file mode 100644 index 400014a..0000000 Binary files a/docs/build/html/_static/css/fonts/fontawesome-webfont.woff and /dev/null differ diff --git a/docs/build/html/_static/css/fonts/fontawesome-webfont.woff2 b/docs/build/html/_static/css/fonts/fontawesome-webfont.woff2 deleted file mode 100644 index 4d13fc6..0000000 Binary files a/docs/build/html/_static/css/fonts/fontawesome-webfont.woff2 and /dev/null differ diff --git a/docs/build/html/_static/css/fonts/lato-bold-italic.woff b/docs/build/html/_static/css/fonts/lato-bold-italic.woff deleted file mode 100644 index 88ad05b..0000000 Binary files a/docs/build/html/_static/css/fonts/lato-bold-italic.woff and /dev/null differ diff --git a/docs/build/html/_static/css/fonts/lato-bold-italic.woff2 b/docs/build/html/_static/css/fonts/lato-bold-italic.woff2 deleted file mode 100644 index c4e3d80..0000000 Binary files a/docs/build/html/_static/css/fonts/lato-bold-italic.woff2 and /dev/null differ diff --git a/docs/build/html/_static/css/fonts/lato-bold.woff b/docs/build/html/_static/css/fonts/lato-bold.woff deleted file mode 100644 index c6dff51..0000000 Binary files a/docs/build/html/_static/css/fonts/lato-bold.woff and /dev/null differ diff --git a/docs/build/html/_static/css/fonts/lato-bold.woff2 b/docs/build/html/_static/css/fonts/lato-bold.woff2 deleted file mode 100644 index bb19504..0000000 Binary files a/docs/build/html/_static/css/fonts/lato-bold.woff2 and /dev/null differ diff --git a/docs/build/html/_static/css/fonts/lato-normal-italic.woff b/docs/build/html/_static/css/fonts/lato-normal-italic.woff deleted file mode 100644 index 76114bc..0000000 Binary files a/docs/build/html/_static/css/fonts/lato-normal-italic.woff and /dev/null differ diff --git a/docs/build/html/_static/css/fonts/lato-normal-italic.woff2 b/docs/build/html/_static/css/fonts/lato-normal-italic.woff2 deleted file mode 100644 index 3404f37..0000000 Binary files a/docs/build/html/_static/css/fonts/lato-normal-italic.woff2 and /dev/null differ diff --git a/docs/build/html/_static/css/fonts/lato-normal.woff b/docs/build/html/_static/css/fonts/lato-normal.woff deleted file mode 100644 index ae1307f..0000000 Binary files a/docs/build/html/_static/css/fonts/lato-normal.woff and /dev/null differ diff --git a/docs/build/html/_static/css/fonts/lato-normal.woff2 b/docs/build/html/_static/css/fonts/lato-normal.woff2 deleted file mode 100644 index 3bf9843..0000000 Binary files a/docs/build/html/_static/css/fonts/lato-normal.woff2 and /dev/null differ diff --git a/docs/build/html/_static/css/theme.css b/docs/build/html/_static/css/theme.css deleted file mode 100644 index 19a446a..0000000 --- a/docs/build/html/_static/css/theme.css +++ /dev/null @@ -1,4 +0,0 @@ -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/docs/build/html/_static/doctools.js b/docs/build/html/_static/doctools.js deleted file mode 100644 index 4d67807..0000000 --- a/docs/build/html/_static/doctools.js +++ /dev/null @@ -1,156 +0,0 @@ -/* - * doctools.js - * ~~~~~~~~~~~ - * - * Base JavaScript utilities for all Sphinx HTML documentation. - * - * :copyright: Copyright 2007-2024 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/docs/build/html/_static/documentation_options.js b/docs/build/html/_static/documentation_options.js deleted file mode 100644 index 7e4c114..0000000 --- a/docs/build/html/_static/documentation_options.js +++ /dev/null @@ -1,13 +0,0 @@ -const DOCUMENTATION_OPTIONS = { - VERSION: '', - LANGUAGE: 'en', - COLLAPSE_INDEX: false, - BUILDER: 'html', - 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/docs/build/html/_static/file.png b/docs/build/html/_static/file.png deleted file mode 100644 index a858a41..0000000 Binary files a/docs/build/html/_static/file.png and /dev/null differ diff --git a/docs/build/html/_static/icon.png b/docs/build/html/_static/icon.png deleted file mode 100644 index c89e581..0000000 Binary files a/docs/build/html/_static/icon.png and /dev/null differ diff --git a/docs/build/html/_static/jquery.js b/docs/build/html/_static/jquery.js deleted file mode 100644 index c4c6022..0000000 --- a/docs/build/html/_static/jquery.js +++ /dev/null @@ -1,2 +0,0 @@ -/*! jQuery v3.6.0 | (c) OpenJS Foundation and other contributors | jquery.org/license */ -!function(e,t){"use strict";"object"==typeof module&&"object"==typeof module.exports?module.exports=e.document?t(e,!0):function(e){if(!e.document)throw new Error("jQuery requires a window with a document");return t(e)}:t(e)}("undefined"!=typeof window?window:this,function(C,e){"use strict";var t=[],r=Object.getPrototypeOf,s=t.slice,g=t.flat?function(e){return t.flat.call(e)}:function(e){return t.concat.apply([],e)},u=t.push,i=t.indexOf,n={},o=n.toString,v=n.hasOwnProperty,a=v.toString,l=a.call(Object),y={},m=function(e){return"function"==typeof e&&"number"!=typeof e.nodeType&&"function"!=typeof e.item},x=function(e){return null!=e&&e===e.window},E=C.document,c={type:!0,src:!0,nonce:!0,noModule:!0};function b(e,t,n){var r,i,o=(n=n||E).createElement("script");if(o.text=e,t)for(r in c)(i=t[r]||t.getAttribute&&t.getAttribute(r))&&o.setAttribute(r,i);n.head.appendChild(o).parentNode.removeChild(o)}function w(e){return null==e?e+"":"object"==typeof e||"function"==typeof e?n[o.call(e)]||"object":typeof e}var f="3.6.0",S=function(e,t){return new S.fn.init(e,t)};function p(e){var t=!!e&&"length"in e&&e.length,n=w(e);return!m(e)&&!x(e)&&("array"===n||0===t||"number"==typeof t&&0+~]|"+M+")"+M+"*"),U=new RegExp(M+"|>"),X=new RegExp(F),V=new RegExp("^"+I+"$"),G={ID:new RegExp("^#("+I+")"),CLASS:new RegExp("^\\.("+I+")"),TAG:new RegExp("^("+I+"|[*])"),ATTR:new RegExp("^"+W),PSEUDO:new RegExp("^"+F),CHILD:new RegExp("^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\("+M+"*(even|odd|(([+-]|)(\\d*)n|)"+M+"*(?:([+-]|)"+M+"*(\\d+)|))"+M+"*\\)|)","i"),bool:new RegExp("^(?:"+R+")$","i"),needsContext:new RegExp("^"+M+"*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\("+M+"*((?:-\\d)?\\d*)"+M+"*\\)|)(?=[^-]|$)","i")},Y=/HTML$/i,Q=/^(?:input|select|textarea|button)$/i,J=/^h\d$/i,K=/^[^{]+\{\s*\[native \w/,Z=/^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/,ee=/[+~]/,te=new RegExp("\\\\[\\da-fA-F]{1,6}"+M+"?|\\\\([^\\r\\n\\f])","g"),ne=function(e,t){var n="0x"+e.slice(1)-65536;return t||(n<0?String.fromCharCode(n+65536):String.fromCharCode(n>>10|55296,1023&n|56320))},re=/([\0-\x1f\x7f]|^-?\d)|^-$|[^\0-\x1f\x7f-\uFFFF\w-]/g,ie=function(e,t){return t?"\0"===e?"\ufffd":e.slice(0,-1)+"\\"+e.charCodeAt(e.length-1).toString(16)+" ":"\\"+e},oe=function(){T()},ae=be(function(e){return!0===e.disabled&&"fieldset"===e.nodeName.toLowerCase()},{dir:"parentNode",next:"legend"});try{H.apply(t=O.call(p.childNodes),p.childNodes),t[p.childNodes.length].nodeType}catch(e){H={apply:t.length?function(e,t){L.apply(e,O.call(t))}:function(e,t){var n=e.length,r=0;while(e[n++]=t[r++]);e.length=n-1}}}function se(t,e,n,r){var i,o,a,s,u,l,c,f=e&&e.ownerDocument,p=e?e.nodeType:9;if(n=n||[],"string"!=typeof t||!t||1!==p&&9!==p&&11!==p)return n;if(!r&&(T(e),e=e||C,E)){if(11!==p&&(u=Z.exec(t)))if(i=u[1]){if(9===p){if(!(a=e.getElementById(i)))return n;if(a.id===i)return n.push(a),n}else if(f&&(a=f.getElementById(i))&&y(e,a)&&a.id===i)return n.push(a),n}else{if(u[2])return H.apply(n,e.getElementsByTagName(t)),n;if((i=u[3])&&d.getElementsByClassName&&e.getElementsByClassName)return H.apply(n,e.getElementsByClassName(i)),n}if(d.qsa&&!N[t+" "]&&(!v||!v.test(t))&&(1!==p||"object"!==e.nodeName.toLowerCase())){if(c=t,f=e,1===p&&(U.test(t)||z.test(t))){(f=ee.test(t)&&ye(e.parentNode)||e)===e&&d.scope||((s=e.getAttribute("id"))?s=s.replace(re,ie):e.setAttribute("id",s=S)),o=(l=h(t)).length;while(o--)l[o]=(s?"#"+s:":scope")+" "+xe(l[o]);c=l.join(",")}try{return H.apply(n,f.querySelectorAll(c)),n}catch(e){N(t,!0)}finally{s===S&&e.removeAttribute("id")}}}return g(t.replace($,"$1"),e,n,r)}function ue(){var r=[];return function e(t,n){return r.push(t+" ")>b.cacheLength&&delete e[r.shift()],e[t+" "]=n}}function le(e){return e[S]=!0,e}function ce(e){var t=C.createElement("fieldset");try{return!!e(t)}catch(e){return!1}finally{t.parentNode&&t.parentNode.removeChild(t),t=null}}function fe(e,t){var n=e.split("|"),r=n.length;while(r--)b.attrHandle[n[r]]=t}function pe(e,t){var n=t&&e,r=n&&1===e.nodeType&&1===t.nodeType&&e.sourceIndex-t.sourceIndex;if(r)return r;if(n)while(n=n.nextSibling)if(n===t)return-1;return e?1:-1}function de(t){return function(e){return"input"===e.nodeName.toLowerCase()&&e.type===t}}function he(n){return function(e){var t=e.nodeName.toLowerCase();return("input"===t||"button"===t)&&e.type===n}}function ge(t){return function(e){return"form"in e?e.parentNode&&!1===e.disabled?"label"in e?"label"in e.parentNode?e.parentNode.disabled===t:e.disabled===t:e.isDisabled===t||e.isDisabled!==!t&&ae(e)===t:e.disabled===t:"label"in e&&e.disabled===t}}function ve(a){return le(function(o){return o=+o,le(function(e,t){var n,r=a([],e.length,o),i=r.length;while(i--)e[n=r[i]]&&(e[n]=!(t[n]=e[n]))})})}function ye(e){return e&&"undefined"!=typeof e.getElementsByTagName&&e}for(e in d=se.support={},i=se.isXML=function(e){var t=e&&e.namespaceURI,n=e&&(e.ownerDocument||e).documentElement;return!Y.test(t||n&&n.nodeName||"HTML")},T=se.setDocument=function(e){var t,n,r=e?e.ownerDocument||e:p;return r!=C&&9===r.nodeType&&r.documentElement&&(a=(C=r).documentElement,E=!i(C),p!=C&&(n=C.defaultView)&&n.top!==n&&(n.addEventListener?n.addEventListener("unload",oe,!1):n.attachEvent&&n.attachEvent("onunload",oe)),d.scope=ce(function(e){return a.appendChild(e).appendChild(C.createElement("div")),"undefined"!=typeof e.querySelectorAll&&!e.querySelectorAll(":scope fieldset div").length}),d.attributes=ce(function(e){return e.className="i",!e.getAttribute("className")}),d.getElementsByTagName=ce(function(e){return e.appendChild(C.createComment("")),!e.getElementsByTagName("*").length}),d.getElementsByClassName=K.test(C.getElementsByClassName),d.getById=ce(function(e){return a.appendChild(e).id=S,!C.getElementsByName||!C.getElementsByName(S).length}),d.getById?(b.filter.ID=function(e){var t=e.replace(te,ne);return function(e){return e.getAttribute("id")===t}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&E){var n=t.getElementById(e);return n?[n]:[]}}):(b.filter.ID=function(e){var n=e.replace(te,ne);return function(e){var t="undefined"!=typeof e.getAttributeNode&&e.getAttributeNode("id");return t&&t.value===n}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&E){var n,r,i,o=t.getElementById(e);if(o){if((n=o.getAttributeNode("id"))&&n.value===e)return[o];i=t.getElementsByName(e),r=0;while(o=i[r++])if((n=o.getAttributeNode("id"))&&n.value===e)return[o]}return[]}}),b.find.TAG=d.getElementsByTagName?function(e,t){return"undefined"!=typeof t.getElementsByTagName?t.getElementsByTagName(e):d.qsa?t.querySelectorAll(e):void 0}:function(e,t){var n,r=[],i=0,o=t.getElementsByTagName(e);if("*"===e){while(n=o[i++])1===n.nodeType&&r.push(n);return r}return o},b.find.CLASS=d.getElementsByClassName&&function(e,t){if("undefined"!=typeof t.getElementsByClassName&&E)return t.getElementsByClassName(e)},s=[],v=[],(d.qsa=K.test(C.querySelectorAll))&&(ce(function(e){var t;a.appendChild(e).innerHTML="",e.querySelectorAll("[msallowcapture^='']").length&&v.push("[*^$]="+M+"*(?:''|\"\")"),e.querySelectorAll("[selected]").length||v.push("\\["+M+"*(?:value|"+R+")"),e.querySelectorAll("[id~="+S+"-]").length||v.push("~="),(t=C.createElement("input")).setAttribute("name",""),e.appendChild(t),e.querySelectorAll("[name='']").length||v.push("\\["+M+"*name"+M+"*="+M+"*(?:''|\"\")"),e.querySelectorAll(":checked").length||v.push(":checked"),e.querySelectorAll("a#"+S+"+*").length||v.push(".#.+[+~]"),e.querySelectorAll("\\\f"),v.push("[\\r\\n\\f]")}),ce(function(e){e.innerHTML="";var t=C.createElement("input");t.setAttribute("type","hidden"),e.appendChild(t).setAttribute("name","D"),e.querySelectorAll("[name=d]").length&&v.push("name"+M+"*[*^$|!~]?="),2!==e.querySelectorAll(":enabled").length&&v.push(":enabled",":disabled"),a.appendChild(e).disabled=!0,2!==e.querySelectorAll(":disabled").length&&v.push(":enabled",":disabled"),e.querySelectorAll("*,:x"),v.push(",.*:")})),(d.matchesSelector=K.test(c=a.matches||a.webkitMatchesSelector||a.mozMatchesSelector||a.oMatchesSelector||a.msMatchesSelector))&&ce(function(e){d.disconnectedMatch=c.call(e,"*"),c.call(e,"[s!='']:x"),s.push("!=",F)}),v=v.length&&new RegExp(v.join("|")),s=s.length&&new RegExp(s.join("|")),t=K.test(a.compareDocumentPosition),y=t||K.test(a.contains)?function(e,t){var n=9===e.nodeType?e.documentElement:e,r=t&&t.parentNode;return e===r||!(!r||1!==r.nodeType||!(n.contains?n.contains(r):e.compareDocumentPosition&&16&e.compareDocumentPosition(r)))}:function(e,t){if(t)while(t=t.parentNode)if(t===e)return!0;return!1},j=t?function(e,t){if(e===t)return l=!0,0;var n=!e.compareDocumentPosition-!t.compareDocumentPosition;return n||(1&(n=(e.ownerDocument||e)==(t.ownerDocument||t)?e.compareDocumentPosition(t):1)||!d.sortDetached&&t.compareDocumentPosition(e)===n?e==C||e.ownerDocument==p&&y(p,e)?-1:t==C||t.ownerDocument==p&&y(p,t)?1:u?P(u,e)-P(u,t):0:4&n?-1:1)}:function(e,t){if(e===t)return l=!0,0;var n,r=0,i=e.parentNode,o=t.parentNode,a=[e],s=[t];if(!i||!o)return e==C?-1:t==C?1:i?-1:o?1:u?P(u,e)-P(u,t):0;if(i===o)return pe(e,t);n=e;while(n=n.parentNode)a.unshift(n);n=t;while(n=n.parentNode)s.unshift(n);while(a[r]===s[r])r++;return r?pe(a[r],s[r]):a[r]==p?-1:s[r]==p?1:0}),C},se.matches=function(e,t){return se(e,null,null,t)},se.matchesSelector=function(e,t){if(T(e),d.matchesSelector&&E&&!N[t+" "]&&(!s||!s.test(t))&&(!v||!v.test(t)))try{var n=c.call(e,t);if(n||d.disconnectedMatch||e.document&&11!==e.document.nodeType)return n}catch(e){N(t,!0)}return 0":{dir:"parentNode",first:!0}," ":{dir:"parentNode"},"+":{dir:"previousSibling",first:!0},"~":{dir:"previousSibling"}},preFilter:{ATTR:function(e){return e[1]=e[1].replace(te,ne),e[3]=(e[3]||e[4]||e[5]||"").replace(te,ne),"~="===e[2]&&(e[3]=" "+e[3]+" "),e.slice(0,4)},CHILD:function(e){return e[1]=e[1].toLowerCase(),"nth"===e[1].slice(0,3)?(e[3]||se.error(e[0]),e[4]=+(e[4]?e[5]+(e[6]||1):2*("even"===e[3]||"odd"===e[3])),e[5]=+(e[7]+e[8]||"odd"===e[3])):e[3]&&se.error(e[0]),e},PSEUDO:function(e){var t,n=!e[6]&&e[2];return G.CHILD.test(e[0])?null:(e[3]?e[2]=e[4]||e[5]||"":n&&X.test(n)&&(t=h(n,!0))&&(t=n.indexOf(")",n.length-t)-n.length)&&(e[0]=e[0].slice(0,t),e[2]=n.slice(0,t)),e.slice(0,3))}},filter:{TAG:function(e){var t=e.replace(te,ne).toLowerCase();return"*"===e?function(){return!0}:function(e){return e.nodeName&&e.nodeName.toLowerCase()===t}},CLASS:function(e){var t=m[e+" "];return t||(t=new RegExp("(^|"+M+")"+e+"("+M+"|$)"))&&m(e,function(e){return t.test("string"==typeof e.className&&e.className||"undefined"!=typeof e.getAttribute&&e.getAttribute("class")||"")})},ATTR:function(n,r,i){return function(e){var t=se.attr(e,n);return null==t?"!="===r:!r||(t+="","="===r?t===i:"!="===r?t!==i:"^="===r?i&&0===t.indexOf(i):"*="===r?i&&-1:\x20\t\r\n\f]*)[\x20\t\r\n\f]*\/?>(?:<\/\1>|)$/i;function j(e,n,r){return m(n)?S.grep(e,function(e,t){return!!n.call(e,t,e)!==r}):n.nodeType?S.grep(e,function(e){return e===n!==r}):"string"!=typeof n?S.grep(e,function(e){return-1)[^>]*|#([\w-]+))$/;(S.fn.init=function(e,t,n){var r,i;if(!e)return this;if(n=n||D,"string"==typeof e){if(!(r="<"===e[0]&&">"===e[e.length-1]&&3<=e.length?[null,e,null]:q.exec(e))||!r[1]&&t)return!t||t.jquery?(t||n).find(e):this.constructor(t).find(e);if(r[1]){if(t=t instanceof S?t[0]:t,S.merge(this,S.parseHTML(r[1],t&&t.nodeType?t.ownerDocument||t:E,!0)),N.test(r[1])&&S.isPlainObject(t))for(r in t)m(this[r])?this[r](t[r]):this.attr(r,t[r]);return this}return(i=E.getElementById(r[2]))&&(this[0]=i,this.length=1),this}return e.nodeType?(this[0]=e,this.length=1,this):m(e)?void 0!==n.ready?n.ready(e):e(S):S.makeArray(e,this)}).prototype=S.fn,D=S(E);var L=/^(?:parents|prev(?:Until|All))/,H={children:!0,contents:!0,next:!0,prev:!0};function O(e,t){while((e=e[t])&&1!==e.nodeType);return e}S.fn.extend({has:function(e){var t=S(e,this),n=t.length;return this.filter(function(){for(var e=0;e\x20\t\r\n\f]*)/i,he=/^$|^module$|\/(?:java|ecma)script/i;ce=E.createDocumentFragment().appendChild(E.createElement("div")),(fe=E.createElement("input")).setAttribute("type","radio"),fe.setAttribute("checked","checked"),fe.setAttribute("name","t"),ce.appendChild(fe),y.checkClone=ce.cloneNode(!0).cloneNode(!0).lastChild.checked,ce.innerHTML="",y.noCloneChecked=!!ce.cloneNode(!0).lastChild.defaultValue,ce.innerHTML="",y.option=!!ce.lastChild;var ge={thead:[1,"","
"],col:[2,"","
"],tr:[2,"","
"],td:[3,"","
"],_default:[0,"",""]};function ve(e,t){var n;return n="undefined"!=typeof e.getElementsByTagName?e.getElementsByTagName(t||"*"):"undefined"!=typeof e.querySelectorAll?e.querySelectorAll(t||"*"):[],void 0===t||t&&A(e,t)?S.merge([e],n):n}function ye(e,t){for(var n=0,r=e.length;n",""]);var me=/<|&#?\w+;/;function xe(e,t,n,r,i){for(var o,a,s,u,l,c,f=t.createDocumentFragment(),p=[],d=0,h=e.length;d\s*$/g;function je(e,t){return A(e,"table")&&A(11!==t.nodeType?t:t.firstChild,"tr")&&S(e).children("tbody")[0]||e}function De(e){return e.type=(null!==e.getAttribute("type"))+"/"+e.type,e}function qe(e){return"true/"===(e.type||"").slice(0,5)?e.type=e.type.slice(5):e.removeAttribute("type"),e}function Le(e,t){var n,r,i,o,a,s;if(1===t.nodeType){if(Y.hasData(e)&&(s=Y.get(e).events))for(i in Y.remove(t,"handle events"),s)for(n=0,r=s[i].length;n").attr(n.scriptAttrs||{}).prop({charset:n.scriptCharset,src:n.url}).on("load error",i=function(e){r.remove(),i=null,e&&t("error"===e.type?404:200,e.type)}),E.head.appendChild(r[0])},abort:function(){i&&i()}}});var _t,zt=[],Ut=/(=)\?(?=&|$)|\?\?/;S.ajaxSetup({jsonp:"callback",jsonpCallback:function(){var e=zt.pop()||S.expando+"_"+wt.guid++;return this[e]=!0,e}}),S.ajaxPrefilter("json jsonp",function(e,t,n){var r,i,o,a=!1!==e.jsonp&&(Ut.test(e.url)?"url":"string"==typeof e.data&&0===(e.contentType||"").indexOf("application/x-www-form-urlencoded")&&Ut.test(e.data)&&"data");if(a||"jsonp"===e.dataTypes[0])return r=e.jsonpCallback=m(e.jsonpCallback)?e.jsonpCallback():e.jsonpCallback,a?e[a]=e[a].replace(Ut,"$1"+r):!1!==e.jsonp&&(e.url+=(Tt.test(e.url)?"&":"?")+e.jsonp+"="+r),e.converters["script json"]=function(){return o||S.error(r+" was not called"),o[0]},e.dataTypes[0]="json",i=C[r],C[r]=function(){o=arguments},n.always(function(){void 0===i?S(C).removeProp(r):C[r]=i,e[r]&&(e.jsonpCallback=t.jsonpCallback,zt.push(r)),o&&m(i)&&i(o[0]),o=i=void 0}),"script"}),y.createHTMLDocument=((_t=E.implementation.createHTMLDocument("").body).innerHTML="
",2===_t.childNodes.length),S.parseHTML=function(e,t,n){return"string"!=typeof e?[]:("boolean"==typeof t&&(n=t,t=!1),t||(y.createHTMLDocument?((r=(t=E.implementation.createHTMLDocument("")).createElement("base")).href=E.location.href,t.head.appendChild(r)):t=E),o=!n&&[],(i=N.exec(e))?[t.createElement(i[1])]:(i=xe([e],t,o),o&&o.length&&S(o).remove(),S.merge([],i.childNodes)));var r,i,o},S.fn.load=function(e,t,n){var r,i,o,a=this,s=e.indexOf(" ");return-1").append(S.parseHTML(e)).find(r):e)}).always(n&&function(e,t){a.each(function(){n.apply(this,o||[e.responseText,t,e])})}),this},S.expr.pseudos.animated=function(t){return S.grep(S.timers,function(e){return t===e.elem}).length},S.offset={setOffset:function(e,t,n){var r,i,o,a,s,u,l=S.css(e,"position"),c=S(e),f={};"static"===l&&(e.style.position="relative"),s=c.offset(),o=S.css(e,"top"),u=S.css(e,"left"),("absolute"===l||"fixed"===l)&&-1<(o+u).indexOf("auto")?(a=(r=c.position()).top,i=r.left):(a=parseFloat(o)||0,i=parseFloat(u)||0),m(t)&&(t=t.call(e,n,S.extend({},s))),null!=t.top&&(f.top=t.top-s.top+a),null!=t.left&&(f.left=t.left-s.left+i),"using"in t?t.using.call(e,f):c.css(f)}},S.fn.extend({offset:function(t){if(arguments.length)return void 0===t?this:this.each(function(e){S.offset.setOffset(this,t,e)});var e,n,r=this[0];return r?r.getClientRects().length?(e=r.getBoundingClientRect(),n=r.ownerDocument.defaultView,{top:e.top+n.pageYOffset,left:e.left+n.pageXOffset}):{top:0,left:0}:void 0},position:function(){if(this[0]){var e,t,n,r=this[0],i={top:0,left:0};if("fixed"===S.css(r,"position"))t=r.getBoundingClientRect();else{t=this.offset(),n=r.ownerDocument,e=r.offsetParent||n.documentElement;while(e&&(e===n.body||e===n.documentElement)&&"static"===S.css(e,"position"))e=e.parentNode;e&&e!==r&&1===e.nodeType&&((i=S(e).offset()).top+=S.css(e,"borderTopWidth",!0),i.left+=S.css(e,"borderLeftWidth",!0))}return{top:t.top-i.top-S.css(r,"marginTop",!0),left:t.left-i.left-S.css(r,"marginLeft",!0)}}},offsetParent:function(){return this.map(function(){var e=this.offsetParent;while(e&&"static"===S.css(e,"position"))e=e.offsetParent;return e||re})}}),S.each({scrollLeft:"pageXOffset",scrollTop:"pageYOffset"},function(t,i){var o="pageYOffset"===i;S.fn[t]=function(e){return $(this,function(e,t,n){var r;if(x(e)?r=e:9===e.nodeType&&(r=e.defaultView),void 0===n)return r?r[i]:e[t];r?r.scrollTo(o?r.pageXOffset:n,o?n:r.pageYOffset):e[t]=n},t,e,arguments.length)}}),S.each(["top","left"],function(e,n){S.cssHooks[n]=Fe(y.pixelPosition,function(e,t){if(t)return t=We(e,n),Pe.test(t)?S(e).position()[n]+"px":t})}),S.each({Height:"height",Width:"width"},function(a,s){S.each({padding:"inner"+a,content:s,"":"outer"+a},function(r,o){S.fn[o]=function(e,t){var n=arguments.length&&(r||"boolean"!=typeof e),i=r||(!0===e||!0===t?"margin":"border");return $(this,function(e,t,n){var r;return x(e)?0===o.indexOf("outer")?e["inner"+a]:e.document.documentElement["client"+a]:9===e.nodeType?(r=e.documentElement,Math.max(e.body["scroll"+a],r["scroll"+a],e.body["offset"+a],r["offset"+a],r["client"+a])):void 0===n?S.css(e,t,i):S.style(e,t,n,i)},s,n?e:void 0,n)}})}),S.each(["ajaxStart","ajaxStop","ajaxComplete","ajaxError","ajaxSuccess","ajaxSend"],function(e,t){S.fn[t]=function(e){return this.on(t,e)}}),S.fn.extend({bind:function(e,t,n){return this.on(e,null,t,n)},unbind:function(e,t){return this.off(e,null,t)},delegate:function(e,t,n,r){return this.on(t,e,n,r)},undelegate:function(e,t,n){return 1===arguments.length?this.off(e,"**"):this.off(t,e||"**",n)},hover:function(e,t){return this.mouseenter(e).mouseleave(t||e)}}),S.each("blur focus focusin focusout resize scroll click dblclick mousedown mouseup mousemove mouseover mouseout mouseenter mouseleave change select submit keydown keypress keyup contextmenu".split(" "),function(e,n){S.fn[n]=function(e,t){return 0",d.insertBefore(c.lastChild,d.firstChild)}function d(){var a=y.elements;return"string"==typeof a?a.split(" "):a}function e(a,b){var c=y.elements;"string"!=typeof c&&(c=c.join(" ")),"string"!=typeof a&&(a=a.join(" ")),y.elements=c+" "+a,j(b)}function f(a){var b=x[a[v]];return b||(b={},w++,a[v]=w,x[w]=b),b}function g(a,c,d){if(c||(c=b),q)return c.createElement(a);d||(d=f(c));var e;return e=d.cache[a]?d.cache[a].cloneNode():u.test(a)?(d.cache[a]=d.createElem(a)).cloneNode():d.createElem(a),!e.canHaveChildren||t.test(a)||e.tagUrn?e:d.frag.appendChild(e)}function h(a,c){if(a||(a=b),q)return a.createDocumentFragment();c=c||f(a);for(var e=c.frag.cloneNode(),g=0,h=d(),i=h.length;i>g;g++)e.createElement(h[g]);return e}function i(a,b){b.cache||(b.cache={},b.createElem=a.createElement,b.createFrag=a.createDocumentFragment,b.frag=b.createFrag()),a.createElement=function(c){return y.shivMethods?g(c,a,b):b.createElem(c)},a.createDocumentFragment=Function("h,f","return function(){var n=f.cloneNode(),c=n.createElement;h.shivMethods&&("+d().join().replace(/[\w\-:]+/g,function(a){return b.createElem(a),b.frag.createElement(a),'c("'+a+'")'})+");return n}")(y,b.frag)}function j(a){a||(a=b);var d=f(a);return!y.shivCSS||p||d.hasCSS||(d.hasCSS=!!c(a,"article,aside,dialog,figcaption,figure,footer,header,hgroup,main,nav,section{display:block}mark{background:#FF0;color:#000}template{display:none}")),q||i(a,d),a}function k(a){for(var b,c=a.getElementsByTagName("*"),e=c.length,f=RegExp("^(?:"+d().join("|")+")$","i"),g=[];e--;)b=c[e],f.test(b.nodeName)&&g.push(b.applyElement(l(b)));return g}function l(a){for(var b,c=a.attributes,d=c.length,e=a.ownerDocument.createElement(A+":"+a.nodeName);d--;)b=c[d],b.specified&&e.setAttribute(b.nodeName,b.nodeValue);return e.style.cssText=a.style.cssText,e}function m(a){for(var b,c=a.split("{"),e=c.length,f=RegExp("(^|[\\s,>+~])("+d().join("|")+")(?=[[\\s,>+~#.:]|$)","gi"),g="$1"+A+"\\:$2";e--;)b=c[e]=c[e].split("}"),b[b.length-1]=b[b.length-1].replace(f,g),c[e]=b.join("}");return c.join("{")}function n(a){for(var b=a.length;b--;)a[b].removeNode()}function o(a){function b(){clearTimeout(g._removeSheetTimer),d&&d.removeNode(!0),d=null}var d,e,g=f(a),h=a.namespaces,i=a.parentWindow;return!B||a.printShived?a:("undefined"==typeof h[A]&&h.add(A),i.attachEvent("onbeforeprint",function(){b();for(var f,g,h,i=a.styleSheets,j=[],l=i.length,n=Array(l);l--;)n[l]=i[l];for(;h=n.pop();)if(!h.disabled&&z.test(h.media)){try{f=h.imports,g=f.length}catch(o){g=0}for(l=0;g>l;l++)n.push(f[l]);try{j.push(h.cssText)}catch(o){}}j=m(j.reverse().join("")),e=k(a),d=c(a,j)}),i.attachEvent("onafterprint",function(){n(e),clearTimeout(g._removeSheetTimer),g._removeSheetTimer=setTimeout(b,500)}),a.printShived=!0,a)}var p,q,r="3.7.3",s=a.html5||{},t=/^<|^(?:button|map|select|textarea|object|iframe|option|optgroup)$/i,u=/^(?:a|b|code|div|fieldset|h1|h2|h3|h4|h5|h6|i|label|li|ol|p|q|span|strong|style|table|tbody|td|th|tr|ul)$/i,v="_html5shiv",w=0,x={};!function(){try{var a=b.createElement("a");a.innerHTML="",p="hidden"in a,q=1==a.childNodes.length||function(){b.createElement("a");var a=b.createDocumentFragment();return"undefined"==typeof a.cloneNode||"undefined"==typeof a.createDocumentFragment||"undefined"==typeof a.createElement}()}catch(c){p=!0,q=!0}}();var y={elements:s.elements||"abbr article aside audio bdi canvas data datalist details dialog figcaption figure footer header hgroup main mark meter nav output picture progress section summary template time video",version:r,shivCSS:s.shivCSS!==!1,supportsUnknownElements:q,shivMethods:s.shivMethods!==!1,type:"default",shivDocument:j,createElement:g,createDocumentFragment:h,addElements:e};a.html5=y,j(b);var z=/^$|\b(?:all|print)\b/,A="html5shiv",B=!q&&function(){var c=b.documentElement;return!("undefined"==typeof b.namespaces||"undefined"==typeof b.parentWindow||"undefined"==typeof c.applyElement||"undefined"==typeof c.removeNode||"undefined"==typeof a.attachEvent)}();y.type+=" print",y.shivPrint=o,o(b),"object"==typeof module&&module.exports&&(module.exports=y)}("undefined"!=typeof window?window:this,document); \ No newline at end of file diff --git a/docs/build/html/_static/js/html5shiv.min.js b/docs/build/html/_static/js/html5shiv.min.js deleted file mode 100644 index cd1c674..0000000 --- a/docs/build/html/_static/js/html5shiv.min.js +++ /dev/null @@ -1,4 +0,0 @@ -/** -* @preserve HTML5 Shiv 3.7.3 | @afarkas @jdalton @jon_neal @rem | MIT/GPL2 Licensed -*/ -!function(a,b){function c(a,b){var c=a.createElement("p"),d=a.getElementsByTagName("head")[0]||a.documentElement;return c.innerHTML="x",d.insertBefore(c.lastChild,d.firstChild)}function d(){var a=t.elements;return"string"==typeof a?a.split(" "):a}function e(a,b){var c=t.elements;"string"!=typeof c&&(c=c.join(" ")),"string"!=typeof a&&(a=a.join(" ")),t.elements=c+" "+a,j(b)}function f(a){var b=s[a[q]];return b||(b={},r++,a[q]=r,s[r]=b),b}function g(a,c,d){if(c||(c=b),l)return c.createElement(a);d||(d=f(c));var e;return e=d.cache[a]?d.cache[a].cloneNode():p.test(a)?(d.cache[a]=d.createElem(a)).cloneNode():d.createElem(a),!e.canHaveChildren||o.test(a)||e.tagUrn?e:d.frag.appendChild(e)}function h(a,c){if(a||(a=b),l)return a.createDocumentFragment();c=c||f(a);for(var e=c.frag.cloneNode(),g=0,h=d(),i=h.length;i>g;g++)e.createElement(h[g]);return e}function i(a,b){b.cache||(b.cache={},b.createElem=a.createElement,b.createFrag=a.createDocumentFragment,b.frag=b.createFrag()),a.createElement=function(c){return t.shivMethods?g(c,a,b):b.createElem(c)},a.createDocumentFragment=Function("h,f","return function(){var n=f.cloneNode(),c=n.createElement;h.shivMethods&&("+d().join().replace(/[\w\-:]+/g,function(a){return b.createElem(a),b.frag.createElement(a),'c("'+a+'")'})+");return n}")(t,b.frag)}function j(a){a||(a=b);var d=f(a);return!t.shivCSS||k||d.hasCSS||(d.hasCSS=!!c(a,"article,aside,dialog,figcaption,figure,footer,header,hgroup,main,nav,section{display:block}mark{background:#FF0;color:#000}template{display:none}")),l||i(a,d),a}var k,l,m="3.7.3-pre",n=a.html5||{},o=/^<|^(?:button|map|select|textarea|object|iframe|option|optgroup)$/i,p=/^(?:a|b|code|div|fieldset|h1|h2|h3|h4|h5|h6|i|label|li|ol|p|q|span|strong|style|table|tbody|td|th|tr|ul)$/i,q="_html5shiv",r=0,s={};!function(){try{var a=b.createElement("a");a.innerHTML="",k="hidden"in a,l=1==a.childNodes.length||function(){b.createElement("a");var a=b.createDocumentFragment();return"undefined"==typeof a.cloneNode||"undefined"==typeof a.createDocumentFragment||"undefined"==typeof a.createElement}()}catch(c){k=!0,l=!0}}();var t={elements:n.elements||"abbr article aside audio bdi canvas data datalist details dialog figcaption figure footer header hgroup main mark meter nav output picture progress section summary template time video",version:m,shivCSS:n.shivCSS!==!1,supportsUnknownElements:l,shivMethods:n.shivMethods!==!1,type:"default",shivDocument:j,createElement:g,createDocumentFragment:h,addElements:e};a.html5=t,j(b),"object"==typeof module&&module.exports&&(module.exports=t)}("undefined"!=typeof window?window:this,document); \ No newline at end of file diff --git a/docs/build/html/_static/js/theme.js b/docs/build/html/_static/js/theme.js deleted file mode 100644 index 1fddb6e..0000000 --- a/docs/build/html/_static/js/theme.js +++ /dev/null @@ -1 +0,0 @@ -!function(n){var e={};function t(i){if(e[i])return e[i].exports;var o=e[i]={i:i,l:!1,exports:{}};return n[i].call(o.exports,o,o.exports,t),o.l=!0,o.exports}t.m=n,t.c=e,t.d=function(n,e,i){t.o(n,e)||Object.defineProperty(n,e,{enumerable:!0,get:i})},t.r=function(n){"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(n,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(n,"__esModule",{value:!0})},t.t=function(n,e){if(1&e&&(n=t(n)),8&e)return n;if(4&e&&"object"==typeof n&&n&&n.__esModule)return n;var i=Object.create(null);if(t.r(i),Object.defineProperty(i,"default",{enumerable:!0,value:n}),2&e&&"string"!=typeof n)for(var o in n)t.d(i,o,function(e){return n[e]}.bind(null,o));return i},t.n=function(n){var e=n&&n.__esModule?function(){return n.default}:function(){return n};return t.d(e,"a",e),e},t.o=function(n,e){return Object.prototype.hasOwnProperty.call(n,e)},t.p="",t(t.s=0)}([function(n,e,t){t(1),n.exports=t(3)},function(n,e,t){(function(){var e="undefined"!=typeof window?window.jQuery:t(2);n.exports.ThemeNav={navBar:null,win:null,winScroll:!1,winResize:!1,linkScroll:!1,winPosition:0,winHeight:null,docHeight:null,isRunning:!1,enable:function(n){var t=this;void 0===n&&(n=!0),t.isRunning||(t.isRunning=!0,e((function(e){t.init(e),t.reset(),t.win.on("hashchange",t.reset),n&&t.win.on("scroll",(function(){t.linkScroll||t.winScroll||(t.winScroll=!0,requestAnimationFrame((function(){t.onScroll()})))})),t.win.on("resize",(function(){t.winResize||(t.winResize=!0,requestAnimationFrame((function(){t.onResize()})))})),t.onResize()})))},enableSticky:function(){this.enable(!0)},init:function(n){n(document);var e=this;this.navBar=n("div.wy-side-scroll:first"),this.win=n(window),n(document).on("click","[data-toggle='wy-nav-top']",(function(){n("[data-toggle='wy-nav-shift']").toggleClass("shift"),n("[data-toggle='rst-versions']").toggleClass("shift")})).on("click",".wy-menu-vertical .current ul li a",(function(){var t=n(this);n("[data-toggle='wy-nav-shift']").removeClass("shift"),n("[data-toggle='rst-versions']").toggleClass("shift"),e.toggleCurrent(t),e.hashChange()})).on("click","[data-toggle='rst-current-version']",(function(){n("[data-toggle='rst-versions']").toggleClass("shift-up")})),n("table.docutils:not(.field-list,.footnote,.citation)").wrap("
"),n("table.docutils.footnote").wrap("
"),n("table.docutils.citation").wrap("
"),n(".wy-menu-vertical ul").not(".simple").siblings("a").each((function(){var t=n(this);expand=n(''),expand.on("click",(function(n){return e.toggleCurrent(t),n.stopPropagation(),!1})),t.prepend(expand)}))},reset:function(){var n=encodeURI(window.location.hash)||"#";try{var e=$(".wy-menu-vertical"),t=e.find('[href="'+n+'"]');if(0===t.length){var i=$('.document [id="'+n.substring(1)+'"]').closest("div.section");0===(t=e.find('[href="#'+i.attr("id")+'"]')).length&&(t=e.find('[href="#"]'))}if(t.length>0){$(".wy-menu-vertical .current").removeClass("current").attr("aria-expanded","false"),t.addClass("current").attr("aria-expanded","true"),t.closest("li.toctree-l1").parent().addClass("current").attr("aria-expanded","true");for(let n=1;n<=10;n++)t.closest("li.toctree-l"+n).addClass("current").attr("aria-expanded","true");t[0].scrollIntoView()}}catch(n){console.log("Error expanding nav for anchor",n)}},onScroll:function(){this.winScroll=!1;var n=this.win.scrollTop(),e=n+this.winHeight,t=this.navBar.scrollTop()+(n-this.winPosition);n<0||e>this.docHeight||(this.navBar.scrollTop(t),this.winPosition=n)},onResize:function(){this.winResize=!1,this.winHeight=this.win.height(),this.docHeight=$(document).height()},hashChange:function(){this.linkScroll=!0,this.win.one("hashchange",(function(){this.linkScroll=!1}))},toggleCurrent:function(n){var e=n.closest("li");e.siblings("li.current").removeClass("current").attr("aria-expanded","false"),e.siblings().find("li.current").removeClass("current").attr("aria-expanded","false");var t=e.find("> ul li");t.length&&(t.removeClass("current").attr("aria-expanded","false"),e.toggleClass("current").attr("aria-expanded",(function(n,e){return"true"==e?"false":"true"})))}},"undefined"!=typeof window&&(window.SphinxRtdTheme={Navigation:n.exports.ThemeNav,StickyNav:n.exports.ThemeNav}),function(){for(var n=0,e=["ms","moz","webkit","o"],t=0;t0 - var meq1 = "^(" + C + ")?" + V + C + "(" + V + ")?$"; // [C]VC[V] is m=1 - var mgr1 = "^(" + C + ")?" + V + C + V + C; // [C]VCVC... is m>1 - var s_v = "^(" + C + ")?" + v; // vowel in stem - - this.stemWord = function (w) { - var stem; - var suffix; - var firstch; - var origword = w; - - if (w.length < 3) - return w; - - var re; - var re2; - var re3; - var re4; - - firstch = w.substr(0,1); - if (firstch == "y") - w = firstch.toUpperCase() + w.substr(1); - - // Step 1a - re = /^(.+?)(ss|i)es$/; - re2 = /^(.+?)([^s])s$/; - - if (re.test(w)) - w = w.replace(re,"$1$2"); - else if (re2.test(w)) - w = w.replace(re2,"$1$2"); - - // Step 1b - re = /^(.+?)eed$/; - re2 = /^(.+?)(ed|ing)$/; - if (re.test(w)) { - var fp = re.exec(w); - re = new RegExp(mgr0); - if (re.test(fp[1])) { - re = /.$/; - w = w.replace(re,""); - } - } - else if (re2.test(w)) { - var fp = re2.exec(w); - stem = fp[1]; - re2 = new RegExp(s_v); - if (re2.test(stem)) { - w = stem; - re2 = /(at|bl|iz)$/; - re3 = new RegExp("([^aeiouylsz])\\1$"); - re4 = new RegExp("^" + C + v + "[^aeiouwxy]$"); - if (re2.test(w)) - w = w + "e"; - else if (re3.test(w)) { - re = /.$/; - w = w.replace(re,""); - } - else if (re4.test(w)) - w = w + "e"; - } - } - - // Step 1c - re = /^(.+?)y$/; - if (re.test(w)) { - var fp = re.exec(w); - stem = fp[1]; - re = new RegExp(s_v); - if (re.test(stem)) - w = stem + "i"; - } - - // Step 2 - re = /^(.+?)(ational|tional|enci|anci|izer|bli|alli|entli|eli|ousli|ization|ation|ator|alism|iveness|fulness|ousness|aliti|iviti|biliti|logi)$/; - if (re.test(w)) { - var fp = re.exec(w); - stem = fp[1]; - suffix = fp[2]; - re = new RegExp(mgr0); - if (re.test(stem)) - w = stem + step2list[suffix]; - } - - // Step 3 - re = /^(.+?)(icate|ative|alize|iciti|ical|ful|ness)$/; - if (re.test(w)) { - var fp = re.exec(w); - stem = fp[1]; - suffix = fp[2]; - re = new RegExp(mgr0); - if (re.test(stem)) - w = stem + step3list[suffix]; - } - - // Step 4 - re = /^(.+?)(al|ance|ence|er|ic|able|ible|ant|ement|ment|ent|ou|ism|ate|iti|ous|ive|ize)$/; - re2 = /^(.+?)(s|t)(ion)$/; - if (re.test(w)) { - var fp = re.exec(w); - stem = fp[1]; - re = new RegExp(mgr1); - if (re.test(stem)) - w = stem; - } - else if (re2.test(w)) { - var fp = re2.exec(w); - stem = fp[1] + fp[2]; - re2 = new RegExp(mgr1); - if (re2.test(stem)) - w = stem; - } - - // Step 5 - re = /^(.+?)e$/; - if (re.test(w)) { - var fp = re.exec(w); - stem = fp[1]; - re = new RegExp(mgr1); - re2 = new RegExp(meq1); - re3 = new RegExp("^" + C + v + "[^aeiouwxy]$"); - if (re.test(stem) || (re2.test(stem) && !(re3.test(stem)))) - w = stem; - } - re = /ll$/; - re2 = new RegExp(mgr1); - if (re.test(w) && re2.test(w)) { - re = /.$/; - w = w.replace(re,""); - } - - // and turn initial Y back to y - if (firstch == "y") - w = firstch.toLowerCase() + w.substr(1); - return w; - } -} - diff --git a/docs/build/html/_static/minus.png b/docs/build/html/_static/minus.png deleted file mode 100644 index d96755f..0000000 Binary files a/docs/build/html/_static/minus.png and /dev/null differ diff --git a/docs/build/html/_static/plus.png b/docs/build/html/_static/plus.png deleted file mode 100644 index 7107cec..0000000 Binary files a/docs/build/html/_static/plus.png and /dev/null differ diff --git a/docs/build/html/_static/pygments.css b/docs/build/html/_static/pygments.css deleted file mode 100644 index 84ab303..0000000 --- a/docs/build/html/_static/pygments.css +++ /dev/null @@ -1,75 +0,0 @@ -pre { line-height: 125%; } -td.linenos .normal { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; } -span.linenos { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; } -td.linenos .special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; } -span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; } -.highlight .hll { background-color: #ffffcc } -.highlight { background: #f8f8f8; } -.highlight .c { color: #3D7B7B; font-style: italic } /* Comment */ -.highlight .err { border: 1px solid #FF0000 } /* Error */ -.highlight .k { color: #008000; font-weight: bold } /* Keyword */ -.highlight .o { color: #666666 } /* Operator */ -.highlight .ch { color: #3D7B7B; font-style: italic } /* Comment.Hashbang */ -.highlight .cm { color: #3D7B7B; font-style: italic } /* Comment.Multiline */ -.highlight .cp { color: #9C6500 } /* Comment.Preproc */ -.highlight .cpf { color: #3D7B7B; font-style: italic } /* Comment.PreprocFile */ -.highlight .c1 { color: #3D7B7B; font-style: italic } /* Comment.Single */ -.highlight .cs { color: #3D7B7B; font-style: italic } /* Comment.Special */ -.highlight .gd { color: #A00000 } /* Generic.Deleted */ -.highlight .ge { font-style: italic } /* Generic.Emph */ -.highlight .ges { font-weight: bold; font-style: italic } /* Generic.EmphStrong */ -.highlight .gr { color: #E40000 } /* Generic.Error */ -.highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */ -.highlight .gi { color: #008400 } /* Generic.Inserted */ -.highlight .go { color: #717171 } /* Generic.Output */ -.highlight .gp { color: #000080; font-weight: bold } /* Generic.Prompt */ -.highlight .gs { font-weight: bold } /* Generic.Strong */ -.highlight .gu { color: #800080; font-weight: bold } /* Generic.Subheading */ -.highlight .gt { color: #0044DD } /* Generic.Traceback */ -.highlight .kc { color: #008000; font-weight: bold } /* Keyword.Constant */ -.highlight .kd { color: #008000; font-weight: bold } /* Keyword.Declaration */ -.highlight .kn { color: #008000; font-weight: bold } /* Keyword.Namespace */ -.highlight .kp { color: #008000 } /* Keyword.Pseudo */ -.highlight .kr { color: #008000; font-weight: bold } /* Keyword.Reserved */ -.highlight .kt { color: #B00040 } /* Keyword.Type */ -.highlight .m { color: #666666 } /* Literal.Number */ -.highlight .s { color: #BA2121 } /* Literal.String */ -.highlight .na { color: #687822 } /* Name.Attribute */ -.highlight .nb { color: #008000 } /* Name.Builtin */ -.highlight .nc { color: #0000FF; font-weight: bold } /* Name.Class */ -.highlight .no { color: #880000 } /* Name.Constant */ -.highlight .nd { color: #AA22FF } /* Name.Decorator */ -.highlight .ni { color: #717171; font-weight: bold } /* Name.Entity */ -.highlight .ne { color: #CB3F38; font-weight: bold } /* Name.Exception */ -.highlight .nf { color: #0000FF } /* Name.Function */ -.highlight .nl { color: #767600 } /* Name.Label */ -.highlight .nn { color: #0000FF; font-weight: bold } /* Name.Namespace */ -.highlight .nt { color: #008000; font-weight: bold } /* Name.Tag */ -.highlight .nv { color: #19177C } /* Name.Variable */ -.highlight .ow { color: #AA22FF; font-weight: bold } /* Operator.Word */ -.highlight .w { color: #bbbbbb } /* Text.Whitespace */ -.highlight .mb { color: #666666 } /* Literal.Number.Bin */ -.highlight .mf { color: #666666 } /* Literal.Number.Float */ -.highlight .mh { color: #666666 } /* Literal.Number.Hex */ -.highlight .mi { color: #666666 } /* Literal.Number.Integer */ -.highlight .mo { color: #666666 } /* Literal.Number.Oct */ -.highlight .sa { color: #BA2121 } /* Literal.String.Affix */ -.highlight .sb { color: #BA2121 } /* Literal.String.Backtick */ -.highlight .sc { color: #BA2121 } /* Literal.String.Char */ -.highlight .dl { color: #BA2121 } /* Literal.String.Delimiter */ -.highlight .sd { color: #BA2121; font-style: italic } /* Literal.String.Doc */ -.highlight .s2 { color: #BA2121 } /* Literal.String.Double */ -.highlight .se { color: #AA5D1F; font-weight: bold } /* Literal.String.Escape */ -.highlight .sh { color: #BA2121 } /* Literal.String.Heredoc */ -.highlight .si { color: #A45A77; font-weight: bold } /* Literal.String.Interpol */ -.highlight .sx { color: #008000 } /* Literal.String.Other */ -.highlight .sr { color: #A45A77 } /* Literal.String.Regex */ -.highlight .s1 { color: #BA2121 } /* Literal.String.Single */ -.highlight .ss { color: #19177C } /* Literal.String.Symbol */ -.highlight .bp { color: #008000 } /* Name.Builtin.Pseudo */ -.highlight .fm { color: #0000FF } /* Name.Function.Magic */ -.highlight .vc { color: #19177C } /* Name.Variable.Class */ -.highlight .vg { color: #19177C } /* Name.Variable.Global */ -.highlight .vi { color: #19177C } /* Name.Variable.Instance */ -.highlight .vm { color: #19177C } /* Name.Variable.Magic */ -.highlight .il { color: #666666 } /* Literal.Number.Integer.Long */ \ No newline at end of file diff --git a/docs/build/html/_static/searchtools.js b/docs/build/html/_static/searchtools.js deleted file mode 100644 index b08d58c..0000000 --- a/docs/build/html/_static/searchtools.js +++ /dev/null @@ -1,620 +0,0 @@ -/* - * searchtools.js - * ~~~~~~~~~~~~~~~~ - * - * Sphinx JavaScript utilities for the full-text search. - * - * :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS. - * :license: BSD, see LICENSE for details. - * - */ -"use strict"; - -/** - * Simple result scoring code. - */ -if (typeof Scorer === "undefined") { - var Scorer = { - // Implement the following function to further tweak the score for each result - // The function takes a result array [docname, title, anchor, descr, score, filename] - // and returns the new score. - /* - score: result => { - const [docname, title, anchor, descr, score, filename] = result - return score - }, - */ - - // query matches the full name of an object - objNameMatch: 11, - // or matches in the last dotted part of the object name - objPartialMatch: 6, - // Additive scores depending on the priority of the object - objPrio: { - 0: 15, // used to be importantResults - 1: 5, // used to be objectResults - 2: -5, // used to be unimportantResults - }, - // Used when the priority is not in the mapping. - objPrioDefault: 0, - - // query found in title - title: 15, - partialTitle: 7, - // query found in terms - term: 5, - partialTerm: 2, - }; -} - -const _removeChildren = (element) => { - while (element && element.lastChild) element.removeChild(element.lastChild); -}; - -/** - * See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions#escaping - */ -const _escapeRegExp = (string) => - string.replace(/[.*+\-?^${}()|[\]\\]/g, "\\$&"); // $& means the whole matched string - -const _displayItem = (item, searchTerms, highlightTerms) => { - const docBuilder = DOCUMENTATION_OPTIONS.BUILDER; - const docFileSuffix = DOCUMENTATION_OPTIONS.FILE_SUFFIX; - const docLinkSuffix = DOCUMENTATION_OPTIONS.LINK_SUFFIX; - const showSearchSummary = DOCUMENTATION_OPTIONS.SHOW_SEARCH_SUMMARY; - const contentRoot = document.documentElement.dataset.content_root; - - const [docName, title, anchor, descr, score, _filename] = item; - - let listItem = document.createElement("li"); - let requestUrl; - let linkUrl; - if (docBuilder === "dirhtml") { - // dirhtml builder - let dirname = docName + "/"; - if (dirname.match(/\/index\/$/)) - dirname = dirname.substring(0, dirname.length - 6); - else if (dirname === "index/") dirname = ""; - requestUrl = contentRoot + dirname; - linkUrl = requestUrl; - } else { - // normal html builders - requestUrl = contentRoot + docName + docFileSuffix; - linkUrl = docName + docLinkSuffix; - } - let linkEl = listItem.appendChild(document.createElement("a")); - linkEl.href = linkUrl + anchor; - linkEl.dataset.score = score; - linkEl.innerHTML = title; - if (descr) { - listItem.appendChild(document.createElement("span")).innerHTML = - " (" + descr + ")"; - // highlight search terms in the description - if (SPHINX_HIGHLIGHT_ENABLED) // set in sphinx_highlight.js - highlightTerms.forEach((term) => _highlightText(listItem, term, "highlighted")); - } - else if (showSearchSummary) - fetch(requestUrl) - .then((responseData) => responseData.text()) - .then((data) => { - if (data) - listItem.appendChild( - Search.makeSearchSummary(data, searchTerms, anchor) - ); - // highlight search terms in the summary - if (SPHINX_HIGHLIGHT_ENABLED) // set in sphinx_highlight.js - highlightTerms.forEach((term) => _highlightText(listItem, term, "highlighted")); - }); - Search.output.appendChild(listItem); -}; -const _finishSearch = (resultCount) => { - Search.stopPulse(); - Search.title.innerText = _("Search Results"); - if (!resultCount) - Search.status.innerText = Documentation.gettext( - "Your search did not match any documents. Please make sure that all words are spelled correctly and that you've selected enough categories." - ); - else - Search.status.innerText = _( - "Search finished, found ${resultCount} page(s) matching the search query." - ).replace('${resultCount}', resultCount); -}; -const _displayNextItem = ( - results, - resultCount, - searchTerms, - highlightTerms, -) => { - // results left, load the summary and display it - // this is intended to be dynamic (don't sub resultsCount) - if (results.length) { - _displayItem(results.pop(), searchTerms, highlightTerms); - setTimeout( - () => _displayNextItem(results, resultCount, searchTerms, highlightTerms), - 5 - ); - } - // search finished, update title and status message - else _finishSearch(resultCount); -}; -// Helper function used by query() to order search results. -// Each input is an array of [docname, title, anchor, descr, score, filename]. -// Order the results by score (in opposite order of appearance, since the -// `_displayNextItem` function uses pop() to retrieve items) and then alphabetically. -const _orderResultsByScoreThenName = (a, b) => { - const leftScore = a[4]; - const rightScore = b[4]; - if (leftScore === rightScore) { - // same score: sort alphabetically - const leftTitle = a[1].toLowerCase(); - const rightTitle = b[1].toLowerCase(); - if (leftTitle === rightTitle) return 0; - return leftTitle > rightTitle ? -1 : 1; // inverted is intentional - } - return leftScore > rightScore ? 1 : -1; -}; - -/** - * Default splitQuery function. Can be overridden in ``sphinx.search`` with a - * custom function per language. - * - * The regular expression works by splitting the string on consecutive characters - * that are not Unicode letters, numbers, underscores, or emoji characters. - * This is the same as ``\W+`` in Python, preserving the surrogate pair area. - */ -if (typeof splitQuery === "undefined") { - var splitQuery = (query) => query - .split(/[^\p{Letter}\p{Number}_\p{Emoji_Presentation}]+/gu) - .filter(term => term) // remove remaining empty strings -} - -/** - * Search Module - */ -const Search = { - _index: null, - _queued_query: null, - _pulse_status: -1, - - htmlToText: (htmlString, anchor) => { - const htmlElement = new DOMParser().parseFromString(htmlString, 'text/html'); - for (const removalQuery of [".headerlink", "script", "style"]) { - htmlElement.querySelectorAll(removalQuery).forEach((el) => { el.remove() }); - } - if (anchor) { - const anchorContent = htmlElement.querySelector(`[role="main"] ${anchor}`); - if (anchorContent) return anchorContent.textContent; - - console.warn( - `Anchored content block not found. Sphinx search tries to obtain it via DOM query '[role=main] ${anchor}'. Check your theme or template.` - ); - } - - // if anchor not specified or not found, fall back to main content - const docContent = htmlElement.querySelector('[role="main"]'); - if (docContent) return docContent.textContent; - - console.warn( - "Content block not found. Sphinx search tries to obtain it via DOM query '[role=main]'. Check your theme or template." - ); - return ""; - }, - - init: () => { - const query = new URLSearchParams(window.location.search).get("q"); - document - .querySelectorAll('input[name="q"]') - .forEach((el) => (el.value = query)); - if (query) Search.performSearch(query); - }, - - loadIndex: (url) => - (document.body.appendChild(document.createElement("script")).src = url), - - setIndex: (index) => { - Search._index = index; - if (Search._queued_query !== null) { - const query = Search._queued_query; - Search._queued_query = null; - Search.query(query); - } - }, - - hasIndex: () => Search._index !== null, - - deferQuery: (query) => (Search._queued_query = query), - - stopPulse: () => (Search._pulse_status = -1), - - startPulse: () => { - if (Search._pulse_status >= 0) return; - - const pulse = () => { - Search._pulse_status = (Search._pulse_status + 1) % 4; - Search.dots.innerText = ".".repeat(Search._pulse_status); - if (Search._pulse_status >= 0) window.setTimeout(pulse, 500); - }; - pulse(); - }, - - /** - * perform a search for something (or wait until index is loaded) - */ - performSearch: (query) => { - // create the required interface elements - const searchText = document.createElement("h2"); - searchText.textContent = _("Searching"); - const searchSummary = document.createElement("p"); - searchSummary.classList.add("search-summary"); - searchSummary.innerText = ""; - const searchList = document.createElement("ul"); - searchList.classList.add("search"); - - const out = document.getElementById("search-results"); - Search.title = out.appendChild(searchText); - Search.dots = Search.title.appendChild(document.createElement("span")); - Search.status = out.appendChild(searchSummary); - Search.output = out.appendChild(searchList); - - const searchProgress = document.getElementById("search-progress"); - // Some themes don't use the search progress node - if (searchProgress) { - searchProgress.innerText = _("Preparing search..."); - } - Search.startPulse(); - - // index already loaded, the browser was quick! - if (Search.hasIndex()) Search.query(query); - else Search.deferQuery(query); - }, - - _parseQuery: (query) => { - // stem the search terms and add them to the correct list - const stemmer = new Stemmer(); - const searchTerms = new Set(); - const excludedTerms = new Set(); - const highlightTerms = new Set(); - const objectTerms = new Set(splitQuery(query.toLowerCase().trim())); - splitQuery(query.trim()).forEach((queryTerm) => { - const queryTermLower = queryTerm.toLowerCase(); - - // maybe skip this "word" - // stopwords array is from language_data.js - if ( - stopwords.indexOf(queryTermLower) !== -1 || - queryTerm.match(/^\d+$/) - ) - return; - - // stem the word - let word = stemmer.stemWord(queryTermLower); - // select the correct list - if (word[0] === "-") excludedTerms.add(word.substr(1)); - else { - searchTerms.add(word); - highlightTerms.add(queryTermLower); - } - }); - - if (SPHINX_HIGHLIGHT_ENABLED) { // set in sphinx_highlight.js - localStorage.setItem("sphinx_highlight_terms", [...highlightTerms].join(" ")) - } - - // console.debug("SEARCH: searching for:"); - // console.info("required: ", [...searchTerms]); - // console.info("excluded: ", [...excludedTerms]); - - return [query, searchTerms, excludedTerms, highlightTerms, objectTerms]; - }, - - /** - * execute search (requires search index to be loaded) - */ - _performSearch: (query, searchTerms, excludedTerms, highlightTerms, objectTerms) => { - const filenames = Search._index.filenames; - const docNames = Search._index.docnames; - const titles = Search._index.titles; - const allTitles = Search._index.alltitles; - const indexEntries = Search._index.indexentries; - - // Collect multiple result groups to be sorted separately and then ordered. - // Each is an array of [docname, title, anchor, descr, score, filename]. - const normalResults = []; - const nonMainIndexResults = []; - - _removeChildren(document.getElementById("search-progress")); - - const queryLower = query.toLowerCase().trim(); - for (const [title, foundTitles] of Object.entries(allTitles)) { - if (title.toLowerCase().trim().includes(queryLower) && (queryLower.length >= title.length/2)) { - for (const [file, id] of foundTitles) { - const score = Math.round(Scorer.title * queryLower.length / title.length); - const boost = titles[file] === title ? 1 : 0; // add a boost for document titles - normalResults.push([ - docNames[file], - titles[file] !== title ? `${titles[file]} > ${title}` : title, - id !== null ? "#" + id : "", - null, - score + boost, - filenames[file], - ]); - } - } - } - - // search for explicit entries in index directives - for (const [entry, foundEntries] of Object.entries(indexEntries)) { - if (entry.includes(queryLower) && (queryLower.length >= entry.length/2)) { - for (const [file, id, isMain] of foundEntries) { - const score = Math.round(100 * queryLower.length / entry.length); - const result = [ - docNames[file], - titles[file], - id ? "#" + id : "", - null, - score, - filenames[file], - ]; - if (isMain) { - normalResults.push(result); - } else { - nonMainIndexResults.push(result); - } - } - } - } - - // lookup as object - objectTerms.forEach((term) => - normalResults.push(...Search.performObjectSearch(term, objectTerms)) - ); - - // lookup as search terms in fulltext - normalResults.push(...Search.performTermsSearch(searchTerms, excludedTerms)); - - // let the scorer override scores with a custom scoring function - if (Scorer.score) { - normalResults.forEach((item) => (item[4] = Scorer.score(item))); - nonMainIndexResults.forEach((item) => (item[4] = Scorer.score(item))); - } - - // Sort each group of results by score and then alphabetically by name. - normalResults.sort(_orderResultsByScoreThenName); - nonMainIndexResults.sort(_orderResultsByScoreThenName); - - // Combine the result groups in (reverse) order. - // Non-main index entries are typically arbitrary cross-references, - // so display them after other results. - let results = [...nonMainIndexResults, ...normalResults]; - - // remove duplicate search results - // note the reversing of results, so that in the case of duplicates, the highest-scoring entry is kept - let seen = new Set(); - results = results.reverse().reduce((acc, result) => { - let resultStr = result.slice(0, 4).concat([result[5]]).map(v => String(v)).join(','); - if (!seen.has(resultStr)) { - acc.push(result); - seen.add(resultStr); - } - return acc; - }, []); - - return results.reverse(); - }, - - query: (query) => { - const [searchQuery, searchTerms, excludedTerms, highlightTerms, objectTerms] = Search._parseQuery(query); - const results = Search._performSearch(searchQuery, searchTerms, excludedTerms, highlightTerms, objectTerms); - - // for debugging - //Search.lastresults = results.slice(); // a copy - // console.info("search results:", Search.lastresults); - - // print the results - _displayNextItem(results, results.length, searchTerms, highlightTerms); - }, - - /** - * search for object names - */ - performObjectSearch: (object, objectTerms) => { - const filenames = Search._index.filenames; - const docNames = Search._index.docnames; - const objects = Search._index.objects; - const objNames = Search._index.objnames; - const titles = Search._index.titles; - - const results = []; - - const objectSearchCallback = (prefix, match) => { - const name = match[4] - const fullname = (prefix ? prefix + "." : "") + name; - const fullnameLower = fullname.toLowerCase(); - if (fullnameLower.indexOf(object) < 0) return; - - let score = 0; - const parts = fullnameLower.split("."); - - // check for different match types: exact matches of full name or - // "last name" (i.e. last dotted part) - if (fullnameLower === object || parts.slice(-1)[0] === object) - score += Scorer.objNameMatch; - else if (parts.slice(-1)[0].indexOf(object) > -1) - score += Scorer.objPartialMatch; // matches in last name - - const objName = objNames[match[1]][2]; - const title = titles[match[0]]; - - // If more than one term searched for, we require other words to be - // found in the name/title/description - const otherTerms = new Set(objectTerms); - otherTerms.delete(object); - if (otherTerms.size > 0) { - const haystack = `${prefix} ${name} ${objName} ${title}`.toLowerCase(); - if ( - [...otherTerms].some((otherTerm) => haystack.indexOf(otherTerm) < 0) - ) - return; - } - - let anchor = match[3]; - if (anchor === "") anchor = fullname; - else if (anchor === "-") anchor = objNames[match[1]][1] + "-" + fullname; - - const descr = objName + _(", in ") + title; - - // add custom score for some objects according to scorer - if (Scorer.objPrio.hasOwnProperty(match[2])) - score += Scorer.objPrio[match[2]]; - else score += Scorer.objPrioDefault; - - results.push([ - docNames[match[0]], - fullname, - "#" + anchor, - descr, - score, - filenames[match[0]], - ]); - }; - Object.keys(objects).forEach((prefix) => - objects[prefix].forEach((array) => - objectSearchCallback(prefix, array) - ) - ); - return results; - }, - - /** - * search for full-text terms in the index - */ - performTermsSearch: (searchTerms, excludedTerms) => { - // prepare search - const terms = Search._index.terms; - const titleTerms = Search._index.titleterms; - const filenames = Search._index.filenames; - const docNames = Search._index.docnames; - const titles = Search._index.titles; - - const scoreMap = new Map(); - const fileMap = new Map(); - - // perform the search on the required terms - searchTerms.forEach((word) => { - const files = []; - const arr = [ - { files: terms[word], score: Scorer.term }, - { files: titleTerms[word], score: Scorer.title }, - ]; - // add support for partial matches - if (word.length > 2) { - const escapedWord = _escapeRegExp(word); - if (!terms.hasOwnProperty(word)) { - Object.keys(terms).forEach((term) => { - if (term.match(escapedWord)) - arr.push({ files: terms[term], score: Scorer.partialTerm }); - }); - } - if (!titleTerms.hasOwnProperty(word)) { - Object.keys(titleTerms).forEach((term) => { - if (term.match(escapedWord)) - arr.push({ files: titleTerms[term], score: Scorer.partialTitle }); - }); - } - } - - // no match but word was a required one - if (arr.every((record) => record.files === undefined)) return; - - // found search word in contents - arr.forEach((record) => { - if (record.files === undefined) return; - - let recordFiles = record.files; - if (recordFiles.length === undefined) recordFiles = [recordFiles]; - files.push(...recordFiles); - - // set score for the word in each file - recordFiles.forEach((file) => { - if (!scoreMap.has(file)) scoreMap.set(file, {}); - scoreMap.get(file)[word] = record.score; - }); - }); - - // create the mapping - files.forEach((file) => { - if (!fileMap.has(file)) fileMap.set(file, [word]); - else if (fileMap.get(file).indexOf(word) === -1) fileMap.get(file).push(word); - }); - }); - - // now check if the files don't contain excluded terms - const results = []; - for (const [file, wordList] of fileMap) { - // check if all requirements are matched - - // as search terms with length < 3 are discarded - const filteredTermCount = [...searchTerms].filter( - (term) => term.length > 2 - ).length; - if ( - wordList.length !== searchTerms.size && - wordList.length !== filteredTermCount - ) - continue; - - // ensure that none of the excluded terms is in the search result - if ( - [...excludedTerms].some( - (term) => - terms[term] === file || - titleTerms[term] === file || - (terms[term] || []).includes(file) || - (titleTerms[term] || []).includes(file) - ) - ) - break; - - // select one (max) score for the file. - const score = Math.max(...wordList.map((w) => scoreMap.get(file)[w])); - // add result to the result list - results.push([ - docNames[file], - titles[file], - "", - null, - score, - filenames[file], - ]); - } - return results; - }, - - /** - * helper function to return a node containing the - * search summary for a given text. keywords is a list - * of stemmed words. - */ - makeSearchSummary: (htmlText, keywords, anchor) => { - const text = Search.htmlToText(htmlText, anchor); - if (text === "") return null; - - const textLower = text.toLowerCase(); - const actualStartPosition = [...keywords] - .map((k) => textLower.indexOf(k.toLowerCase())) - .filter((i) => i > -1) - .slice(-1)[0]; - const startWithContext = Math.max(actualStartPosition - 120, 0); - - const top = startWithContext === 0 ? "" : "..."; - const tail = startWithContext + 240 < text.length ? "..." : ""; - - let summary = document.createElement("p"); - summary.classList.add("context"); - summary.textContent = top + text.substr(startWithContext, 240).trim() + tail; - - return summary; - }, -}; - -_ready(Search.init); diff --git a/docs/build/html/_static/sphinx_highlight.js b/docs/build/html/_static/sphinx_highlight.js deleted file mode 100644 index 8a96c69..0000000 --- a/docs/build/html/_static/sphinx_highlight.js +++ /dev/null @@ -1,154 +0,0 @@ -/* Highlighting utilities for Sphinx HTML documentation. */ -"use strict"; - -const SPHINX_HIGHLIGHT_ENABLED = true - -/** - * highlight a given string on a node by wrapping it in - * span elements with the given class name. - */ -const _highlight = (node, addItems, text, className) => { - if (node.nodeType === Node.TEXT_NODE) { - const val = node.nodeValue; - const parent = node.parentNode; - const pos = val.toLowerCase().indexOf(text); - if ( - pos >= 0 && - !parent.classList.contains(className) && - !parent.classList.contains("nohighlight") - ) { - let span; - - const closestNode = parent.closest("body, svg, foreignObject"); - const isInSVG = closestNode && closestNode.matches("svg"); - if (isInSVG) { - span = document.createElementNS("http://www.w3.org/2000/svg", "tspan"); - } else { - span = document.createElement("span"); - span.classList.add(className); - } - - span.appendChild(document.createTextNode(val.substr(pos, text.length))); - const rest = document.createTextNode(val.substr(pos + text.length)); - parent.insertBefore( - span, - parent.insertBefore( - rest, - node.nextSibling - ) - ); - node.nodeValue = val.substr(0, pos); - /* There may be more occurrences of search term in this node. So call this - * function recursively on the remaining fragment. - */ - _highlight(rest, addItems, text, className); - - if (isInSVG) { - const rect = document.createElementNS( - "http://www.w3.org/2000/svg", - "rect" - ); - const bbox = parent.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: parent, target: rect }); - } - } - } else if (node.matches && !node.matches("button, select, textarea")) { - node.childNodes.forEach((el) => _highlight(el, addItems, text, className)); - } -}; -const _highlightText = (thisNode, text, className) => { - let addItems = []; - _highlight(thisNode, addItems, text, className); - addItems.forEach((obj) => - obj.parent.insertAdjacentElement("beforebegin", obj.target) - ); -}; - -/** - * Small JavaScript module for the documentation. - */ -const SphinxHighlight = { - - /** - * highlight the search words provided in localstorage in the text - */ - highlightSearchWords: () => { - if (!SPHINX_HIGHLIGHT_ENABLED) return; // bail if no highlight - - // get and clear terms from localstorage - const url = new URL(window.location); - const highlight = - localStorage.getItem("sphinx_highlight_terms") - || url.searchParams.get("highlight") - || ""; - localStorage.removeItem("sphinx_highlight_terms") - url.searchParams.delete("highlight"); - window.history.replaceState({}, "", url); - - // get individual terms from highlight string - const terms = highlight.toLowerCase().split(/\s+/).filter(x => x); - if (terms.length === 0) return; // nothing to do - - // There should never be more than one element matching "div.body" - const divBody = document.querySelectorAll("div.body"); - const body = divBody.length ? divBody[0] : document.querySelector("body"); - window.setTimeout(() => { - terms.forEach((term) => _highlightText(body, term, "highlighted")); - }, 10); - - const searchBox = document.getElementById("searchbox"); - if (searchBox === null) return; - searchBox.appendChild( - document - .createRange() - .createContextualFragment( - '

' + - '' + - _("Hide Search Matches") + - "

" - ) - ); - }, - - /** - * helper function to hide the search marks again - */ - hideSearchWords: () => { - document - .querySelectorAll("#searchbox .highlight-link") - .forEach((el) => el.remove()); - document - .querySelectorAll("span.highlighted") - .forEach((el) => el.classList.remove("highlighted")); - localStorage.removeItem("sphinx_highlight_terms") - }, - - initEscapeListener: () => { - // only install a listener if it is really needed - if (!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.shiftKey || event.altKey || event.ctrlKey || event.metaKey) return; - if (DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS && (event.key === "Escape")) { - SphinxHighlight.hideSearchWords(); - event.preventDefault(); - } - }); - }, -}; - -_ready(() => { - /* Do not call highlightSearchWords() when we are on the search page. - * It will highlight words from the *previous* search query. - */ - if (typeof Search === "undefined") SphinxHighlight.highlightSearchWords(); - SphinxHighlight.initEscapeListener(); -}); diff --git a/docs/build/html/genindex.html b/docs/build/html/genindex.html deleted file mode 100644 index 7b6c380..0000000 --- a/docs/build/html/genindex.html +++ /dev/null @@ -1,111 +0,0 @@ - - - - - - Index — Velocity documentation - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
-
    -
    • -
  • Index
    • -
  • -
    • -
-
-
-
-
- - -

Index

- -
- -
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/build/html/index.html b/docs/build/html/index.html deleted file mode 100644 index e4e71f5..0000000 --- a/docs/build/html/index.html +++ /dev/null @@ -1,135 +0,0 @@ - - - - - - - Velocity Container Build Management — Velocity documentation - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

Velocity Container Build Management

-

Velocity is a tool to help with the maintenance of container build scripts on multiple systems, backends -(e.g podman or apptainer) and distros.

-
- -
-
- -
-
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/build/html/objects.inv b/docs/build/html/objects.inv deleted file mode 100644 index 8827a59..0000000 Binary files a/docs/build/html/objects.inv and /dev/null differ diff --git a/docs/build/html/reference/build.html b/docs/build/html/reference/build.html deleted file mode 100644 index 320f4e6..0000000 --- a/docs/build/html/reference/build.html +++ /dev/null @@ -1,170 +0,0 @@ - - - - - - - Build Process — Velocity documentation - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

Build Process

-

This page describes the steps that velocity goes through when building an image.

-
-

Setup

-

After selecting images to build and ordering them Velocity will also create a directory BSD (Build Sub Dir) -named <name>-<version>-<hash> in build directory.

-
-
-

Files

-

Next Velocity will copy any files that you specified.

-
-
-

Parse Template

-

Velocity will then parse the correct template and generate a file called script in the BSD.

-
-
-

Create Build Script

-

At this point Velocity will piece together the build command and append it to the end of the prolog (if a prolog was -specified). It will place the resulting script in the BSD with the name build.

-
-
-

Build

-

Finally velocity will run the build script and log the output to a file called log in the BSD.

-
-
-

Build Directory Layout

-

At the end of a build the build dir should look somthing like this. With the addition of any other files that -got copied in the files step.

-
.
-├── fedora-41-8a9a360
-│ ├── 8a9a360.sif
-│ ├── build
-│ ├── log
-│ └── script
-└── hello-world-1.0-de9c02b
-    ├── build
-    ├── de9c02b.sif
-    ├── hello_world.py
-    ├── log
-    └── script
-
-
-
-
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/build/html/reference/config.html b/docs/build/html/reference/config.html deleted file mode 100644 index 7dfb61c..0000000 --- a/docs/build/html/reference/config.html +++ /dev/null @@ -1,191 +0,0 @@ - - - - - - - Configuration — Velocity documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

Configuration

-

Configuration for Velocity comes from three places. Command line options, environment variables and the configuration file.

-
-

Commandline Options

-

These take the highest level of precedence and can be viewed by using the --help option in the command line.

-
-
-

Variables

-

Variables are the second highest level of configuration.

-
-

VELOCITY_IMAGE_PATH

-

This variable points to the directories containing the the image definitions.

-
-
-

VELOCITY_SYSTEM

-

This variable specifies what computer system you are building for (e.g. frontier).

-
-
-

VELOCITY_BACKEND

-

This variable specifies the container backend that should be used (e.g podman).

-
-
-

VELOCITY_DISTRO

-

This variable specifies the distro of the container images that will be built. This name is flexable and completely -up to the user. It is used purely for organizational purposes.

-
-
-

VELOCITY_BUILD_DIR

-

This variable specifies a scratch space for Velocity to preform builds in.

-
-
-

VELOCITY_CONFIG_DIR

-

This variable specifies where to look for the configuration file.

-
-
-
-

Configuration File

-

The configuration file is the lowest level of configuration. By default Velocity looks for config.yaml in -~/.velocity unless VELOCITY_CONFIG_DIR is set. A number of configuration option for velocity can be set.

-
velocity:
-  system: frontier
-  backend: apptainer
-  distro: ubuntu
-  debug: INFO   # set the debug level
-  image_path:   # a list of : seperated paths
-  build_dir:    # path to a scratch space
-
-
-

Additionally you can set arguments and variables at a global level in the constraints section. As an example here -we are adding --disable-cache as an argument for every image build we do with apptainer.

-
constraints:
-  arguments:
-    - value: --disable-cache
-      when: backend=apptainer
-
-
-
-
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/build/html/reference/index.html b/docs/build/html/reference/index.html deleted file mode 100644 index 26ccfca..0000000 --- a/docs/build/html/reference/index.html +++ /dev/null @@ -1,153 +0,0 @@ - - - - - - - Technical Docs — Velocity documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
- -
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/build/html/reference/specs.html b/docs/build/html/reference/specs.html deleted file mode 100644 index 62f032e..0000000 --- a/docs/build/html/reference/specs.html +++ /dev/null @@ -1,234 +0,0 @@ - - - - - - - Specs.yaml — Velocity documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

Specs.yaml

-
-

About

-

The specs.yaml file defines image availability, dependencies and a number of other available -options for an image.

-
-
-

Config Options

-
-

versions

-

The versions section defines a list of versions and their availability.

-
versions:
-  - spec: 45
-    when: distro=ubuntu
-  - spec:
-      - 46
-      - 47
-    when: backend=podman
-
-
-
-
-

dependencies

-

The dependencies section is used to specify prerequist images.

-
dependencies:
-  - spec: ubuntu
-    when: distro=ubuntu
-  - spec:
-      - "gcc@12:"
-      - pytorch
-    when: myapp@:2.3
-
-
-
-
-

templates

-

By default velocity looks for a template called default.vtmp, but using the templates section you can specify an -alternate template.

-
templates:
-  - name: second_tmp
-    when: "myapp@2:"
-
-
-
-
-

arguments

-

Use the argument section to add build time arguments to an image.

-
arguments:
-  - value: --disable-cache
-    when: backend=apptainer
-
-
-
-
-

variables

-

Use the variables section to set template variables.

-
variables:
-  - name: test_var
-    value: "Test value."
-
-
-
-
-

files

-

Use the files section to specify files or directories in the files folder that you want copied to the build directory.

-
files:
-  - name: config.json
-
-
-
-
-

prologs

-

Use the prologs section to bash commands that you want to run before the build.

-
prologs:
-  - script: |
-      git clone ...
-    when: system=summit
-
-
-
-
-
-

Using when

-

A few notes about using when to filter config options. The when option can be used to filter configs as shown -above by system, backend, distro and dependencies. The only exception to this is the versions section which cannot -be filtered by dependencies. List each item that you want to filter by separated by a space e.g. gcc@12.3 system=frontier. -Additionally you can specify the scope of a when by specifying the scope. The default scope is image which means -that the when statement is evaluated on the current image. So say you want to apply a config in the gcc specs.yaml file -to every gcc version greater than 10.3.0, you would use when: ^ubuntu:. Alternatively you can set the scope to build -when you want the when statement evaluated on the current build.

-
variable:
-  - name: TEST
-    value: "1 2 3 4"
-    when: ubuntu
-    scope: build
-
-
-

This can be read as “If the ubuntu image is in the current set of images to be built then add the TEST variable.”

-
-
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/build/html/reference/vtmp.html b/docs/build/html/reference/vtmp.html deleted file mode 100644 index 1ac30e1..0000000 --- a/docs/build/html/reference/vtmp.html +++ /dev/null @@ -1,271 +0,0 @@ - - - - - - - VTMP Format — Velocity documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

VTMP Format

-

VTMP files are used by Velocity to generate the appropriate script for a particular backend. -The goal of the VTMP files are to provide a unified API for -container images across multiple backends but they are not feature exhaustive. -VTMP files are split up into a number of sections.

-
-
Example VTMP
-
>>> this is a comment
-@from
-    >>> can only take one of these examples
-    docker.io/ubuntu:20.04
-    /example.sif    >>> only works for apptainer backend
-    {{ __base__ }}  >>> build on the previous image
-
-@pre
-    >>> anything here is taken literally
-    >>> optionally denote the start of a line with | (helpful for white space)
-    echo 'Without tab'
-    |    echo 'With tab'
-
-@copy
-    >>> list files to copy, format <src> <dest>
-    /external/file /internal/file
-
-@run
-    >>> list of commands to run in container
-    echo 'Hello world'
-    ?? distro=podman |> echo 'podman' ??    >>> conditional
-    ?? distro=apptainer |> echo 'apptainer' ??
-    echo {{ template_variable }}
-    echo @@ example_arg @@  >>> define an argument
-    !envar TEST_VAR I want this here and in the @env section    >>> the !envar directive
-
-@env
-    >>> set env variables
-    PATH /something:$PATH
-
-@label
-    >>> set container labels
-    IMAGE_NAME {{ __name__ }}
-
-@entry
-    >>> set  ENTRYPOINT or %runscript
-    >>> only one line allowed
-
-    /bin/bash
-
-@post >>> same as pre but placed after everything else
-
-
-
-
-

Variables

-

The first thing that is done to a VTMP file is the substitution of any variables found in the script. Variables are indicated -by {{ <variable> }}. In Velocity variables can be defined by the user in the specs.yaml file, but Velocity also -provides a set of build time variables.

-
__backend__
-__distro__
-__base__        >>> previous image to build on
-__name__        >>> current image name e.g. cuda
-__system__
-__version__     >>> image "version" e.g. 11.7.1
-__version_major__
-__version_minor__
-__version_patch__
-__version_suffix__
-__timestamp__
->>> the versions of all images in a build are also available in the following format
-__<name>__version__
-__<name>__version_major__
-__<name>__version_minor__
-__<name>__version_patch__
-__<name>__version_suffix__
-
-
-
-
-

Arguments

-

You can also pass in arguments at build time using the form @@ <name> @@, but don’t forget to add the -argument in specs.yaml so that is gets added to the build command or the build will fail.

-
-
-

Conditionals

-

If there is a line in a template that you only want under certain conditions use ?? <condition> |> <text> ??. -The whole conditional will be replaced with the <text> section if the condition is true; otherwise, it will substitute -an empty string. The conditionals can include the following components, system=<value>, backend=<value>, -distro=<value> and a dependency in the form ^<value>.

-
-
-

Sections

-
-

@from

-

The @from section is used to specify the base image to build on top of. Both Podman and Apptainer support pulling -from docker registries. Apptainer also supports building from a sif file. The @from section can only have one line in it.

-
-
-

@pre

-

This section and the related @post section enable a user to insert a literal section of text into the generated script. -One added feature in this section is the ability to denote the beginning of a line with the | character. This -allows you to add white space to the beginning of a line. The only difference between the @pre and @post section -are where they are placed in the script the @pre section is placed at the beginning of the script -right after the @from section.

-
-
-

@copy

-

The @copy section takes a list of files/dir to be copied in the <src> <dest> format.

-
-
-

@run

-

The @run section takes a list of commands to be run in the container. These commands should be written as if they all -occur one after the other in the same shell. One added feature to the @run section is the !envar directive. This -directive will add the following variable definition to the @env section as well as to the current @run section. Use -the format !envar <name> <value>.

-
-
-

@env

-

The @env section sets environment variables. These variables will only be available when the container is run or in -the next build so if there is a variable that is needed in the run section use the !envar directive in the @run section.

-
-
-

@label

-

A list of labels for the container. The key is separated from the value by the first space. Everything to the right of -the first space is included in the value.

-
-
-

@entry

-

This @entry section is converted to ENTRYPOINT for podman and %runscript for apptainer. You can only have one line -in the @entry section.

-
-
-

@post

-

See @pre. The @post section is placed at the end of the script after all other sections.

-
-
-
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/build/html/search.html b/docs/build/html/search.html deleted file mode 100644 index ea05434..0000000 --- a/docs/build/html/search.html +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - Search — Velocity documentation - - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
-
    -
    • -
  • Search
    • -
  • -
    • -
-
-
-
-
- - - - -
- -
- -
-
- -
-
-
-
- - - - - - - - - \ No newline at end of file diff --git a/docs/build/html/searchindex.js b/docs/build/html/searchindex.js deleted file mode 100644 index 61a2ffc..0000000 --- a/docs/build/html/searchindex.js +++ /dev/null @@ -1 +0,0 @@ -Search.setIndex({"alltitles": {"@copy": [[5, "copy"]], "@entry": [[5, "entry"]], "@env": [[5, "env"]], "@from": [[5, "from"]], "@label": [[5, "label"]], "@post": [[5, "post"]], "@pre": [[5, "pre"]], "@run": [[5, "run"]], "About": [[4, "about"]], "Adding Different Versions": [[8, "adding-different-versions"]], "Arguments": [[5, "arguments"]], "Base Image": [[8, "base-image"]], "Basic Usage": [[6, "basic-usage"]], "Build": [[1, "build"]], "Build Directory Layout": [[1, "build-directory-layout"]], "Build Process": [[1, null]], "Commandline Options": [[2, "commandline-options"]], "Conditionals": [[5, "conditionals"]], "Config Options": [[4, "config-options"]], "Configuration": [[2, null], [6, "configuration"]], "Configuration File": [[2, "configuration-file"]], "Create Build Script": [[1, "create-build-script"]], "Creating Your First Image": [[8, null]], "Files": [[1, "files"]], "Getting Started": [[7, null]], "Hello World!": [[8, "hello-world"]], "How it Works": [[6, "how-it-works"]], "Installation": [[6, "installation"]], "Overview": [[6, null]], "Parse Template": [[1, "parse-template"]], "Sections": [[5, "sections"]], "Setup": [[1, "setup"]], "Specifying Version": [[8, "specifying-version"]], "Specs.yaml": [[4, null]], "Technical Docs": [[3, null]], "Using when": [[4, "using-when"]], "VELOCITY_BACKEND": [[2, "velocity-backend"]], "VELOCITY_BUILD_DIR": [[2, "velocity-build-dir"]], "VELOCITY_CONFIG_DIR": [[2, "velocity-config-dir"]], "VELOCITY_DISTRO": [[2, "velocity-distro"]], "VELOCITY_IMAGE_PATH": [[2, "velocity-image-path"]], "VELOCITY_SYSTEM": [[2, "velocity-system"]], "VTMP Format": [[5, null]], "Variables": [[2, "variables"], [5, "variables"]], "Velocity Container Build Management": [[0, null]], "arguments": [[4, "arguments"]], "avail": [[6, "avail"]], "build": [[6, "build"]], "dependencies": [[4, "dependencies"]], "files": [[4, "files"]], "prologs": [[4, "prologs"]], "spec": [[6, "spec"]], "templates": [[4, "templates"]], "variables": [[4, "variables"]], "versions": [[4, "versions"]]}, "docnames": ["index", "reference/build", "reference/config", "reference/index", "reference/specs", "reference/vtmp", "starting/basic", "starting/index", "starting/tutorial"], "envversion": {"sphinx": 62, "sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2}, "filenames": ["index.rst", "reference/build.rst", "reference/config.rst", "reference/index.rst", "reference/specs.rst", "reference/vtmp.rst", "starting/basic.rst", "starting/index.rst", "starting/tutorial.rst"], "indexentries": {}, "objects": {}, "objnames": {}, "objtypes": {}, "terms": {"": [6, 8], "0": [1, 4, 6, 8], "00": [6, 8], "00m00": 8, "00m01": 8, "00m02": 8, "00m03": 8, "01": [6, 8], "04": [5, 6], "07": 8, "08": 8, "09": 8, "0_fedora": 8, "1": [1, 4, 5, 6, 8], "10": [4, 6, 8], "100": 8, "104": 8, "11": [5, 6, 8], "114": 8, "117": 8, "12": [4, 6, 8], "125": 8, "129392640": 8, "13": [6, 8], "131072": 8, "132": 8, "133": 8, "134": 8, "135": 8, "139": 8, "14": [6, 8], "145": 8, "15": 8, "16": 8, "160": 8, "17": 8, "170": 8, "18": 8, "19": [6, 8], "190": 8, "190972": 8, "2": [4, 6, 8], "20": [5, 6, 8], "204": 8, "206": 8, "207": 8, "208": 8, "21": 8, "22": [6, 8], "228": 8, "23": [6, 8], "24": [6, 8], "25": 8, "256": 8, "257": 8, "26": 8, "269": 8, "27": 8, "273": 8, "274": 8, "276": 8, "28": 8, "280": 8, "29": 8, "291": 8, "293": 8, "3": [4, 6, 8], "309": 8, "31": 8, "310": 8, "32": 8, "320": 8, "33": 8, "34": 6, "34086d2996104518800c8d7dcc6139a1": 8, "35": 8, "354": 8, "36": 8, "37": 8, "38": 8, "385": 8, "38__x86_64": 8, "39": 8, "391": 8, "393": 8, "4": [4, 6, 8], "40": [6, 8], "408": 8, "4096": 8, "41": [1, 8], "41__x86_64": 8, "42": 8, "424": 8, "43": 8, "44": 8, "447": 8, "45": 4, "46": 4, "47": 4, "5": [6, 8], "50": 8, "503": 8, "52": 8, "523": 8, "524": 8, "547": 8, "583": 8, "6": [6, 8], "647": 8, "648": 8, "66007040": 8, "686": 8, "7": [5, 6, 8], "71": 8, "721": 8, "723": 8, "730": 8, "75": 8, "750": 8, "77": 8, "8": [6, 8], "810": 8, "83": 8, "887": 8, "89": 8, "8__x86_64__cento": 6, "8a9a360": [1, 8], "9": 8, "90": 8, "92": 8, "94": 8, "95": 8, "96": 6, "98": 8, "99": 8, "A": [2, 4, 5], "As": 2, "At": 1, "By": [2, 4], "For": 8, "If": [4, 5, 8], "In": [5, 6, 8], "It": [1, 2, 6], "NOT": 6, "One": 5, "That": 8, "The": [2, 4, 5, 6], "These": [2, 5], "To": [6, 8], "With": [1, 5], "__": 5, "__backend__": 5, "__base__": [5, 8], "__distro__": 5, "__name__": 5, "__system__": 5, "__timestamp__": 5, "__version__": [5, 8], "__version_major__": 5, "__version_minor__": 5, "__version_patch__": 5, "__version_suffix__": 5, "aa51aa7": 8, "abil": 5, "about": 3, "abov": 4, "across": 5, "ad": [2, 5, 7], "add": [4, 5, 8], "addit": 1, "addition": [2, 4], "after": [1, 5, 8], "alia": 6, "all": [5, 6, 8], "allow": 5, "also": [1, 5, 6, 8], "altern": 4, "an": [1, 2, 4, 5, 6, 8], "ani": [1, 5], "anyth": 5, "api": 5, "append": 1, "appli": 4, "approach": 6, "appropri": 5, "apptain": [0, 2, 4, 5, 6, 8], "ar": [2, 5, 6, 8], "arch": 8, "argument": [2, 3, 6], "assum": 6, "avail": [4, 5, 8], "b": [6, 8], "backend": [0, 2, 4, 5, 6, 8], "base": [5, 6, 7], "bash": [4, 5, 6, 8], "basic": 7, "been": 8, "befor": [4, 8], "begin": 5, "between": [5, 8], "bin": [5, 8], "bootstrap": 8, "both": [5, 6], "bsd": 1, "build": [2, 3, 4, 5, 8], "build_dir": [2, 6], "built": [2, 4, 6, 8], "cach": [2, 4, 8], "call": [1, 4, 8], "can": [2, 4, 5, 6, 8], "cannot": 4, "cd": 6, "cento": 6, "centos__stream8__x86_64__cento": 6, "certain": 5, "chain": 6, "charact": 5, "check": 8, "chmod": 8, "cisco": 8, "clean": 8, "cleanup": 8, "clone": [4, 6], "com": [6, 8], "come": 2, "command": [1, 2, 4, 5, 6, 8], "commandlin": 3, "comment": 5, "common": 8, "compat": 8, "complet": [2, 8], "complic": 8, "compon": [5, 6], "comput": 2, "condit": 3, "config": [2, 3, 6], "configur": [0, 3, 7, 8], "constraint": 2, "contain": [2, 5, 6, 8], "conveni": 6, "convert": 5, "copi": [1, 4, 8], "correct": 1, "creat": [0, 3, 6, 7], "critic": 6, "cuda": [5, 6], "cudnn": 6, "current": [4, 5], "d": 6, "data": 8, "de9c02b": [1, 8], "debug": [2, 6], "default": [2, 4, 8], "defin": [4, 5, 6], "definit": [2, 5, 6], "denot": 5, "depend": [5, 6, 8], "describ": 1, "dest": 5, "differ": [5, 7], "dir": [1, 5], "direct": 5, "directori": [2, 3, 4, 6, 8], "disabl": [2, 4, 8], "dist": 6, "distro": [0, 2, 4, 5, 6, 8], "dnf": 8, "do": 2, "doc": 0, "docker": [5, 8], "don": 5, "done": 5, "download": 8, "drwxr": 8, "drwxrwxrwt": 8, "e": [0, 2, 4, 5, 8], "each": [4, 6], "easiest": 6, "echo": 5, "edit": [6, 8], "els": 5, "empti": [5, 8], "enabl": 5, "end": [1, 5], "entri": 8, "entrypoint": 5, "env": 8, "envar": 5, "environ": [2, 5], "eras": 8, "error": [6, 8], "evalu": 4, "everi": [2, 4], "everyth": 5, "exampl": [2, 5], "example_arg": 5, "except": 4, "exhaust": 5, "exit": 6, "expat": 8, "extern": 5, "f": 8, "fail": 5, "fc": 8, "fc38": 8, "fc4": 8, "fc41": 8, "featur": [5, 6], "fedora": [1, 8], "few": 4, "file": [3, 5, 8], "filter": 4, "final": [1, 6], "first": [0, 5, 7], "flag": 8, "flexabl": 2, "folder": [4, 8], "follow": [5, 8], "forget": 5, "form": [5, 8], "format": [0, 3], "found": 5, "from": [2, 6, 8], "frontier": [2, 4, 6], "g": [0, 2, 4, 5, 8], "gcc": [4, 6], "gener": [1, 5, 6, 8], "get": [0, 5, 8], "git": [4, 6], "github": 6, "give": 8, "given": 6, "glibc": 8, "global": 2, "gnutl": 8, "go": 6, "goal": 5, "goe": 1, "good": 6, "got": 1, "great": 8, "greater": [4, 8], "h": 6, "ha": [6, 8], "hand": 6, "hash": 1, "have": [5, 8], "hello": [1, 5, 7], "hello_world": [1, 8], "help": [0, 2, 5, 6], "here": [2, 5], "highest": 2, "hostnam": [6, 8], "how": 7, "http": 6, "i": [0, 2, 4, 5, 6, 8], "iarfnxer": 6, "ident": 8, "imag": [0, 1, 2, 4, 5, 6, 7], "image_nam": 5, "image_path": [2, 6], "import": 6, "inbound": 8, "includ": 5, "indent": 6, "indic": 5, "info": [2, 6], "insert": 5, "instal": [7, 8], "intern": 5, "io": [5, 8], "item": 4, "json": 4, "k": 8, "kb": 8, "kei": 5, "kib": 8, "l": 8, "langpack": 8, "later": 8, "latest": [6, 8], "layout": 3, "less": 8, "let": 8, "level": [2, 6], "lib": 8, "libb2": 8, "libgcc": 8, "libgomp": 8, "libnghttp2": 8, "libstdc": 8, "libxcrypt": 8, "like": [1, 6, 8], "line": [2, 5], "list": [2, 4, 5, 6], "liter": 5, "littl": 8, "load": 8, "localhost": 6, "localimag": 8, "log": 1, "look": [1, 2, 4, 8], "lookup": 6, "lowest": 2, "lxogjapp": 6, "m": [6, 8], "maintain": 6, "mainten": 0, "major": 8, "make": 8, "manag": 6, "mani": 6, "mb": 8, "mean": 4, "messag": 6, "mib": 8, "miniforge3": 6, "minim": 8, "minor": 8, "modul": 6, "modular": 8, "more": [6, 8], "move": 8, "mpdecim": 8, "mpi": 6, "mpich": 6, "multipl": [0, 5], "myapp": 4, "name": [1, 2, 4, 5, 6, 8], "need": [5, 6, 8], "new": 8, "next": [1, 5], "ng": 8, "noarch": 8, "note": [4, 6], "notic": 8, "now": [6, 8], "number": [2, 4, 5, 6], "occur": [5, 8], "off": 6, "olcf": 6, "one": [5, 6], "ones": 6, "onli": [4, 5, 6], "openh264": 8, "openssl": 8, "oper": 8, "option": [3, 5, 6, 8], "orchestr": 6, "order": [1, 6, 8], "organiz": 2, "other": [1, 4, 5], "otherwis": [5, 6], "our": 8, "output": [1, 6, 8], "overview": [0, 7], "packag": [6, 8], "page": [1, 6], "pars": 3, "particular": [5, 6], "pass": 5, "patch": 8, "path": [2, 5, 6], "pbxpudvh": 6, "piec": 1, "pip": [6, 8], "place": [1, 2, 5], "podman": [0, 2, 4, 5], "point": [1, 2], "posit": 6, "post": 8, "pre": 8, "prebuilt": 6, "preced": 2, "preform": 2, "prepar": 8, "prerequist": 4, "previou": 5, "print": [6, 8], "process": [0, 3], "program": 6, "prolog": 1, "provid": [5, 6], "pull": [5, 8], "pure": 2, "purpos": 2, "py": [1, 8], "python": [6, 8], "python3": [6, 8], "python__3": 6, "pytorch": [4, 6], "r": 8, "rather": 6, "rc2": 8, "read": 4, "recommend": 6, "registri": 5, "relat": 5, "releas": 8, "remov": 8, "replac": [5, 8], "repo": 8, "repositori": [6, 8], "resolv": 8, "respect": 8, "result": 1, "right": 5, "rocm": 6, "root": 8, "rpm": 8, "run": [1, 4, 8], "runscript": [5, 8], "rwxr": 8, "sai": 4, "same": 5, "scope": 4, "scratch": [2, 6], "script": [0, 3, 4, 5, 6, 8], "scriptlet": 8, "second": 2, "second_tmp": 4, "section": [2, 3, 4], "see": [5, 6, 8], "select": 1, "sep": 8, "separ": [4, 5], "seper": [2, 6], "set": [2, 4, 5, 6, 8], "setup": 3, "shell": 5, "should": [1, 2, 5, 6, 8], "show": 6, "shown": 4, "sif": [1, 5, 8], "similar": 6, "simpl": 8, "size": 8, "so": [4, 5, 6, 8], "some": 8, "someth": 5, "somth": 1, "sourc": 6, "space": [2, 4, 5, 6], "spec": [0, 3, 5, 8], "specifi": [1, 2, 4, 5, 6, 7], "spectrum": 6, "split": 5, "src": 5, "start": [0, 5, 8], "statement": 4, "step": 1, "stop": 8, "stream8": 6, "string": 5, "structur": 6, "sub": 1, "substitut": 5, "succeed": 8, "success": 6, "suffix": 8, "summari": 8, "summit": 4, "sunflyhd": 6, "support": 5, "system": [0, 2, 4, 5, 6], "systemd": 8, "t": 5, "tab": 5, "take": [2, 5, 6, 8], "taken": 5, "technic": 0, "tell": 6, "templat": [3, 5, 6, 8], "template_vari": 5, "test": [4, 8], "test_var": [4, 5], "text": 5, "than": [4, 8], "thei": 5, "them": 1, "thi": [1, 2, 4, 5, 6, 8], "thing": 5, "those": 6, "three": 2, "through": 1, "time": [4, 5], "tmp": 8, "togeth": 1, "tool": [0, 6], "top": 5, "total": 8, "tpm2": 8, "trace": 6, "transact": 8, "tree": 6, "trigger": 8, "true": 5, "tss": 8, "tutori": 8, "ubuntu": [2, 4, 5, 6], "under": 5, "underneath": 6, "unifi": 5, "uninstal": 8, "unless": [2, 6], "unvers": 8, "up": [2, 5], "updat": 8, "upgrad": 8, "us": [2, 3, 5, 6, 8], "usag": 7, "user": [2, 5, 6, 8], "usr": 8, "v": [6, 8], "valu": [2, 4, 5], "variabl": 3, "veloc": [1, 2, 4, 5, 6, 8], "veri": 6, "verifi": 8, "version": [1, 5, 6, 7], "via": 8, "view": [2, 6], "vim": 8, "vtmp": [0, 3, 4, 8], "wa": 1, "wai": 6, "want": [4, 5, 8], "warn": 6, "we": [2, 6, 8], "weak": 8, "well": 5, "what": 2, "whatev": 8, "wheel": [6, 8], "when": [1, 2, 3, 5, 8], "where": [2, 5], "which": [4, 8], "while": 6, "white": 5, "whl": 6, "whole": 5, "wish": 8, "without": 5, "work": [5, 7], "world": [1, 5, 7], "would": 4, "write": 6, "written": 5, "x": 8, "x8": 8, "x86": 8, "x86_": 8, "x86_6": 8, "x86_64": 8, "xjv": 8, "xr": 8, "y": 8, "yaml": [0, 2, 3, 5, 6, 8], "you": [1, 2, 4, 5, 6, 8], "your": [0, 6, 7], "zlib": 8}, "titles": ["Velocity Container Build Management", "Build Process", "Configuration", "Technical Docs", "Specs.yaml", "VTMP Format", "Overview", "Getting Started", "Creating Your First Image"], "titleterms": {"about": 4, "ad": 8, "argument": [4, 5], "avail": 6, "base": 8, "basic": 6, "build": [0, 1, 6], "commandlin": 2, "condit": 5, "config": 4, "configur": [2, 6], "contain": 0, "copi": 5, "creat": [1, 8], "depend": 4, "differ": 8, "directori": 1, "doc": 3, "entri": 5, "env": 5, "file": [1, 2, 4], "first": 8, "format": 5, "from": 5, "get": 7, "hello": 8, "how": 6, "imag": 8, "instal": 6, "label": 5, "layout": 1, "manag": 0, "option": [2, 4], "overview": 6, "pars": 1, "post": 5, "pre": 5, "process": 1, "prolog": 4, "run": 5, "script": 1, "section": 5, "setup": 1, "spec": [4, 6], "specifi": 8, "start": 7, "technic": 3, "templat": [1, 4], "us": 4, "usag": 6, "variabl": [2, 4, 5], "veloc": 0, "velocity_backend": 2, "velocity_build_dir": 2, "velocity_config_dir": 2, "velocity_distro": 2, "velocity_image_path": 2, "velocity_system": 2, "version": [4, 8], "vtmp": 5, "when": 4, "work": 6, "world": 8, "yaml": 4, "your": 8}}) \ No newline at end of file diff --git a/docs/build/html/starting/basic.html b/docs/build/html/starting/basic.html deleted file mode 100644 index b6b8dc3..0000000 --- a/docs/build/html/starting/basic.html +++ /dev/null @@ -1,278 +0,0 @@ - - - - - - - Overview — Velocity documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

Overview

-
-

How it Works

-

Velocity works by building a set of containers in a chain so that the final container has all of the needed components. -Velocity maintains a very hands off approach. It is only as good as the templates/configuration that you write. -In general it will assume that a particular build will work unless you tell it otherwise. It is important to note -that while Velocity has many features that are similar to those provided by a package manager, it is NOT a -package manager. Rather it should be viewed as a templating and build orchestration tool.

-
-
-

Installation

-

The easiest way to install velocity is to install prebuilt python packages using pip.

-
pip install olcf-velocity
-
-
-

You can also clone the velocity repository and build/install velocity from source.

-
git clone https://github.com/olcf/velocity.git
-cd velocity
-python3 -m build
-# install the built python wheel package
-pip install dist/olcf-velocity-<version>*.whl
-
-
-

Now you can use Velocity as a python module! We recommend setting a bash alias for convenience.

-
user@hostname:~$ alias velocity="python3 -m velocity"
-user@hostname:~$ velocity
-usage: velocity [-h] [-v] [-D {TRACE,DEBUG,INFO,SUCCESS,WARNING,ERROR,CRITICAL}] [-b BACKEND] [-s SYSTEM] [-d DISTRO] {build,avail,spec} ...
-
-build tool for OLCF containers
-
-positional arguments:
-  {build,avail,spec}
-    build               build specified container image
-    avail               lookup available images
-    spec                lookup image dependencies
-
-options:
-  -h, --help            show this help message and exit
-  -v, --version         program version
-  -D {TRACE,DEBUG,INFO,SUCCESS,WARNING,ERROR,CRITICAL}, --debug {TRACE,DEBUG,INFO,SUCCESS,WARNING,ERROR,CRITICAL}
-                        set debug output level
-  -b BACKEND, --backend BACKEND
-  -s SYSTEM, --system SYSTEM
-  -d DISTRO, --distro DISTRO
-
-See https://github.com/olcf/velocity
-
-
-
-
-

Configuration

-

Velocity has a number of configuration options. The basic ones are setting the system name, container backend, -container distro, the path(s) to your image definitions and the build scratch directory. -To see more configuration options go to the configuration page. The easiest way to configure velocity is to -edit ~/.velocity/config.yaml.

-
velocity:
-  system: frontier
-  backend: apptainer
-  distro: ubuntu
-  image_path: # a list of : seperated paths
-  build_dir: # path to a scratch space
-
-
-
-

Note

-

Image definitions can be created by the user as needed but a base set for usage at OLCF are provided at -https://github.com/olcf/velocity-images

-
-
-
-

Basic Usage

-
-

avail

-

The avail command prints the defined images that can be built.

-
user@hostname:~$ velocity avail
-==> gcc
-    12.3.0
-    13.2.0
-    14.1.0
-==> mpich
-    3.4.3
-==> rocm
-    5.7.1
-==> ubuntu
-    20.04
-    22.04
-    24.04
-
-
-

Each image is listed and then indented underneath is a list of the available versions.

-
-
-

spec

-

The spec command shows the dependencies for a given image (or list of images) in a tree like structure.

-
user@hostname:~$ velocity spec pytorch
-  > pytorch@latest
-     ^cuda@11.7.1
-        ^centos@stream8
-     ^cudnn@8.5.0.96
-        ^cuda@11.7.1
-           ^centos@stream8
-     ^spectrum-mpi@10.4.0.6
-        ^centos@stream8
-     ^gcc@11.2.0
-        ^centos@stream8
-     ^miniforge3@23.11.0
-        ^centos@stream8
-
-
-
-
-

build

-

The build command can be used to build an container image from one or more image definitions.

-
user@hostname:~$ velocity build centos
-==> Build Order:
-        centos@=stream8
-
-==> iarfnxer: BUILD centos@=stream8 ...
-==> iarfnxer: GENERATING SCRIPT ...
-==> iarfnxer: BUILDING ...
-==> iarfnxer: IMAGE localhost/centos__stream8__x86_64__centos:latest (centos@=stream8) BUILT (0:01:22)
-
-
-

Both the spec and the build command can also take a list of images.

-
user@hostname:~$ velocity build gcc python
-==> Build Order:
-        centos@=stream8
-        gcc@=11.2.0
-        python@=3.11.8
-
-==> pbxpudvh: BUILD centos@=stream8 ...
-==> pbxpudvh: GENERATING SCRIPT ...
-==> pbxpudvh: BUILDING ...
-==> pbxpudvh: IMAGE localhost/pbxpudvh:latest (centos@=stream8) BUILT [0:01:00]
-
-==> lxogjapp: BUILD gcc@=11.2.0 ...
-==> lxogjapp: GENERATING SCRIPT ...
-==> lxogjapp: BUILDING ...
-==> lxogjapp: IMAGE localhost/lxogjapp:latest (gcc@=11.2.0) BUILT [0:40:34]
-
-==> sunflyhd: BUILD python@=3.11.8 ...
-==> sunflyhd: GENERATING SCRIPT ...
-==> sunflyhd: BUILDING ...
-==> sunflyhd: IMAGE localhost/python__3.11.8__x86_64__centos:latest (python@=3.11.8) BUILT [0:23:19]
-
-
-
-
-
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/build/html/starting/index.html b/docs/build/html/starting/index.html deleted file mode 100644 index 646b622..0000000 --- a/docs/build/html/starting/index.html +++ /dev/null @@ -1,137 +0,0 @@ - - - - - - - Getting Started — Velocity documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
- -
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/build/html/starting/tutorial.html b/docs/build/html/starting/tutorial.html deleted file mode 100644 index 1af710d..0000000 --- a/docs/build/html/starting/tutorial.html +++ /dev/null @@ -1,628 +0,0 @@ - - - - - - - Creating Your First Image — Velocity documentation - - - - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

Creating Your First Image

-
-

Base Image

-

Let’s start with a simple base image. This image will pull an fedora docker image and update the packages. For this -tutorial I have created the empty directory /tmp/velocity/images and configured it as the image directory. I have set -the build directory to /tmp/velocity/build, the backend to apptainer and the distro as fedora. All -commands are run in /tmp/velocity. -Start by creating a directory in the image directory called fedora. In this directory create a file called -specs.yaml and a directory called templates with -a file named default.vtmp. Your image directory and files should now look like this.

-
-
/tmp/velocity/images
-
fedora
-├── specs.yaml
-└── templates
-    └── default.vtmp
-
-
-
-
-
specs.yaml
-
versions:
-  - spec: 38
-    when: distro=fedora
-
-
-
-
-
default.vtmp
-
@from
-    docker.io/fedora:{{ __version__ }}
-
-@run
-    dnf -y upgrade
-    dnf clean all
-
-
-
-

Now if you run velocity avail you should get the following.

-
user@hostname:~$ velocity avail
-==> fedora
-    38
-
-
-

Now build the image.

-
user@hostname:~$ velocity build fedora
-==> Build Order:
-    fedora@38-aa51aa7
-
-==> aa51aa7: BUILD fedora@38 ...
-==> aa51aa7: GENERATING SCRIPT ...
-==> aa51aa7: BUILDING ...
-==> aa51aa7: IMAGE /tmp/velocity/build/fedora-38-aa51aa7/aa51aa7.sif (fedora@38) BUILT [0:01:07]
-
-==> BUILT: /tmp/velocity/fedora-38__x86_64-fedora.sif
-
-
-

If you wish to see more output you can add the -v flag:

-
user@hostname:~$ velocity build fedora -v
-==> Build Order:
-    fedora@38-aa51aa7
-
-==> aa51aa7: BUILD fedora@38 ...
-==> aa51aa7: GENERATING SCRIPT ...
-    SCRIPT: /tmp/velocity/build/fedora-38-aa51aa7/script
-    Bootstrap: docker
-    From: docker.io/fedora:38
-
-    %post
-    dnf -y upgrade
-    dnf clean all
-==> aa51aa7: BUILDING ...
-    #!/usr/bin/env bash
-    apptainer build --disable-cache /tmp/velocity/build/fedora-38-aa51aa7/aa51aa7.sif /tmp/velocity/build/fedora-38-aa51aa7/script;
-    Fedora 38 - x86_64                              2.3 MB/s |  83 MB     00:35
-    Fedora 38 openh264 (From Cisco) - x86_64        2.8 kB/s | 2.6 kB     00:00
-    Fedora Modular 38 - x86_64                      1.8 MB/s | 2.8 MB     00:01
-    Fedora 38 - x86_64 - Updates                    2.8 MB/s |  42 MB     00:14
-    Fedora Modular 38 - x86_64 - Updates            257 kB/s | 2.2 MB     00:08
-    Dependencies resolved.
-    ================================================================================
-     Package                            Arch    Version              Repo      Size
-    ================================================================================
-    Upgrading:
-     fedora-release-common              noarch  38-37                updates   20 k
-     fedora-release-container           noarch  38-37                updates   10 k
-     fedora-release-identity-container  noarch  38-37                updates   12 k
-     glibc                              x86_64  2.37-19.fc38         updates  2.1 M
-     glibc-common                       x86_64  2.37-19.fc38         updates  320 k
-     glibc-minimal-langpack             x86_64  2.37-19.fc38         updates   42 k
-     gnutls                             x86_64  3.8.5-1.fc38         updates  1.1 M
-     libnghttp2                         x86_64  1.52.0-3.fc38        updates   75 k
-     python-pip-wheel                   noarch  22.3.1-4.fc38        updates  1.4 M
-     python3                            x86_64  3.11.9-2.fc38        updates   28 k
-     python3-libs                       x86_64  3.11.9-2.fc38        updates  9.6 M
-     tpm2-tss                           x86_64  4.0.2-1.fc38         updates  391 k
-     vim-data                           noarch  2:9.1.393-1.fc38     updates   23 k
-     vim-minimal                        x86_64  2:9.1.393-1.fc38     updates  810 k
-    Installing weak dependencies:
-     libxcrypt-compat                   x86_64  4.4.36-1.fc38        updates   90 k
-
-    Transaction Summary
-    ================================================================================
-    Install   1 Package
-    Upgrade  14 Packages
-
-    Total download size: 16 M
-    Downloading Packages:
-    (1/15): fedora-release-container-38-37.noarch.r 160 kB/s |  10 kB     00:00
-    (2/15): fedora-release-common-38-37.noarch.rpm  228 kB/s |  20 kB     00:00
-    (3/15): fedora-release-identity-container-38-37 385 kB/s |  12 kB     00:00
-    (4/15): libxcrypt-compat-4.4.36-1.fc38.x86_64.r 648 kB/s |  90 kB     00:00
-    (5/15): glibc-minimal-langpack-2.37-19.fc38.x86 1.1 MB/s |  42 kB     00:00
-    (6/15): glibc-common-2.37-19.fc38.x86_64.rpm    2.4 MB/s | 320 kB     00:00
-    (7/15): libnghttp2-1.52.0-3.fc38.x86_64.rpm     1.7 MB/s |  75 kB     00:00
-    (8/15): glibc-2.37-19.fc38.x86_64.rpm           8.1 MB/s | 2.1 MB     00:00
-    (9/15): python3-3.11.9-2.fc38.x86_64.rpm        686 kB/s |  28 kB     00:00
-    (10/15): python-pip-wheel-22.3.1-4.fc38.noarch. 8.8 MB/s | 1.4 MB     00:00
-    (11/15): tpm2-tss-4.0.2-1.fc38.x86_64.rpm       6.1 MB/s | 391 kB     00:00
-    (12/15): gnutls-3.8.5-1.fc38.x86_64.rpm         3.1 MB/s | 1.1 MB     00:00
-    (13/15): vim-data-9.1.393-1.fc38.noarch.rpm     503 kB/s |  23 kB     00:00
-    (14/15): vim-minimal-9.1.393-1.fc38.x86_64.rpm  4.3 MB/s | 810 kB     00:00
-    (15/15): python3-libs-3.11.9-2.fc38.x86_64.rpm   11 MB/s | 9.6 MB     00:00
-    --------------------------------------------------------------------------------
-    Total                                            11 MB/s |  16 MB     00:01
-    Running transaction check
-    Transaction check succeeded.
-    Running transaction test
-    Transaction test succeeded.
-    Running transaction
-      Preparing        :                                                        1/1
-      Upgrading        : glibc-common-2.37-19.fc38.x86_64                      1/29
-      Upgrading        : glibc-minimal-langpack-2.37-19.fc38.x86_64            2/29
-      Running scriptlet: glibc-2.37-19.fc38.x86_64                             3/29
-      Upgrading        : glibc-2.37-19.fc38.x86_64                             3/29
-      Running scriptlet: glibc-2.37-19.fc38.x86_64                             3/29
-      Upgrading        : fedora-release-identity-container-38-37.noarch        4/29
-      Upgrading        : fedora-release-container-38-37.noarch                 5/29
-      Upgrading        : fedora-release-common-38-37.noarch                    6/29
-      Installing       : libxcrypt-compat-4.4.36-1.fc38.x86_64                 7/29
-      Upgrading        : python-pip-wheel-22.3.1-4.fc38.noarch                 8/29
-      Upgrading        : python3-3.11.9-2.fc38.x86_64                          9/29
-      Upgrading        : python3-libs-3.11.9-2.fc38.x86_64                    10/29
-      Upgrading        : vim-data-2:9.1.393-1.fc38.noarch                     11/29
-      Upgrading        : vim-minimal-2:9.1.393-1.fc38.x86_64                  12/29
-      Upgrading        : gnutls-3.8.5-1.fc38.x86_64                           13/29
-      Upgrading        : libnghttp2-1.52.0-3.fc38.x86_64                      14/29
-      Running scriptlet: tpm2-tss-4.0.2-1.fc38.x86_64                         15/29
-      Upgrading        : tpm2-tss-4.0.2-1.fc38.x86_64                         15/29
-      Cleanup          : fedora-release-common-38-36.noarch                   16/29
-      Cleanup          : gnutls-3.8.4-1.fc38.x86_64                           17/29
-      Cleanup          : tpm2-tss-4.0.1-3.fc38.x86_64                         18/29
-      Cleanup          : vim-minimal-2:9.1.309-1.fc38.x86_64                  19/29
-      Cleanup          : libnghttp2-1.52.0-2.fc38.x86_64                      20/29
-      Cleanup          : python3-3.11.8-2.fc38.x86_64                         21/29
-      Cleanup          : fedora-release-container-38-36.noarch                22/29
-      Cleanup          : fedora-release-identity-container-38-36.noarch       23/29
-      Cleanup          : vim-data-2:9.1.309-1.fc38.noarch                     24/29
-      Cleanup          : python3-libs-3.11.8-2.fc38.x86_64                    25/29
-      Cleanup          : python-pip-wheel-22.3.1-3.fc38.noarch                26/29
-      Cleanup          : glibc-2.37-18.fc38.x86_64                            27/29
-      Cleanup          : glibc-minimal-langpack-2.37-18.fc38.x86_64           28/29
-      Cleanup          : glibc-common-2.37-18.fc38.x86_64                     29/29
-      Running scriptlet: glibc-common-2.37-18.fc38.x86_64                     29/29
-      Verifying        : libxcrypt-compat-4.4.36-1.fc38.x86_64                 1/29
-      Verifying        : fedora-release-common-38-37.noarch                    2/29
-      Verifying        : fedora-release-common-38-36.noarch                    3/29
-      Verifying        : fedora-release-container-38-37.noarch                 4/29
-      Verifying        : fedora-release-container-38-36.noarch                 5/29
-      Verifying        : fedora-release-identity-container-38-37.noarch        6/29
-      Verifying        : fedora-release-identity-container-38-36.noarch        7/29
-      Verifying        : glibc-2.37-19.fc38.x86_64                             8/29
-      Verifying        : glibc-2.37-18.fc38.x86_64                             9/29
-      Verifying        : glibc-common-2.37-19.fc38.x86_64                     10/29
-      Verifying        : glibc-common-2.37-18.fc38.x86_64                     11/29
-      Verifying        : glibc-minimal-langpack-2.37-19.fc38.x86_64           12/29
-      Verifying        : glibc-minimal-langpack-2.37-18.fc38.x86_64           13/29
-      Verifying        : gnutls-3.8.5-1.fc38.x86_64                           14/29
-      Verifying        : gnutls-3.8.4-1.fc38.x86_64                           15/29
-      Verifying        : libnghttp2-1.52.0-3.fc38.x86_64                      16/29
-      Verifying        : libnghttp2-1.52.0-2.fc38.x86_64                      17/29
-      Verifying        : python-pip-wheel-22.3.1-4.fc38.noarch                18/29
-      Verifying        : python-pip-wheel-22.3.1-3.fc38.noarch                19/29
-      Verifying        : python3-3.11.9-2.fc38.x86_64                         20/29
-      Verifying        : python3-3.11.8-2.fc38.x86_64                         21/29
-      Verifying        : python3-libs-3.11.9-2.fc38.x86_64                    22/29
-      Verifying        : python3-libs-3.11.8-2.fc38.x86_64                    23/29
-      Verifying        : tpm2-tss-4.0.2-1.fc38.x86_64                         24/29
-      Verifying        : tpm2-tss-4.0.1-3.fc38.x86_64                         25/29
-      Verifying        : vim-data-2:9.1.393-1.fc38.noarch                     26/29
-      Verifying        : vim-data-2:9.1.309-1.fc38.noarch                     27/29
-      Verifying        : vim-minimal-2:9.1.393-1.fc38.x86_64                  28/29
-      Verifying        : vim-minimal-2:9.1.309-1.fc38.x86_64                  29/29
-
-    Upgraded:
-      fedora-release-common-38-37.noarch
-      fedora-release-container-38-37.noarch
-      fedora-release-identity-container-38-37.noarch
-      glibc-2.37-19.fc38.x86_64
-      glibc-common-2.37-19.fc38.x86_64
-      glibc-minimal-langpack-2.37-19.fc38.x86_64
-      gnutls-3.8.5-1.fc38.x86_64
-      libnghttp2-1.52.0-3.fc38.x86_64
-      python-pip-wheel-22.3.1-4.fc38.noarch
-      python3-3.11.9-2.fc38.x86_64
-      python3-libs-3.11.9-2.fc38.x86_64
-      tpm2-tss-4.0.2-1.fc38.x86_64
-      vim-data-2:9.1.393-1.fc38.noarch
-      vim-minimal-2:9.1.393-1.fc38.x86_64
-    Installed:
-      libxcrypt-compat-4.4.36-1.fc38.x86_64
-
-    Complete!
-    42 files removed
-==> aa51aa7: IMAGE /tmp/velocity/build/fedora-38-aa51aa7/aa51aa7.sif (fedora@38) BUILT [0:01:33]
-
-==> BUILT: /tmp/velocity/fedora-38__x86_64-fedora.sif
-
-
-
-
-

Adding Different Versions

-

So now we have a base Fedora image. That’s great but before we move on let’s make some different versions of the image -so that we have more options for building later. Edit the fedora specs.yaml and add some versions.

-
-
spec.yaml
-
versions:
-  - spec:
-      - 38
-      - 39
-      - 40
-      - 41
-    when: distro=fedora
-
-
-
-
user@hostname:~$ velocity avail
-==> fedora
-    38
-    39
-    40
-    41
-
-
-
-
-

Specifying Version

-

When building an image Velocity will default to the latest image. To specify a version use <image>@<version> e.g. -fedora@40. Versions take the form <major>.<minor>.<patch>-<suffix>. You can also specify greater than, less -than, and in-between via <image>@<version>:, <image>@:<version> and <image>@<version>:<version> respectively.

-
-
-

Hello World!

-

Now let’s get a little more complicated. Let’s create an image that runs a python script which prints hello world. You -can give it whatever version you want:

-
-
/tmp/velocity/images
-
fedora
-├── specs.yaml
-└── templates
-    └── default.vtmp
-hello-world
-├── files
-│   └── hello_world.py
-├── specs.yaml
-└── templates
-    └── default.vtmp
-
-
-
-

Notice that now there is a new folder called files with a python script in it.

-
-
hello_world.py
-
#!/usr/bin/env python3
-
-print("Hello, World!")
-
-
-
-
-
specs.yaml
-
versions:
-  - spec: 1.0
-dependencies:
-  - spec: fedora
-    when: distro=fedora
-files:
-  - name: hello_world.py
-
-
-
-
-
default.vtmp
-
@from
-    {{ __base__ }}
-
-@copy
-    hello_world.py /hello_world
-
-@run
-    dnf -y install python3
-    chmod +x /hello_world
-
-@entry
-    /hello_world
-
-
-
-
user@hostname:~$ velocity avail
-==> fedora
-    38
-    39
-    40
-    41
-==> hello-world
-    1.0
-
-
-
user@hostname:~$ velocity build hello-world -v
-==> Build Order:
-    fedora@41-8a9a360
-    hello-world@1.0-de9c02b
-
-==> 8a9a360: BUILD fedora@41 ...
-==> 8a9a360: GENERATING SCRIPT ...
-    SCRIPT: /tmp/velocity/build/fedora-41-8a9a360/script
-    Bootstrap: docker
-    From: docker.io/fedora:41
-
-    %post
-    dnf -y upgrade
-    dnf clean all
-==> 8a9a360: BUILDING ...
-    #!/usr/bin/env bash
-    apptainer build --disable-cache /tmp/velocity/build/fedora-41-8a9a360/8a9a360.sif /tmp/velocity/build/fedora-41-8a9a360/script;
-    Updating and loading repositories:
-     Fedora 41 openh264 (From Cisco) - x86_ 100% |   6.5 KiB/s |   4.8 KiB |  00m01s
-     Fedora 41 - x86_64 - Test Updates      100% |   1.8 MiB/s |   3.4 MiB |  00m02s
-     Fedora 41 - x86_64                     100% |  13.9 MiB/s |  35.9 MiB |  00m03s
-     Fedora 41 - x86_64 - Updates           100% |  50.3 KiB/s |  31.9 KiB |  00m01s
-    Repositories loaded.
-    Package                     Arch   Version        Repository                            Size
-    Upgrading:
-     libgcc                     x86_64 14.2.1-3.fc41  updates-testing                  274.6 KiB
-       replacing libgcc         x86_64 14.2.1-1.fc41  34086d2996104518800c8d7dcc6139a1 274.6 KiB
-     libgomp                    x86_64 14.2.1-3.fc41  updates-testing                  523.5 KiB
-       replacing libgomp        x86_64 14.2.1-1.fc41  34086d2996104518800c8d7dcc6139a1 523.4 KiB
-     libstdc++                  x86_64 14.2.1-3.fc41  updates-testing                    2.8 MiB
-       replacing libstdc++      x86_64 14.2.1-1.fc41  34086d2996104518800c8d7dcc6139a1   2.8 MiB
-     openssl-libs               x86_64 1:3.2.2-7.fc41 updates-testing                    7.8 MiB
-       replacing openssl-libs   x86_64 1:3.2.2-5.fc41 34086d2996104518800c8d7dcc6139a1   7.8 MiB
-     rpm                        x86_64 4.19.94-1.fc41 updates-testing                    3.1 MiB
-       replacing rpm            x86_64 4.19.92-6.fc41 34086d2996104518800c8d7dcc6139a1   3.1 MiB
-     rpm-build-libs             x86_64 4.19.94-1.fc41 updates-testing                  206.7 KiB
-       replacing rpm-build-libs x86_64 4.19.92-6.fc41 34086d2996104518800c8d7dcc6139a1 206.7 KiB
-     rpm-libs                   x86_64 4.19.94-1.fc41 updates-testing                  721.9 KiB
-       replacing rpm-libs       x86_64 4.19.92-6.fc41 34086d2996104518800c8d7dcc6139a1 721.9 KiB
-     systemd-libs               x86_64 256.6-1.fc41   updates-testing                    2.0 MiB
-       replacing systemd-libs   x86_64 256.5-1.fc41   34086d2996104518800c8d7dcc6139a1   2.0 MiB
-     zlib-ng-compat             x86_64 2.1.7-3.fc41   updates-testing                  134.0 KiB
-       replacing zlib-ng-compat x86_64 2.1.7-2.fc41   34086d2996104518800c8d7dcc6139a1 134.0 KiB
-
-    Transaction Summary:
-     Upgrading:         9 packages
-     Replacing:         9 packages
-
-    Total size of inbound packages is 5 MiB. Need to download 5 MiB.
-    After this operation 2 KiB will be used (install 17 MiB, remove 17 MiB).
-    [1/9] libgcc-0:14.2.1-3.fc41.x86_64     100% | 132.2 KiB/s | 133.3 KiB |  00m01s
-    [2/9] libstdc++-0:14.2.1-3.fc41.x86_64  100% | 583.3 KiB/s | 887.8 KiB |  00m02s
-    [3/9] libgomp-0:14.2.1-3.fc41.x86_64    100% | 208.5 KiB/s | 354.1 KiB |  00m02s
-    [4/9] rpm-0:4.19.94-1.fc41.x86_64       100% |   1.6 MiB/s | 547.6 KiB |  00m00s
-    [5/9] rpm-build-libs-0:4.19.94-1.fc41.x 100% |   2.1 MiB/s |  99.1 KiB |  00m00s
-    [6/9] openssl-libs-1:3.2.2-7.fc41.x86_6 100% |   2.6 MiB/s |   2.3 MiB |  00m01s
-    [7/9] rpm-libs-0:4.19.94-1.fc41.x86_64  100% |   1.1 MiB/s | 309.5 KiB |  00m00s
-    [8/9] zlib-ng-compat-0:2.1.7-3.fc41.x86 100% |   1.0 MiB/s |  77.7 KiB |  00m00s
-    [9/9] systemd-libs-0:256.6-1.fc41.x86_6 100% |   2.6 MiB/s | 730.9 KiB |  00m00s
-    --------------------------------------------------------------------------------
-    [9/9] Total                             100% |   2.2 MiB/s |   5.4 MiB |  00m02s
-    Running transaction
-    [ 1/20] Verify package files            100% | 750.0   B/s |   9.0   B |  00m00s
-    [ 2/20] Prepare transaction             100% |   1.6 KiB/s |  18.0   B |  00m00s
-    [ 3/20] Upgrading libgcc-0:14.2.1-3.fc4 100% |  14.2 MiB/s | 276.3 KiB |  00m00s
-    >>> Running post-install scriptlet: libgcc-0:14.2.1-3.fc41.x86_64
-    >>> Stop post-install scriptlet: libgcc-0:14.2.1-3.fc41.x86_64
-    [ 4/20] Upgrading zlib-ng-compat-0:2.1. 100% |  32.9 MiB/s | 134.8 KiB |  00m00s
-    [ 5/20] Upgrading rpm-libs-0:4.19.94-1. 100% | 117.7 MiB/s | 723.4 KiB |  00m00s
-    [ 6/20] Upgrading libgomp-0:14.2.1-3.fc 100% | 170.8 MiB/s | 524.8 KiB |  00m00s
-    [ 7/20] Upgrading rpm-build-libs-0:4.19 100% |  15.6 MiB/s | 207.5 KiB |  00m00s
-    >>> Running pre-install scriptlet: rpm-0:4.19.94-1.fc41.x86_64
-    >>> Stop pre-install scriptlet: rpm-0:4.19.94-1.fc41.x86_64
-    [ 8/20] Upgrading rpm-0:4.19.94-1.fc41. 100% | 104.3 MiB/s |   2.5 MiB |  00m00s
-    [ 9/20] Upgrading openssl-libs-1:3.2.2- 100% | 190.9 MiB/s |   7.8 MiB |  00m00s
-    [10/20] Upgrading libstdc++-0:14.2.1-3. 100% | 145.6 MiB/s |   2.8 MiB |  00m00s
-    [11/20] Upgrading systemd-libs-0:256.6- 100% | 135.3 MiB/s |   2.0 MiB |  00m00s
-    [12/20] Erasing rpm-build-libs-0:4.19.9 100% |   1.0 KiB/s |   5.0   B |  00m00s
-    [13/20] Erasing libstdc++-0:14.2.1-1.fc 100% |   6.1 KiB/s |  31.0   B |  00m00s
-    [14/20] Erasing systemd-libs-0:256.5-1. 100% |   2.4 KiB/s |  20.0   B |  00m00s
-    [15/20] Erasing rpm-0:4.19.92-6.fc41.x8 100% |  26.7 KiB/s | 273.0   B |  00m00s
-    [16/20] Erasing rpm-libs-0:4.19.92-6.fc 100% |   2.4 KiB/s |  10.0   B |  00m00s
-    [17/20] Erasing openssl-libs-1:3.2.2-5. 100% |   9.5 KiB/s |  39.0   B |  00m00s
-    [18/20] Erasing zlib-ng-compat-0:2.1.7- 100% |   1.2 KiB/s |   5.0   B |  00m00s
-    [19/20] Erasing libgcc-0:14.2.1-1.fc41. 100% | 647.0   B/s |  11.0   B |  00m00s
-    >>> Running post-uninstall scriptlet: libgcc-0:14.2.1-1.fc41.x86_64
-    >>> Stop post-uninstall scriptlet: libgcc-0:14.2.1-1.fc41.x86_64
-    [20/20] Erasing libgomp-0:14.2.1-1.fc41 100% |  43.0   B/s |   9.0   B |  00m00s
-    >>> Running post-transaction scriptlet: rpm-0:4.19.94-1.fc41.x86_64
-    >>> Stop post-transaction scriptlet: rpm-0:4.19.94-1.fc41.x86_64
-    >>> Running trigger-install scriptlet: glibc-common-0:2.40-3.fc41.x86_64
-    >>> Stop trigger-install scriptlet: glibc-common-0:2.40-3.fc41.x86_64
-    >>> Running trigger-post-uninstall scriptlet: glibc-common-0:2.40-3.fc41.x86_64
-    >>> Stop trigger-post-uninstall scriptlet: glibc-common-0:2.40-3.fc41.x86_64
-    Complete!
-    Removed 24 files, 13 directories. 0 errors occurred.
-==> 8a9a360: IMAGE /tmp/velocity/build/fedora-41-8a9a360/8a9a360.sif (fedora@41) BUILT [0:00:21]
-
-==> de9c02b: BUILD hello-world@1.0 ...
-==> de9c02b: COPYING FILES ...
-    FILE: /tmp/velocity/images/hello-world/files/hello_world.py -> /tmp/velocity/build/hello-world-1.0-de9c02b/hello_world.py
-==> de9c02b: GENERATING SCRIPT ...
-    SCRIPT: /tmp/velocity/build/hello-world-1.0-de9c02b/script
-    Bootstrap: localimage
-    From: /tmp/velocity/build/fedora-41-8a9a360/8a9a360.sif
-
-    %files
-    hello_world.py /hello_world
-
-    %post
-    dnf -y install python3
-    chmod +x /hello_world
-
-    %runscript
-    /hello_world
-==> de9c02b: BUILDING ...
-    #!/usr/bin/env bash
-    apptainer build --disable-cache /tmp/velocity/build/hello-world-1.0-de9c02b/de9c02b.sif /tmp/velocity/build/hello-world-1.0-de9c02b/script;
-    Updating and loading repositories:
-     Fedora 41 openh264 (From Cisco) - x86_ 100% |  11.1 KiB/s |   6.0 KiB |  00m01s
-     Fedora 41 - x86_64                     100% |  11.7 MiB/s |  35.4 MiB |  00m03s
-     Fedora 41 - x86_64 - Updates           100% |  50.1 KiB/s |  31.9 KiB |  00m01s
-     Fedora 41 - x86_64 - Test Updates      100% |   1.8 MiB/s |   2.1 MiB |  00m01s
-    Repositories loaded.
-    Package                     Arch   Version           Repository           Size
-    Installing:
-     python3                    x86_64 3.13.0~rc2-1.fc41 fedora           31.8 KiB
-    Installing dependencies:
-     expat                      x86_64 2.6.3-1.fc41      updates-testing 291.5 KiB
-     libb2                      x86_64 0.98.1-12.fc41    fedora           42.2 KiB
-     mpdecimal                  x86_64 2.5.1-16.fc41     fedora          204.9 KiB
-     python-pip-wheel           noarch 24.2-1.fc41       fedora            1.2 MiB
-     python3-libs               x86_64 3.13.0~rc2-1.fc41 fedora           40.3 MiB
-    Installing weak dependencies:
-     python-unversioned-command noarch 3.13.0~rc2-1.fc41 fedora           23.0   B
-
-    Transaction Summary:
-     Installing:        7 packages
-
-    Total size of inbound packages is 11 MiB. Need to download 11 MiB.
-    After this operation 42 MiB will be used (install 42 MiB, remove 0 B).
-    [1/7] libb2-0:0.98.1-12.fc41.x86_64     100% |  94.1 KiB/s |  25.7 KiB |  00m00s
-    [2/7] python3-0:3.13.0~rc2-1.fc41.x86_6 100% |  95.9 KiB/s |  27.4 KiB |  00m00s
-    [3/7] mpdecimal-0:2.5.1-16.fc41.x86_64  100% | 408.0 KiB/s |  89.0 KiB |  00m00s
-    [4/7] expat-0:2.6.3-1.fc41.x86_64       100% | 447.4 KiB/s | 114.1 KiB |  00m00s
-    [5/7] python-pip-wheel-0:24.2-1.fc41.no 100% |   2.5 MiB/s |   1.2 MiB |  00m00s
-    [6/7] python-unversioned-command-0:3.13 100% | 125.1 KiB/s |  10.5 KiB |  00m00s
-    [7/7] python3-libs-0:3.13.0~rc2-1.fc41. 100% |   8.1 MiB/s |   9.1 MiB |  00m01s
-    --------------------------------------------------------------------------------
-    [7/7] Total                             100% |   6.7 MiB/s |  10.6 MiB |  00m02s
-    Running transaction
-    [1/9] Verify package files              100% | 269.0   B/s |   7.0   B |  00m00s
-    [2/9] Prepare transaction               100% | 280.0   B/s |   7.0   B |  00m00s
-    [3/9] Installing expat-0:2.6.3-1.fc41.x 100% |  71.7 MiB/s | 293.6 KiB |  00m00s
-    [4/9] Installing python-pip-wheel-0:24. 100% | 310.4 MiB/s |   1.2 MiB |  00m00s
-    [5/9] Installing mpdecimal-0:2.5.1-16.f 100% |  50.3 MiB/s | 206.0 KiB |  00m00s
-    [6/9] Installing libb2-0:0.98.1-12.fc41 100% |   4.7 MiB/s |  43.3 KiB |  00m00s
-    [7/9] Installing python3-libs-0:3.13.0~ 100% | 139.9 MiB/s |  40.7 MiB |  00m00s
-    [8/9] Installing python3-0:3.13.0~rc2-1 100% |  10.9 MiB/s |  33.6 KiB |  00m00s
-    [9/9] Installing python-unversioned-com 100% |   1.8 KiB/s | 424.0   B |  00m00s
-    >>> Running trigger-install scriptlet: glibc-common-0:2.40-3.fc41.x86_64
-    >>> Stop trigger-install scriptlet: glibc-common-0:2.40-3.fc41.x86_64
-    Complete!
-==> de9c02b: IMAGE /tmp/velocity/build/hello-world-1.0-de9c02b/de9c02b.sif (hello-world@1.0) BUILT [0:00:14]
-
-==> BUILT: /tmp/velocity/hello-world-1.0_fedora-41__x86_64-fedora.sif
-
-
-

Our hello-world image has been built!

-
user@hostname:~$ ls
-total 190972
-drwxr-xr-x  4 xjv  users      4096 Sep 18 10:01 .
-drwxrwxrwt 31 root root     131072 Sep 18 10:01 ..
-drwxr-xr-x  4 xjv  users      4096 Sep 18 10:01 build
--rwxr-xr-x  1 xjv  users  66007040 Sep 18 09:42 fedora-38__x86_64-fedora.sif
--rwxr-xr-x  1 xjv  users 129392640 Sep 18 10:01 hello-world-1.0_fedora-41__x86_64-fedora.sif
-drwxr-xr-x  4 xjv  users      4096 Sep 18 09:44 images
-
-
-

Now you can run the image!

-
user@hostname:~$ apptainer run hello-world-1.0_fedora-41__x86_64-fedora.sif
-Hello, World!
-
-
-
-
- - -
-
- -
-
-
-
- - - - \ No newline at end of file diff --git a/docs/source/index.rst b/docs/source/index.rst index fcb521a..cd4d4ce 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -9,6 +9,15 @@ Velocity Container Build Management Velocity is a tool to help with the maintenance of container build scripts on multiple systems, backends (e.g podman or apptainer) and distros. +Often, when building containers, you may want to try different distros or combinations of software. Usually, this requires +copying your container script and making modifications. Velocity aims to cut down on the time wasted in this repetitive process and the +clutter of numerous scripts with minor changes. Velocity does this by compartmentalizing your software stack and +templating your software installations. + +.. important:: + + Documentation hosted at `olcf.github.io/velocity `_ follows the ``develop`` branch. + .. toctree:: :maxdepth: 2 diff --git a/docs/source/reference/build.rst b/docs/source/reference/build.rst index 6003d21..e6c25aa 100644 --- a/docs/source/reference/build.rst +++ b/docs/source/reference/build.rst @@ -7,13 +7,13 @@ This page describes the steps that velocity goes through when building an image. Setup ##### After selecting images to build and ordering them Velocity will also create a directory BSD (Build Sub Dir) -named ``--`` in build directory. +named ``--`` in the :ref:`build directory `. .. _files: Files ##### -Next Velocity will copy any files that you specified. +Next Velocity will copy any :ref:`specs_files` that you specified. Parse Template ############## diff --git a/docs/source/reference/config.rst b/docs/source/reference/config.rst index 50a83c3..b46b976 100644 --- a/docs/source/reference/config.rst +++ b/docs/source/reference/config.rst @@ -30,6 +30,8 @@ This variable specifies the container backend that should be used (e.g podman). This variable specifies the distro of the container images that will be built. This name is flexable and completely up to the user. It is used purely for organizational purposes. +.. _build_dir: + `VELOCITY_BUILD_DIR` -------------------- This variable specifies a scratch space for Velocity to preform builds in. diff --git a/docs/source/reference/specs.rst b/docs/source/reference/specs.rst index d3667f4..87c8a93 100644 --- a/docs/source/reference/specs.rst +++ b/docs/source/reference/specs.rst @@ -73,6 +73,8 @@ Use the `variables` section to set template variables. - name: test_var value: "Test value." +.. _specs_files: + files ----- Use the `files` section to specify files or directories in the `files` folder that you want copied to the build directory. @@ -84,7 +86,7 @@ Use the `files` section to specify files or directories in the `files` folder th prologs ------- -Use the `prologs` section to bash commands that you want to run before the build. +Use the `prologs` section to add bash commands that you want to run before the build. .. code-block:: yaml @@ -99,9 +101,9 @@ A few notes about using ``when`` to filter config options. The ``when`` option c above by system, backend, distro and dependencies. The only exception to this is the `versions` section which cannot be filtered by dependencies. List each item that you want to filter by separated by a space e.g. ``gcc@12.3 system=frontier``. Additionally you can specify the scope of a ``when`` by specifying the ``scope``. The default scope is ``image`` which means -that the when statement is evaluated on the current image. So say you want to apply a config in the gcc `specs.yaml` file -to every gcc version greater than 10.3.0, you would use ``when: ^ubuntu:``. Alternatively you can set the scope to ``build`` -when you want the when statement evaluated on the current build. +that the when statement is evaluated on the current image. So if you want to apply a config in the gcc `specs.yaml` file +to every gcc version greater than 10.3.0, you would use ``when: gcc@10.3.0: ^ubuntu``. Alternatively you can set the scope to ``build`` +when you want the ``when`` statement evaluated on all the images in the current build. .. code-block:: yaml diff --git a/docs/source/starting/basic.rst b/docs/source/starting/basic.rst deleted file mode 100644 index 99d4beb..0000000 --- a/docs/source/starting/basic.rst +++ /dev/null @@ -1,170 +0,0 @@ - -******** -Overview -******** - -How it Works -############ -Velocity works by building a set of containers in a chain so that the final container has all of the needed components. -Velocity maintains a very hands off approach. It is only as good as the templates/configuration that you write. -In general it will assume that a particular build will work unless you tell it otherwise. It is important to note -that while Velocity has many features that are similar to those provided by a package manager, it is NOT a -package manager. Rather it should be viewed as a templating and build orchestration tool. - -Installation -############ - -The easiest way to install velocity is to install prebuilt python packages using pip. - -.. code-block:: bash - - pip install olcf-velocity - -You can also clone the velocity repository and build/install velocity from source. - -.. code-block:: bash - - git clone https://github.com/olcf/velocity.git - cd velocity - python3 -m build - # install the built python wheel package - pip install dist/olcf-velocity-*.whl - -Now you can use Velocity as a python module! We recommend setting a bash alias for convenience. - -.. code-block:: bash - - user@hostname:~$ alias velocity="python3 -m velocity" - user@hostname:~$ velocity - usage: velocity [-h] [-v] [-D {TRACE,DEBUG,INFO,SUCCESS,WARNING,ERROR,CRITICAL}] [-b BACKEND] [-s SYSTEM] [-d DISTRO] {build,avail,spec} ... - - build tool for OLCF containers - - positional arguments: - {build,avail,spec} - build build specified container image - avail lookup available images - spec lookup image dependencies - - options: - -h, --help show this help message and exit - -v, --version program version - -D {TRACE,DEBUG,INFO,SUCCESS,WARNING,ERROR,CRITICAL}, --debug {TRACE,DEBUG,INFO,SUCCESS,WARNING,ERROR,CRITICAL} - set debug output level - -b BACKEND, --backend BACKEND - -s SYSTEM, --system SYSTEM - -d DISTRO, --distro DISTRO - - See https://github.com/olcf/velocity - -.. _configuration: - -Configuration -############# -Velocity has a number of configuration options. The basic ones are setting the system name, container backend, -container distro, the path(s) to your image definitions and the build scratch directory. -To see more configuration options go to the :doc:`configuration ` page. The easiest way to configure velocity is to -edit ``~/.velocity/config.yaml``. - -.. code-block:: - - velocity: - system: frontier - backend: apptainer - distro: ubuntu - image_path: # a list of : seperated paths - build_dir: # path to a scratch space - -.. note:: - - Image definitions can be created by the user as needed but a base set for usage at OLCF are provided at - https://github.com/olcf/velocity-images - -Basic Usage -########### - -`avail` -------- - -The `avail` command prints the defined images that can be built. - -.. code-block:: bash - - user@hostname:~$ velocity avail - ==> gcc - 12.3.0 - 13.2.0 - 14.1.0 - ==> mpich - 3.4.3 - ==> rocm - 5.7.1 - ==> ubuntu - 20.04 - 22.04 - 24.04 - -Each image is listed and then indented underneath is a list of the available versions. - -`spec` ------- - -The `spec` command shows the dependencies for a given image (or list of images) in a tree like structure. - -.. code-block:: bash - - user@hostname:~$ velocity spec pytorch - > pytorch@latest - ^cuda@11.7.1 - ^centos@stream8 - ^cudnn@8.5.0.96 - ^cuda@11.7.1 - ^centos@stream8 - ^spectrum-mpi@10.4.0.6 - ^centos@stream8 - ^gcc@11.2.0 - ^centos@stream8 - ^miniforge3@23.11.0 - ^centos@stream8 - - -`build` -------- - -The `build` command can be used to build an container image from one or more image definitions. - -.. code-block:: bash - - user@hostname:~$ velocity build centos - ==> Build Order: - centos@=stream8 - - ==> iarfnxer: BUILD centos@=stream8 ... - ==> iarfnxer: GENERATING SCRIPT ... - ==> iarfnxer: BUILDING ... - ==> iarfnxer: IMAGE localhost/centos__stream8__x86_64__centos:latest (centos@=stream8) BUILT (0:01:22) - -Both the spec and the build command can also take a list of images. - -.. code-block:: bash - - user@hostname:~$ velocity build gcc python - ==> Build Order: - centos@=stream8 - gcc@=11.2.0 - python@=3.11.8 - - ==> pbxpudvh: BUILD centos@=stream8 ... - ==> pbxpudvh: GENERATING SCRIPT ... - ==> pbxpudvh: BUILDING ... - ==> pbxpudvh: IMAGE localhost/pbxpudvh:latest (centos@=stream8) BUILT [0:01:00] - - ==> lxogjapp: BUILD gcc@=11.2.0 ... - ==> lxogjapp: GENERATING SCRIPT ... - ==> lxogjapp: BUILDING ... - ==> lxogjapp: IMAGE localhost/lxogjapp:latest (gcc@=11.2.0) BUILT [0:40:34] - - ==> sunflyhd: BUILD python@=3.11.8 ... - ==> sunflyhd: GENERATING SCRIPT ... - ==> sunflyhd: BUILDING ... - ==> sunflyhd: IMAGE localhost/python__3.11.8__x86_64__centos:latest (python@=3.11.8) BUILT [0:23:19] diff --git a/docs/source/starting/index.rst b/docs/source/starting/index.rst index 4c37bb8..9b6b168 100644 --- a/docs/source/starting/index.rst +++ b/docs/source/starting/index.rst @@ -8,5 +8,6 @@ Getting Started .. toctree:: :maxdepth: 2 - basic + setup tutorial + usage diff --git a/docs/source/starting/setup.rst b/docs/source/starting/setup.rst new file mode 100644 index 0000000..ee8b0ab --- /dev/null +++ b/docs/source/starting/setup.rst @@ -0,0 +1,79 @@ + +******** +Overview +******** + +What is Velocity +################ +Velocity is a tool to help with the maintenance of container build scripts on multiple systems, +backends (e.g podman or apptainer) and distros. + +.. important:: + + While Velocity provides a compatibility layer for `Apptainer `_ and + `Podman `_, it is still important to have a basic + knowledge of how they work and the container building process in general. + +How it Works +############ +Velocity works by building a set of containers in a chain so that the final container has all of the needed components. + +.. important:: + + Velocity maintains a very hands off approach. It is only as good as the templates/configuration that you write. + In general it will assume that a particular build will work unless you tell it otherwise. + +.. note:: + + While Velocity has many features that are similar to those provided by a package manager, it is NOT a + package manager. Rather it should be viewed as a templating and build orchestration tool. + +Installation +############ + +The easiest way to install velocity is to install prebuilt python packages using pip. + +.. code-block:: bash + + pip install olcf-velocity + +Alternatively, you can clone the velocity repository and build/install velocity from source. + +.. code-block:: bash + + git clone https://github.com/olcf/velocity.git + cd velocity + pip install build + python3 -m build + # install the built python wheel package the version will depend on what version of velocity you have checked out + # check the dist directory for the exact version + pip install dist/olcf_velocity--py3-none-any.whl + +Now you can use Velocity as a python module! We recommend setting a bash alias for convenience. + +.. code-block:: bash + + $ alias velocity="python3 -m velocity" + $ velocity + usage: velocity [-h] [-v] [-D {TRACE,DEBUG,INFO,SUCCESS,WARNING,ERROR,CRITICAL}] [-b BACKEND] [-s SYSTEM] [-d DISTRO] {build,avail,spec} ... + + build tool for OLCF containers + + positional arguments: + {build,avail,spec} + build build specified container image + avail lookup available images + spec lookup image dependencies + + options: + -h, --help show this help message and exit + -v, --version program version + -D {TRACE,DEBUG,INFO,SUCCESS,WARNING,ERROR,CRITICAL}, --debug {TRACE,DEBUG,INFO,SUCCESS,WARNING,ERROR,CRITICAL} + set debug output level + -b BACKEND, --backend BACKEND + -s SYSTEM, --system SYSTEM + -d DISTRO, --distro DISTRO + + See https://github.com/olcf/velocity + +.. _configuration: diff --git a/docs/source/starting/tutorial.rst b/docs/source/starting/tutorial.rst index d232464..38c6c8f 100644 --- a/docs/source/starting/tutorial.rst +++ b/docs/source/starting/tutorial.rst @@ -4,269 +4,120 @@ Creating Your First Image Base Image ########## -Let's start with a simple base image. This image will pull an fedora docker image and update the packages. For this -tutorial I have created the empty directory ``/tmp/velocity/images`` and configured it as the image directory. I have set -the build directory to ``/tmp/velocity/build``, the backend to ``apptainer`` and the distro as ``fedora``. All -commands are run in ``/tmp/velocity``. -Start by creating a directory in the image directory called ``fedora``. In this directory create a file called +Let's start with a simple base image. This image will pull an opensuse docker image and update the packages. To setup +your environment do something like this. + + +.. code-block:: bash + :caption: Setup + + TUTORIAL_DIR=/tmp/velocity + mkdir -p $TUTORIAL_DIR/images + export VELOCITY_IMAGE_PATH=$TUTORIAL_DIR/images + export VELOCITY_BUILD_DIR=$TUTORIAL_DIR/build + export VELOCITY_DISTRO=opensuse + # all subsequent commands in this tutorial were run from the TUTORIAL_DIR, but they don't have to be + +.. note:: + + You will also need Apptainer installed on your system. + +Next create a directory in the ``images`` directory called ``opensuse``. In this directory create a file called ``specs.yaml`` and a directory called ``templates`` with a file named ``default.vtmp``. Your image directory and files should now look like this. .. code-block:: bash :caption: /tmp/velocity/images - fedora + opensuse ├── specs.yaml └── templates └── default.vtmp .. code-block:: yaml - :caption: specs.yaml + :caption: opensuse/specs.yaml versions: - - spec: 38 - when: distro=fedora + - spec: 15.4 + when: distro=opensuse .. code-block:: text - :caption: default.vtmp + :caption: opensuse/templates/default.vtmp @from - docker.io/fedora:{{ __version__ }} + docker.io/opensuse/leap:{{ __version__ }} @run - dnf -y upgrade - dnf clean all + zypper --non-interactive refresh + zypper --non-interactive update + zypper clean --all Now if you run `velocity avail` you should get the following. .. code-block:: bash - user@hostname:~$ velocity avail - ==> fedora - 38 + $ velocity avail + ==> opensuse + 15.4 Now build the image. .. code-block:: bash - user@hostname:~$ velocity build fedora + $ velocity build opensuse ==> Build Order: - fedora@38-aa51aa7 - - ==> aa51aa7: BUILD fedora@38 ... - ==> aa51aa7: GENERATING SCRIPT ... - ==> aa51aa7: BUILDING ... - ==> aa51aa7: IMAGE /tmp/velocity/build/fedora-38-aa51aa7/aa51aa7.sif (fedora@38) BUILT [0:01:07] - - ==> BUILT: /tmp/velocity/fedora-38__x86_64-fedora.sif + opensuse@15.4-a1913cd -If you wish to see more output you can add the `-v` flag: + ==> a1913cd: BUILD opensuse@15.4 ... + ==> a1913cd: GENERATING SCRIPT ... + ==> a1913cd: BUILDING ... + ==> a1913cd: IMAGE /tmp/velocity/build/opensuse-15.4-a1913cd/a1913cd.sif (opensuse@15.4) BUILT [0:01:03] -.. code-block:: bash + ==> BUILT: /tmp/velocity/opensuse-15.4__frontier-opensuse.sif - user@hostname:~$ velocity build fedora -v - ==> Build Order: - fedora@38-aa51aa7 - - ==> aa51aa7: BUILD fedora@38 ... - ==> aa51aa7: GENERATING SCRIPT ... - SCRIPT: /tmp/velocity/build/fedora-38-aa51aa7/script - Bootstrap: docker - From: docker.io/fedora:38 - - %post - dnf -y upgrade - dnf clean all - ==> aa51aa7: BUILDING ... - #!/usr/bin/env bash - apptainer build --disable-cache /tmp/velocity/build/fedora-38-aa51aa7/aa51aa7.sif /tmp/velocity/build/fedora-38-aa51aa7/script; - Fedora 38 - x86_64 2.3 MB/s | 83 MB 00:35 - Fedora 38 openh264 (From Cisco) - x86_64 2.8 kB/s | 2.6 kB 00:00 - Fedora Modular 38 - x86_64 1.8 MB/s | 2.8 MB 00:01 - Fedora 38 - x86_64 - Updates 2.8 MB/s | 42 MB 00:14 - Fedora Modular 38 - x86_64 - Updates 257 kB/s | 2.2 MB 00:08 - Dependencies resolved. - ================================================================================ - Package Arch Version Repo Size - ================================================================================ - Upgrading: - fedora-release-common noarch 38-37 updates 20 k - fedora-release-container noarch 38-37 updates 10 k - fedora-release-identity-container noarch 38-37 updates 12 k - glibc x86_64 2.37-19.fc38 updates 2.1 M - glibc-common x86_64 2.37-19.fc38 updates 320 k - glibc-minimal-langpack x86_64 2.37-19.fc38 updates 42 k - gnutls x86_64 3.8.5-1.fc38 updates 1.1 M - libnghttp2 x86_64 1.52.0-3.fc38 updates 75 k - python-pip-wheel noarch 22.3.1-4.fc38 updates 1.4 M - python3 x86_64 3.11.9-2.fc38 updates 28 k - python3-libs x86_64 3.11.9-2.fc38 updates 9.6 M - tpm2-tss x86_64 4.0.2-1.fc38 updates 391 k - vim-data noarch 2:9.1.393-1.fc38 updates 23 k - vim-minimal x86_64 2:9.1.393-1.fc38 updates 810 k - Installing weak dependencies: - libxcrypt-compat x86_64 4.4.36-1.fc38 updates 90 k - - Transaction Summary - ================================================================================ - Install 1 Package - Upgrade 14 Packages - - Total download size: 16 M - Downloading Packages: - (1/15): fedora-release-container-38-37.noarch.r 160 kB/s | 10 kB 00:00 - (2/15): fedora-release-common-38-37.noarch.rpm 228 kB/s | 20 kB 00:00 - (3/15): fedora-release-identity-container-38-37 385 kB/s | 12 kB 00:00 - (4/15): libxcrypt-compat-4.4.36-1.fc38.x86_64.r 648 kB/s | 90 kB 00:00 - (5/15): glibc-minimal-langpack-2.37-19.fc38.x86 1.1 MB/s | 42 kB 00:00 - (6/15): glibc-common-2.37-19.fc38.x86_64.rpm 2.4 MB/s | 320 kB 00:00 - (7/15): libnghttp2-1.52.0-3.fc38.x86_64.rpm 1.7 MB/s | 75 kB 00:00 - (8/15): glibc-2.37-19.fc38.x86_64.rpm 8.1 MB/s | 2.1 MB 00:00 - (9/15): python3-3.11.9-2.fc38.x86_64.rpm 686 kB/s | 28 kB 00:00 - (10/15): python-pip-wheel-22.3.1-4.fc38.noarch. 8.8 MB/s | 1.4 MB 00:00 - (11/15): tpm2-tss-4.0.2-1.fc38.x86_64.rpm 6.1 MB/s | 391 kB 00:00 - (12/15): gnutls-3.8.5-1.fc38.x86_64.rpm 3.1 MB/s | 1.1 MB 00:00 - (13/15): vim-data-9.1.393-1.fc38.noarch.rpm 503 kB/s | 23 kB 00:00 - (14/15): vim-minimal-9.1.393-1.fc38.x86_64.rpm 4.3 MB/s | 810 kB 00:00 - (15/15): python3-libs-3.11.9-2.fc38.x86_64.rpm 11 MB/s | 9.6 MB 00:00 - -------------------------------------------------------------------------------- - Total 11 MB/s | 16 MB 00:01 - Running transaction check - Transaction check succeeded. - Running transaction test - Transaction test succeeded. - Running transaction - Preparing : 1/1 - Upgrading : glibc-common-2.37-19.fc38.x86_64 1/29 - Upgrading : glibc-minimal-langpack-2.37-19.fc38.x86_64 2/29 - Running scriptlet: glibc-2.37-19.fc38.x86_64 3/29 - Upgrading : glibc-2.37-19.fc38.x86_64 3/29 - Running scriptlet: glibc-2.37-19.fc38.x86_64 3/29 - Upgrading : fedora-release-identity-container-38-37.noarch 4/29 - Upgrading : fedora-release-container-38-37.noarch 5/29 - Upgrading : fedora-release-common-38-37.noarch 6/29 - Installing : libxcrypt-compat-4.4.36-1.fc38.x86_64 7/29 - Upgrading : python-pip-wheel-22.3.1-4.fc38.noarch 8/29 - Upgrading : python3-3.11.9-2.fc38.x86_64 9/29 - Upgrading : python3-libs-3.11.9-2.fc38.x86_64 10/29 - Upgrading : vim-data-2:9.1.393-1.fc38.noarch 11/29 - Upgrading : vim-minimal-2:9.1.393-1.fc38.x86_64 12/29 - Upgrading : gnutls-3.8.5-1.fc38.x86_64 13/29 - Upgrading : libnghttp2-1.52.0-3.fc38.x86_64 14/29 - Running scriptlet: tpm2-tss-4.0.2-1.fc38.x86_64 15/29 - Upgrading : tpm2-tss-4.0.2-1.fc38.x86_64 15/29 - Cleanup : fedora-release-common-38-36.noarch 16/29 - Cleanup : gnutls-3.8.4-1.fc38.x86_64 17/29 - Cleanup : tpm2-tss-4.0.1-3.fc38.x86_64 18/29 - Cleanup : vim-minimal-2:9.1.309-1.fc38.x86_64 19/29 - Cleanup : libnghttp2-1.52.0-2.fc38.x86_64 20/29 - Cleanup : python3-3.11.8-2.fc38.x86_64 21/29 - Cleanup : fedora-release-container-38-36.noarch 22/29 - Cleanup : fedora-release-identity-container-38-36.noarch 23/29 - Cleanup : vim-data-2:9.1.309-1.fc38.noarch 24/29 - Cleanup : python3-libs-3.11.8-2.fc38.x86_64 25/29 - Cleanup : python-pip-wheel-22.3.1-3.fc38.noarch 26/29 - Cleanup : glibc-2.37-18.fc38.x86_64 27/29 - Cleanup : glibc-minimal-langpack-2.37-18.fc38.x86_64 28/29 - Cleanup : glibc-common-2.37-18.fc38.x86_64 29/29 - Running scriptlet: glibc-common-2.37-18.fc38.x86_64 29/29 - Verifying : libxcrypt-compat-4.4.36-1.fc38.x86_64 1/29 - Verifying : fedora-release-common-38-37.noarch 2/29 - Verifying : fedora-release-common-38-36.noarch 3/29 - Verifying : fedora-release-container-38-37.noarch 4/29 - Verifying : fedora-release-container-38-36.noarch 5/29 - Verifying : fedora-release-identity-container-38-37.noarch 6/29 - Verifying : fedora-release-identity-container-38-36.noarch 7/29 - Verifying : glibc-2.37-19.fc38.x86_64 8/29 - Verifying : glibc-2.37-18.fc38.x86_64 9/29 - Verifying : glibc-common-2.37-19.fc38.x86_64 10/29 - Verifying : glibc-common-2.37-18.fc38.x86_64 11/29 - Verifying : glibc-minimal-langpack-2.37-19.fc38.x86_64 12/29 - Verifying : glibc-minimal-langpack-2.37-18.fc38.x86_64 13/29 - Verifying : gnutls-3.8.5-1.fc38.x86_64 14/29 - Verifying : gnutls-3.8.4-1.fc38.x86_64 15/29 - Verifying : libnghttp2-1.52.0-3.fc38.x86_64 16/29 - Verifying : libnghttp2-1.52.0-2.fc38.x86_64 17/29 - Verifying : python-pip-wheel-22.3.1-4.fc38.noarch 18/29 - Verifying : python-pip-wheel-22.3.1-3.fc38.noarch 19/29 - Verifying : python3-3.11.9-2.fc38.x86_64 20/29 - Verifying : python3-3.11.8-2.fc38.x86_64 21/29 - Verifying : python3-libs-3.11.9-2.fc38.x86_64 22/29 - Verifying : python3-libs-3.11.8-2.fc38.x86_64 23/29 - Verifying : tpm2-tss-4.0.2-1.fc38.x86_64 24/29 - Verifying : tpm2-tss-4.0.1-3.fc38.x86_64 25/29 - Verifying : vim-data-2:9.1.393-1.fc38.noarch 26/29 - Verifying : vim-data-2:9.1.309-1.fc38.noarch 27/29 - Verifying : vim-minimal-2:9.1.393-1.fc38.x86_64 28/29 - Verifying : vim-minimal-2:9.1.309-1.fc38.x86_64 29/29 - - Upgraded: - fedora-release-common-38-37.noarch - fedora-release-container-38-37.noarch - fedora-release-identity-container-38-37.noarch - glibc-2.37-19.fc38.x86_64 - glibc-common-2.37-19.fc38.x86_64 - glibc-minimal-langpack-2.37-19.fc38.x86_64 - gnutls-3.8.5-1.fc38.x86_64 - libnghttp2-1.52.0-3.fc38.x86_64 - python-pip-wheel-22.3.1-4.fc38.noarch - python3-3.11.9-2.fc38.x86_64 - python3-libs-3.11.9-2.fc38.x86_64 - tpm2-tss-4.0.2-1.fc38.x86_64 - vim-data-2:9.1.393-1.fc38.noarch - vim-minimal-2:9.1.393-1.fc38.x86_64 - Installed: - libxcrypt-compat-4.4.36-1.fc38.x86_64 - - Complete! - 42 files removed - ==> aa51aa7: IMAGE /tmp/velocity/build/fedora-38-aa51aa7/aa51aa7.sif (fedora@38) BUILT [0:01:33] - - ==> BUILT: /tmp/velocity/fedora-38__x86_64-fedora.sif +If you wish to see more output you can add the ``-v`` flag to the build command. Adding Different Versions ######################### -So now we have a base Fedora image. That's great but before we move on let's make some different versions of the image -so that we have more options for building later. Edit the fedora ``specs.yaml`` and add some versions. +So now we have a base opensuse image. That's great but before we move on let's make some different versions of the image +so that we have more options for building later. Edit the opensuse ``specs.yaml`` and add some versions. .. code-block:: yaml :caption: spec.yaml versions: - spec: - - 38 - - 39 - - 40 - - 41 - when: distro=fedora + - 15.4 + - 15.5 + - 15.6 + when: distro=opensuse .. code-block:: bash - user@hostname:~$ velocity avail - ==> fedora - 38 - 39 - 40 - 41 + $ velocity avail + ==> opensuse + 15.4 + 15.5 + 15.6 Specifying Version ################## When building an image Velocity will default to the latest image. To specify a version use ``@`` e.g. -``fedora@40``. Versions take the form ``..-``. You can also specify greater than, less +``opensuse@15.6``. Versions take the form ``..-``. You can also specify greater than, less than, and in-between via ``@:``, ``@:`` and ``@:`` respectively. Hello World! ############ -Now let's get a little more complicated. Let's create an image that runs a python script which prints hello world. You +Now let's get a little more complicated. Let's create an image that runs a python script which prints ``Hello, World!``. You can give it whatever version you want: .. code-block:: bash :caption: /tmp/velocity/images - fedora + opensuse ├── specs.yaml └── templates └── default.vtmp @@ -279,27 +130,27 @@ can give it whatever version you want: Notice that now there is a new folder called ``files`` with a python script in it. -.. code-block:: bash - :caption: hello_world.py +.. code-block:: python + :caption: hello-world/files/hello_world.py #!/usr/bin/env python3 print("Hello, World!") .. code-block:: yaml - :caption: specs.yaml + :caption: hello-world/specs.yaml versions: - spec: 1.0 dependencies: - - spec: fedora - when: distro=fedora + - spec: opensuse + when: distro=opensuse files: - name: hello_world.py .. code-block:: text - :caption: default.vtmp + :caption: hello-world/templates/default.vtmp @from {{ __base__ }} @@ -308,7 +159,7 @@ Notice that now there is a new folder called ``files`` with a python script in i hello_world.py /hello_world @run - dnf -y install python3 + zypper --non-interactive install python3 chmod +x /hello_world @entry @@ -317,203 +168,454 @@ Notice that now there is a new folder called ``files`` with a python script in i .. code-block:: bash - user@hostname:~$ velocity avail - ==> fedora - 38 - 39 - 40 - 41 + $ velocity avail ==> hello-world 1.0 + ==> opensuse + 15.4 + 15.5 + 15.6 + +.. code-block:: bash + + $ velocity build hello-world -v + ==> Build Order: + opensuse@15.6-59edd44 + hello-world@1.0-a167014 + + ==> 59edd44: BUILD opensuse@15.6 ... + ==> 59edd44: GENERATING SCRIPT ... + ==> 59edd44: BUILDING ... + ==> 59edd44: IMAGE /tmp/velocity/build/opensuse-15.6-59edd44/59edd44.sif (opensuse@15.6) BUILT [0:00:36] + + ==> a167014: BUILD hello-world@1.0 ... + ==> a167014: COPYING FILES ... + ==> a167014: GENERATING SCRIPT ... + ==> a167014: BUILDING ... + ==> a167014: IMAGE /tmp/velocity/build/hello-world-1.0-a167014/a167014.sif (hello-world@1.0) BUILT [0:00:27] + + ==> BUILT: /tmp/velocity/hello-world-1.0_opensuse-15.6__frontier-opensuse.sif + +Our hello-world image has been built! + +.. code-block:: bash + :emphasize-lines: 6 + + $ ls -al + total 207020 + drwxr-xr-x 4 xxx xxx 120 Sep 25 10:44 . + drwxrwxrwt 33550 root root 761680 Sep 25 10:45 .. + drwxr-xr-x 5 xxx xxx 100 Sep 25 10:44 build + -rwxr-xr-x 1 xxx xxx 167243776 Sep 25 10:44 hello-world-1.0_opensuse-15.6__frontier-opensuse.sif + drwxr-xr-x 4 xxx xxx 80 Sep 25 10:42 images + -rwxr-xr-x 1 xxx xxx 44744704 Sep 25 10:39 opensuse-15.4__frontier-opensuse.sif + +Now you can run the image! + +.. code-block:: bash + + $ apptainer run hello-world-*-opensuse.sif # replace * with the specifics of your build + Hello, World! + +OLCF Images +########### + +Let's extend what we have done so far and explore some more features of Velocity using a base set of image definitions +provided at https://github.com/olcf/velocity-images. Clone the repository and run: + +.. warning:: + + You will need to delete the ``opensuse`` image that you made or it will conflict with the OLCF image; however, + leave your ``hello-world`` image because we will use it. + +.. code-block:: bash + + export VELOCITY_IMAGE_PATH=:$VELOCITY_IMAGE_PATH + +Let's check what images are available now. + +.. note:: + + Due to updates to https://github.com/olcf/velocity-images the output shown below may be different for you. + +.. code-block:: bash + + $ velocity avail + ==> gcc + 12.3.0 + 13.2.0 + 14.1.0 + ==> llvm + 17.0.0 + 17.0.6 + ==> mpich + 3.4.3 + ==> opensuse + 15.4 + 15.5 + 15.6 + ==> rocm + 5.7.1 + 6.0.1 + 6.1.3 + +If you were to look at the contents of https://github.com/olcf/velocity-images you would notice that there is a +folder in it defining an ``ubuntu`` image. Why does that image not show up? At the beginning of this tutorial +we set ``export VELOCITY_DISTRO=opensuse``. In the ``ubuntu`` ``specs.yaml`` file you would see: + +.. code-block:: yaml + + versions: + - spec: + - 20.04 + - 22.04 + - 24.04 + when: distro=ubuntu + +The ``when: distro=ubuntu`` means that the defined versions will not show up unless the distro is set to ``ubuntu``. +Run the following command and compare the difference. + +.. code-block:: bash + + $ velocity -d ubuntu avail + ==> gcc + 12.3.0 + 13.2.0 + 14.1.0 + ==> hello-world + 1.0 + ==> llvm + 17.0.0 + 17.0.6 + ==> mpich + 3.4.3 + ==> rocm + 5.7.1 + 6.0.1 + 6.1.3 + ==> ubuntu + 20.04 + 22.04 + 24.04 + +.. important:: + + This is important because it keeps us from trying to build a container with two distros, but it may catch you off guard + by hiding images you thought you had defined. + +Now let try building our ``hello-world`` image on an ``ubuntu`` base. In the current state the build will fail but let's +run it anyway and trouble shoot it. + +.. code-block:: bash + + $ velocity -d ubuntu build hello-world + ==> Build Order: + hello-world@1.0-7562a9e + + ==> 7562a9e: BUILD hello-world@1.0 ... + ==> 7562a9e: COPYING FILES ... + ==> 7562a9e: GENERATING SCRIPT ... + Traceback (most recent call last): + File "/ccs/home/xxx/.conda/envs/main_x86_64/lib/python3.11/site-packages/velocity/_backends.py", line 131, in generate_script + if len(sections["@from"]) != 1: + ~~~~~~~~^^^^^^^^^ + KeyError: '@from' + + During handling of the above exception, another exception occurred: + + Traceback (most recent call last): + File "", line 198, in _run_module_as_main + File "", line 88, in _run_code + File "/ccs/home/xxx/.conda/envs/main_x86_64/lib/python3.11/site-packages/velocity/__main__.py", line 111, in + builder.build() + File "/ccs/home/xxx/.conda/envs/main_x86_64/lib/python3.11/site-packages/velocity/_build.py", line 128, in build + self._build_image(u, last, name) + File "/ccs/home/xxx/.conda/envs/main_x86_64/lib/python3.11/site-packages/velocity/_build.py", line 223, in _build_image + script = self.backend_engine.generate_script(unit, script_variables) + ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + File "/ccs/home/xxx/.conda/envs/main_x86_64/lib/python3.11/site-packages/velocity/_backends.py", line 140, in generate_script + raise TemplateSyntaxError("You must have an @from section in your template!") + velocity._exceptions.TemplateSyntaxError: You must have an @from section in your template! + +We see that an error occurred in the ``GENERATING SCRIPT`` section. But if we look under ``==> Build Order`` at the top +we will notice the real cause. The ``ubuntu`` image is not being built. This causes the error in script generation +because in our ``default.vtmp`` for ``hello-world`` we have ``{{ __base__ }}`` defined in our ``@from`` section which +looks for a previous image to build on. Let's edit our ``hello-world`` ``specs.yaml``. It should look like this. + +.. code-block:: yaml + :caption: hello-world/specs.yaml + :emphasize-lines: 6-7 + + versions: + - spec: 1.0 + dependencies: + - spec: opensuse + when: distro=opensuse + - spec: ubuntu + when: distro=ubuntu + files: + - name: hello_world.py + +Under the ``dependencies`` section we added the ``ubuntu`` image, but we specified it should only be a dependency when +our distro is set to ubuntu. You can test that Velocity is now adding ``ubuntu`` as a dependency by running: + +.. code-block:: bash + + $ velocity -d ubuntu spec hello-world + > hello-world@1.0-f6bfef8 + ^ubuntu@24.04-ce71495 + +Now we can try to build again, but it will fail with a new error. + +.. code-block:: bash + + $ velocity -d ubuntu build hello-world + ==> Build Order: + ubuntu@24.04-043b176 + hello-world@1.0-9dcbb36 + + ==> 043b176: BUILD ubuntu@24.04 ... + ==> 043b176: GENERATING SCRIPT ... + ==> 043b176: BUILDING ... + ==> 043b176: IMAGE /tmp/velocity/build/ubuntu-24.04-043b176/043b176.sif (ubuntu@24.04) BUILT [0:00:11] + + ==> 9dcbb36: BUILD hello-world@1.0 ... + ==> 9dcbb36: COPYING FILES ... + ==> 9dcbb36: GENERATING SCRIPT ... + ==> 9dcbb36: BUILDING ... + INFO: User not listed in /etc/subuid, trying root-mapped namespace + INFO: The %post section will be run under fakeroot + INFO: Starting build... + INFO: Verifying bootstrap image /tmp/velocity/build/ubuntu-24.04-043b176/043b176.sif + INFO: Copying hello_world.py to /hello_world + INFO: Running post scriptlet + + zypper --non-interactive install python3 + /.post.script: 1: zypper: not found + FATAL: While performing build: while running engine: exit status 127 + +Velocity prints out the error from the build ``zypper: not found``. Lets look back at the :doc:`vtmp ` +script we wrote for ``hello-world``. Under the ``@run`` section we had: + +.. code-block:: text + + @run + zypper --non-interactive install python3 + chmod +x /hello_world + +We used zypper to install python because it is not installed in the opensuse docker image by default. We need to edit this +script to support ``ubuntu``. Change the ``@run`` section to: + +.. code-block:: text + + @run + ?? distro=opensuse |> zypper --non-interactive install python3 ?? + ?? distro=ubuntu |> apt -y install python3 ?? + chmod +x /hello_world + +Now we can test by doing a verbose dry-run for ``opensuse`` and ``ubuntu``. .. code-block:: bash + :emphasize-lines: 33 + :caption: opensuse - user@hostname:~$ velocity build hello-world -v + $ velocity build hello-world -dv ==> Build Order: - fedora@41-8a9a360 - hello-world@1.0-de9c02b + opensuse@15.6-90ac66d + hello-world@1.0-5fa2515 - ==> 8a9a360: BUILD fedora@41 ... - ==> 8a9a360: GENERATING SCRIPT ... - SCRIPT: /tmp/velocity/build/fedora-41-8a9a360/script + ==> 90ac66d: BUILD opensuse@15.6 --DRY-RUN ... + ==> 90ac66d: GENERATING SCRIPT ... + SCRIPT: /tmp/velocity/build/opensuse-15.6-90ac66d/script Bootstrap: docker - From: docker.io/fedora:41 + From: docker.io/opensuse/leap:15.6 %post - dnf -y upgrade - dnf clean all - ==> 8a9a360: BUILDING ... + zypper --non-interactive refresh + zypper --non-interactive update + zypper clean --all + ==> 90ac66d: BUILDING ... #!/usr/bin/env bash - apptainer build --disable-cache /tmp/velocity/build/fedora-41-8a9a360/8a9a360.sif /tmp/velocity/build/fedora-41-8a9a360/script; - Updating and loading repositories: - Fedora 41 openh264 (From Cisco) - x86_ 100% | 6.5 KiB/s | 4.8 KiB | 00m01s - Fedora 41 - x86_64 - Test Updates 100% | 1.8 MiB/s | 3.4 MiB | 00m02s - Fedora 41 - x86_64 100% | 13.9 MiB/s | 35.9 MiB | 00m03s - Fedora 41 - x86_64 - Updates 100% | 50.3 KiB/s | 31.9 KiB | 00m01s - Repositories loaded. - Package Arch Version Repository Size - Upgrading: - libgcc x86_64 14.2.1-3.fc41 updates-testing 274.6 KiB - replacing libgcc x86_64 14.2.1-1.fc41 34086d2996104518800c8d7dcc6139a1 274.6 KiB - libgomp x86_64 14.2.1-3.fc41 updates-testing 523.5 KiB - replacing libgomp x86_64 14.2.1-1.fc41 34086d2996104518800c8d7dcc6139a1 523.4 KiB - libstdc++ x86_64 14.2.1-3.fc41 updates-testing 2.8 MiB - replacing libstdc++ x86_64 14.2.1-1.fc41 34086d2996104518800c8d7dcc6139a1 2.8 MiB - openssl-libs x86_64 1:3.2.2-7.fc41 updates-testing 7.8 MiB - replacing openssl-libs x86_64 1:3.2.2-5.fc41 34086d2996104518800c8d7dcc6139a1 7.8 MiB - rpm x86_64 4.19.94-1.fc41 updates-testing 3.1 MiB - replacing rpm x86_64 4.19.92-6.fc41 34086d2996104518800c8d7dcc6139a1 3.1 MiB - rpm-build-libs x86_64 4.19.94-1.fc41 updates-testing 206.7 KiB - replacing rpm-build-libs x86_64 4.19.92-6.fc41 34086d2996104518800c8d7dcc6139a1 206.7 KiB - rpm-libs x86_64 4.19.94-1.fc41 updates-testing 721.9 KiB - replacing rpm-libs x86_64 4.19.92-6.fc41 34086d2996104518800c8d7dcc6139a1 721.9 KiB - systemd-libs x86_64 256.6-1.fc41 updates-testing 2.0 MiB - replacing systemd-libs x86_64 256.5-1.fc41 34086d2996104518800c8d7dcc6139a1 2.0 MiB - zlib-ng-compat x86_64 2.1.7-3.fc41 updates-testing 134.0 KiB - replacing zlib-ng-compat x86_64 2.1.7-2.fc41 34086d2996104518800c8d7dcc6139a1 134.0 KiB - - Transaction Summary: - Upgrading: 9 packages - Replacing: 9 packages - - Total size of inbound packages is 5 MiB. Need to download 5 MiB. - After this operation 2 KiB will be used (install 17 MiB, remove 17 MiB). - [1/9] libgcc-0:14.2.1-3.fc41.x86_64 100% | 132.2 KiB/s | 133.3 KiB | 00m01s - [2/9] libstdc++-0:14.2.1-3.fc41.x86_64 100% | 583.3 KiB/s | 887.8 KiB | 00m02s - [3/9] libgomp-0:14.2.1-3.fc41.x86_64 100% | 208.5 KiB/s | 354.1 KiB | 00m02s - [4/9] rpm-0:4.19.94-1.fc41.x86_64 100% | 1.6 MiB/s | 547.6 KiB | 00m00s - [5/9] rpm-build-libs-0:4.19.94-1.fc41.x 100% | 2.1 MiB/s | 99.1 KiB | 00m00s - [6/9] openssl-libs-1:3.2.2-7.fc41.x86_6 100% | 2.6 MiB/s | 2.3 MiB | 00m01s - [7/9] rpm-libs-0:4.19.94-1.fc41.x86_64 100% | 1.1 MiB/s | 309.5 KiB | 00m00s - [8/9] zlib-ng-compat-0:2.1.7-3.fc41.x86 100% | 1.0 MiB/s | 77.7 KiB | 00m00s - [9/9] systemd-libs-0:256.6-1.fc41.x86_6 100% | 2.6 MiB/s | 730.9 KiB | 00m00s - -------------------------------------------------------------------------------- - [9/9] Total 100% | 2.2 MiB/s | 5.4 MiB | 00m02s - Running transaction - [ 1/20] Verify package files 100% | 750.0 B/s | 9.0 B | 00m00s - [ 2/20] Prepare transaction 100% | 1.6 KiB/s | 18.0 B | 00m00s - [ 3/20] Upgrading libgcc-0:14.2.1-3.fc4 100% | 14.2 MiB/s | 276.3 KiB | 00m00s - >>> Running post-install scriptlet: libgcc-0:14.2.1-3.fc41.x86_64 - >>> Stop post-install scriptlet: libgcc-0:14.2.1-3.fc41.x86_64 - [ 4/20] Upgrading zlib-ng-compat-0:2.1. 100% | 32.9 MiB/s | 134.8 KiB | 00m00s - [ 5/20] Upgrading rpm-libs-0:4.19.94-1. 100% | 117.7 MiB/s | 723.4 KiB | 00m00s - [ 6/20] Upgrading libgomp-0:14.2.1-3.fc 100% | 170.8 MiB/s | 524.8 KiB | 00m00s - [ 7/20] Upgrading rpm-build-libs-0:4.19 100% | 15.6 MiB/s | 207.5 KiB | 00m00s - >>> Running pre-install scriptlet: rpm-0:4.19.94-1.fc41.x86_64 - >>> Stop pre-install scriptlet: rpm-0:4.19.94-1.fc41.x86_64 - [ 8/20] Upgrading rpm-0:4.19.94-1.fc41. 100% | 104.3 MiB/s | 2.5 MiB | 00m00s - [ 9/20] Upgrading openssl-libs-1:3.2.2- 100% | 190.9 MiB/s | 7.8 MiB | 00m00s - [10/20] Upgrading libstdc++-0:14.2.1-3. 100% | 145.6 MiB/s | 2.8 MiB | 00m00s - [11/20] Upgrading systemd-libs-0:256.6- 100% | 135.3 MiB/s | 2.0 MiB | 00m00s - [12/20] Erasing rpm-build-libs-0:4.19.9 100% | 1.0 KiB/s | 5.0 B | 00m00s - [13/20] Erasing libstdc++-0:14.2.1-1.fc 100% | 6.1 KiB/s | 31.0 B | 00m00s - [14/20] Erasing systemd-libs-0:256.5-1. 100% | 2.4 KiB/s | 20.0 B | 00m00s - [15/20] Erasing rpm-0:4.19.92-6.fc41.x8 100% | 26.7 KiB/s | 273.0 B | 00m00s - [16/20] Erasing rpm-libs-0:4.19.92-6.fc 100% | 2.4 KiB/s | 10.0 B | 00m00s - [17/20] Erasing openssl-libs-1:3.2.2-5. 100% | 9.5 KiB/s | 39.0 B | 00m00s - [18/20] Erasing zlib-ng-compat-0:2.1.7- 100% | 1.2 KiB/s | 5.0 B | 00m00s - [19/20] Erasing libgcc-0:14.2.1-1.fc41. 100% | 647.0 B/s | 11.0 B | 00m00s - >>> Running post-uninstall scriptlet: libgcc-0:14.2.1-1.fc41.x86_64 - >>> Stop post-uninstall scriptlet: libgcc-0:14.2.1-1.fc41.x86_64 - [20/20] Erasing libgomp-0:14.2.1-1.fc41 100% | 43.0 B/s | 9.0 B | 00m00s - >>> Running post-transaction scriptlet: rpm-0:4.19.94-1.fc41.x86_64 - >>> Stop post-transaction scriptlet: rpm-0:4.19.94-1.fc41.x86_64 - >>> Running trigger-install scriptlet: glibc-common-0:2.40-3.fc41.x86_64 - >>> Stop trigger-install scriptlet: glibc-common-0:2.40-3.fc41.x86_64 - >>> Running trigger-post-uninstall scriptlet: glibc-common-0:2.40-3.fc41.x86_64 - >>> Stop trigger-post-uninstall scriptlet: glibc-common-0:2.40-3.fc41.x86_64 - Complete! - Removed 24 files, 13 directories. 0 errors occurred. - ==> 8a9a360: IMAGE /tmp/velocity/build/fedora-41-8a9a360/8a9a360.sif (fedora@41) BUILT [0:00:21] - - ==> de9c02b: BUILD hello-world@1.0 ... - ==> de9c02b: COPYING FILES ... - FILE: /tmp/velocity/images/hello-world/files/hello_world.py -> /tmp/velocity/build/hello-world-1.0-de9c02b/hello_world.py - ==> de9c02b: GENERATING SCRIPT ... - SCRIPT: /tmp/velocity/build/hello-world-1.0-de9c02b/script + apptainer build --disable-cache /tmp/velocity/build/opensuse-15.6-90ac66d/90ac66d.sif /tmp/velocity/build/opensuse-15.6-90ac66d/script; + ==> 90ac66d: IMAGE /tmp/velocity/build/opensuse-15.6-90ac66d/90ac66d.sif (opensuse@15.6) BUILT [0:00:00] + + ==> 5fa2515: BUILD hello-world@1.0 --DRY-RUN ... + ==> 5fa2515: COPYING FILES ... + FILE: /tmp/velocity/images/hello-world/files/hello_world.py -> /tmp/velocity/build/hello-world-1.0-5fa2515/hello_world.py + ==> 5fa2515: GENERATING SCRIPT ... + SCRIPT: /tmp/velocity/build/hello-world-1.0-5fa2515/script Bootstrap: localimage - From: /tmp/velocity/build/fedora-41-8a9a360/8a9a360.sif + From: /tmp/velocity/build/opensuse-15.6-90ac66d/90ac66d.sif %files hello_world.py /hello_world %post - dnf -y install python3 + zypper --non-interactive install python3 chmod +x /hello_world %runscript /hello_world - ==> de9c02b: BUILDING ... + ==> 5fa2515: BUILDING ... #!/usr/bin/env bash - apptainer build --disable-cache /tmp/velocity/build/hello-world-1.0-de9c02b/de9c02b.sif /tmp/velocity/build/hello-world-1.0-de9c02b/script; - Updating and loading repositories: - Fedora 41 openh264 (From Cisco) - x86_ 100% | 11.1 KiB/s | 6.0 KiB | 00m01s - Fedora 41 - x86_64 100% | 11.7 MiB/s | 35.4 MiB | 00m03s - Fedora 41 - x86_64 - Updates 100% | 50.1 KiB/s | 31.9 KiB | 00m01s - Fedora 41 - x86_64 - Test Updates 100% | 1.8 MiB/s | 2.1 MiB | 00m01s - Repositories loaded. - Package Arch Version Repository Size - Installing: - python3 x86_64 3.13.0~rc2-1.fc41 fedora 31.8 KiB - Installing dependencies: - expat x86_64 2.6.3-1.fc41 updates-testing 291.5 KiB - libb2 x86_64 0.98.1-12.fc41 fedora 42.2 KiB - mpdecimal x86_64 2.5.1-16.fc41 fedora 204.9 KiB - python-pip-wheel noarch 24.2-1.fc41 fedora 1.2 MiB - python3-libs x86_64 3.13.0~rc2-1.fc41 fedora 40.3 MiB - Installing weak dependencies: - python-unversioned-command noarch 3.13.0~rc2-1.fc41 fedora 23.0 B - - Transaction Summary: - Installing: 7 packages - - Total size of inbound packages is 11 MiB. Need to download 11 MiB. - After this operation 42 MiB will be used (install 42 MiB, remove 0 B). - [1/7] libb2-0:0.98.1-12.fc41.x86_64 100% | 94.1 KiB/s | 25.7 KiB | 00m00s - [2/7] python3-0:3.13.0~rc2-1.fc41.x86_6 100% | 95.9 KiB/s | 27.4 KiB | 00m00s - [3/7] mpdecimal-0:2.5.1-16.fc41.x86_64 100% | 408.0 KiB/s | 89.0 KiB | 00m00s - [4/7] expat-0:2.6.3-1.fc41.x86_64 100% | 447.4 KiB/s | 114.1 KiB | 00m00s - [5/7] python-pip-wheel-0:24.2-1.fc41.no 100% | 2.5 MiB/s | 1.2 MiB | 00m00s - [6/7] python-unversioned-command-0:3.13 100% | 125.1 KiB/s | 10.5 KiB | 00m00s - [7/7] python3-libs-0:3.13.0~rc2-1.fc41. 100% | 8.1 MiB/s | 9.1 MiB | 00m01s - -------------------------------------------------------------------------------- - [7/7] Total 100% | 6.7 MiB/s | 10.6 MiB | 00m02s - Running transaction - [1/9] Verify package files 100% | 269.0 B/s | 7.0 B | 00m00s - [2/9] Prepare transaction 100% | 280.0 B/s | 7.0 B | 00m00s - [3/9] Installing expat-0:2.6.3-1.fc41.x 100% | 71.7 MiB/s | 293.6 KiB | 00m00s - [4/9] Installing python-pip-wheel-0:24. 100% | 310.4 MiB/s | 1.2 MiB | 00m00s - [5/9] Installing mpdecimal-0:2.5.1-16.f 100% | 50.3 MiB/s | 206.0 KiB | 00m00s - [6/9] Installing libb2-0:0.98.1-12.fc41 100% | 4.7 MiB/s | 43.3 KiB | 00m00s - [7/9] Installing python3-libs-0:3.13.0~ 100% | 139.9 MiB/s | 40.7 MiB | 00m00s - [8/9] Installing python3-0:3.13.0~rc2-1 100% | 10.9 MiB/s | 33.6 KiB | 00m00s - [9/9] Installing python-unversioned-com 100% | 1.8 KiB/s | 424.0 B | 00m00s - >>> Running trigger-install scriptlet: glibc-common-0:2.40-3.fc41.x86_64 - >>> Stop trigger-install scriptlet: glibc-common-0:2.40-3.fc41.x86_64 - Complete! - ==> de9c02b: IMAGE /tmp/velocity/build/hello-world-1.0-de9c02b/de9c02b.sif (hello-world@1.0) BUILT [0:00:14] - - ==> BUILT: /tmp/velocity/hello-world-1.0_fedora-41__x86_64-fedora.sif + apptainer build --disable-cache /tmp/velocity/build/hello-world-1.0-5fa2515/5fa2515.sif /tmp/velocity/build/hello-world-1.0-5fa2515/script; + ==> 5fa2515: IMAGE /tmp/velocity/build/hello-world-1.0-5fa2515/5fa2515.sif (hello-world@1.0) BUILT [0:00:00] - -Our hello-world image has been built! + ==> BUILT: /tmp/velocity/hello-world-1.0_opensuse-15.6__frontier-opensuse.sif .. code-block:: bash - :emphasize-lines: 7 + :emphasize-lines: 37 + :caption: ubuntu - user@hostname:~$ ls - total 190972 - drwxr-xr-x 4 xjv users 4096 Sep 18 10:01 . - drwxrwxrwt 31 root root 131072 Sep 18 10:01 .. - drwxr-xr-x 4 xjv users 4096 Sep 18 10:01 build - -rwxr-xr-x 1 xjv users 66007040 Sep 18 09:42 fedora-38__x86_64-fedora.sif - -rwxr-xr-x 1 xjv users 129392640 Sep 18 10:01 hello-world-1.0_fedora-41__x86_64-fedora.sif - drwxr-xr-x 4 xjv users 4096 Sep 18 09:44 images + $ velocity -d ubuntu build hello-world -dv + ==> Build Order: + ubuntu@24.04-ce71495 + hello-world@1.0-b03891d + ==> ce71495: BUILD ubuntu@24.04 --DRY-RUN ... + ==> ce71495: GENERATING SCRIPT ... + SCRIPT: /tmp/velocity/build/ubuntu-24.04-ce71495/script + Bootstrap: docker + From: docker.io/ubuntu:24.04 -Now you can run the image! + %post + export DEBIAN_FRONTEND="noninteractive" + apt -y update + apt -y upgrade + apt clean + + %environment + export DEBIAN_FRONTEND="noninteractive" + ==> ce71495: BUILDING ... + #!/usr/bin/env bash + apptainer build --disable-cache /tmp/velocity/build/ubuntu-24.04-ce71495/ce71495.sif /tmp/velocity/build/ubuntu-24.04-ce71495/script; + ==> ce71495: IMAGE /tmp/velocity/build/ubuntu-24.04-ce71495/ce71495.sif (ubuntu@24.04) BUILT [0:00:00] + + ==> b03891d: BUILD hello-world@1.0 --DRY-RUN ... + ==> b03891d: COPYING FILES ... + FILE: /tmp/velocity/images/hello-world/files/hello_world.py -> /tmp/velocity/build/hello-world-1.0-b03891d/hello_world.py + ==> b03891d: GENERATING SCRIPT ... + SCRIPT: /tmp/velocity/build/hello-world-1.0-b03891d/script + Bootstrap: localimage + From: /tmp/velocity/build/ubuntu-24.04-ce71495/ce71495.sif + + %files + hello_world.py /hello_world + + %post + apt -y install python3 + chmod +x /hello_world + + %runscript + /hello_world + ==> b03891d: BUILDING ... + #!/usr/bin/env bash + apptainer build --disable-cache /tmp/velocity/build/hello-world-1.0-b03891d/b03891d.sif /tmp/velocity/build/hello-world-1.0-b03891d/script; + ==> b03891d: IMAGE /tmp/velocity/build/hello-world-1.0-b03891d/b03891d.sif (hello-world@1.0) BUILT [0:00:00] + + ==> BUILT: /tmp/velocity/hello-world-1.0_ubuntu-24.04__x86_64-ubuntu.sif + +We can see that each build uses the correct command to install python. Now we can actually build the image. .. code-block:: bash - user@hostname:~$ apptainer run hello-world-1.0_fedora-41__x86_64-fedora.sif - Hello, World! + $ velocity -d ubuntu build hello-world + ==> Build Order: + ubuntu@24.04-ce71495 + hello-world@1.0-b03891d + + ==> ce71495: BUILD ubuntu@24.04 ... + ==> ce71495: GENERATING SCRIPT ... + ==> ce71495: BUILDING ... + ==> ce71495: IMAGE /tmp/velocity/build/ubuntu-24.04-ce71495/ce71495.sif (ubuntu@24.04) BUILT [0:00:00] + + ==> b03891d: BUILD hello-world@1.0 ... + ==> b03891d: COPYING FILES ... + ==> b03891d: GENERATING SCRIPT ... + ==> b03891d: BUILDING ... + ==> b03891d: IMAGE /tmp/velocity/build/hello-world-1.0-b03891d/b03891d.sif (hello-world@1.0) BUILT [0:00:09] + + ==> BUILT: /tmp/velocity/hello-world-1.0_ubuntu-24.04__x86_64-ubuntu.sif + +This example is a demonstration of one of the major strengths of Velocity. The ``hello-world`` image can now be built +on any version of ``opensuse`` or ``ubuntu``, but instead of having a separate script for each combination of version and distro we have +just three. One for ``opensuse``, one for ``ubuntu`` and one for ``hello-world``. This may not seem like a big win for an +example like ``hello-world``; however, this becomes a big win for images like the ``gcc`` image in +https://github.com/olcf/velocity-images. If you look at the ``gcc`` image ``default.vtmp`` script you will see that it can +build practically any version of gcc on ``ubuntu``, ``opensuse`` and ``rockylinux``. + +The last thing we need to look at for this tutorial is Velocity's support for multiple container backends. Let's look at +a dry-run example of the ``opensuse`` image that we have been building with ``apptainer``. + +.. code-block:: + :emphasize-lines: 8-14,17,20 + + $ velocity build opensuse -vd + ==> Build Order: + opensuse@15.6-01205e8 + + ==> 01205e8: BUILD opensuse@15.6 --DRY-RUN ... + ==> 01205e8: GENERATING SCRIPT ... + SCRIPT: /tmp/xxx/velocity/opensuse-15.6-01205e8/script + Bootstrap: docker + From: docker.io/opensuse/leap:15.6 + + %post + zypper --non-interactive refresh + zypper --non-interactive update + zypper clean --all + ==> 01205e8: BUILDING ... + #!/usr/bin/env bash + apptainer build --disable-cache /tmp/xxx/velocity/opensuse-15.6-01205e8/01205e8.sif /tmp/xxx/velocity/opensuse-15.6-01205e8/script; + ==> 01205e8: IMAGE /tmp/xxx/velocity/opensuse-15.6-01205e8/01205e8.sif (opensuse@15.6) BUILT [0:00:00] + + ==> BUILT: /tmp/opensuse-15.6__x86_64-opensuse.sif + +Next let's look at the same thing but with the backend set to ``podman``. + +.. warning:: + + If Podman is not installed this will fail. Conversely, if you are on a system that does not have Apptainer + installed, ``build`` commands using Apptainer will fail. + +.. code-block:: + :emphasize-lines: 8-12,15,18 + + $ velocity -b podman build opensuse -vd + ==> Build Order: + opensuse@15.6-dd91fe3 + + ==> dd91fe3: BUILD opensuse@15.6 --DRY-RUN ... + ==> dd91fe3: GENERATING SCRIPT ... + SCRIPT: /tmp/xxx/velocity/opensuse-15.6-dd91fe3/script + FROM docker.io/opensuse/leap:15.6 + + RUN zypper --non-interactive refresh && \ + zypper --non-interactive update && \ + zypper clean --all + ==> dd91fe3: BUILDING ... + #!/usr/bin/env bash + podman build -f /tmp/xxx/velocity/opensuse-15.6-dd91fe3/script -t localhost/dd91fe3:latest .; + ==> dd91fe3: IMAGE localhost/dd91fe3:latest (opensuse@15.6) BUILT [0:00:00] + + ==> BUILT: localhost/opensuse-15.6__x86_64-opensuse:latest + +As you can see Velocity automatically renders the scripts to the correct format and changes the build commands +to use Podman. Amazing!!! + +One last note about debugging builds with Velocity. We set ``VELOCITY_BUILD_DIR`` at the beginning of this tutorial. +If you look in the directory that it points to you will find a folder for each image that was built. Each folder +contains the rendered script, build log, files generated by the build (e.g SIF files), build commands, and any files +that were needed for the build (e.g. ``hello_world.py``). All of these can be very useful for debugging a build. +One very helpful feature is that the build of an image can be run manually by running the ``build`` script in a folder. + +.. code-block:: bash + :caption: Build Directory Contents + + . + ├── hello-world-1.0-0ff1ff7 + │ ├── 0ff1ff7.sif + │ ├── build + │ ├── hello_world.py + │ ├── log + │ └── script + ... diff --git a/docs/source/starting/usage.rst b/docs/source/starting/usage.rst new file mode 100644 index 0000000..3cc386f --- /dev/null +++ b/docs/source/starting/usage.rst @@ -0,0 +1,86 @@ + +*********** +Basic Usage +*********** + +.. note:: + + The output from the commands below may not be the same on your system based on what images you have defined. + +`avail` +------- + +The `avail` command prints the defined images that can be built. + +.. code-block:: bash + + $ velocity avail + ==> gcc + 12.3.0 + 13.2.0 + 14.1.0 + ==> llvm + 17.0.0 + 17.0.6 + ==> mpich + 3.4.3 + ==> opensuse + 15.4 + 15.5 + 15.6 + ==> rocm + 5.7.1 + 6.0.1 + 6.1.3 + +Each image is listed and then indented underneath is a list of the available versions. + +`spec` +------ + +The `spec` command shows the dependencies for a given image (or list of images) in a tree like structure. + +.. code-block:: bash + + $ velocity spec rocm + > rocm@6.1.3-2a35af4 + ^opensuse@15.5-b386640 + +`build` +------- + +The `build` command can be used to build an container image from one or more image definitions. + +.. code-block:: bash + + $ velocity build opensuse + ==> Build Order: + opensuse@15.6-01205e8 + + ==> 01205e8: BUILD opensuse@15.6 ... + ==> 01205e8: GENERATING SCRIPT ... + ==> 01205e8: BUILDING ... + ==> 01205e8: IMAGE /tmp/xjv/velocity/opensuse-15.6-01205e8/01205e8.sif (opensuse@15.6) BUILT [0:02:12] + + ==> BUILT: /tmp/opensuse-15.6__x86_64-opensuse.sif + +Both the spec and the build command can also take a list of images. + +.. code-block:: bash + + $ velocity build opensuse mpich + ==> Build Order: + opensuse@15.6-01205e8 + mpich@3.4.3-5a22b26 + + ==> 01205e8: BUILD opensuse@15.6 ... + ==> 01205e8: GENERATING SCRIPT ... + ==> 01205e8: BUILDING ... + ==> 01205e8: IMAGE /tmp/xjv/velocity/opensuse-15.6-01205e8/01205e8.sif (opensuse@15.6) BUILT [0:00:00] + + ==> 5a22b26: BUILD mpich@3.4.3 ... + ==> 5a22b26: GENERATING SCRIPT ... + ==> 5a22b26: BUILDING ... + ==> 5a22b26: IMAGE /tmp/xjv/velocity/mpich-3.4.3-5a22b26/5a22b26.sif (mpich@3.4.3) BUILT [0:09:32] + + ==> BUILT: /tmp/mpich-3.4.3_opensuse-15.6__x86_64-opensuse.sif