diff --git a/.buildinfo b/.buildinfo new file mode 100644 index 000000000..873aa439d --- /dev/null +++ b/.buildinfo @@ -0,0 +1,4 @@ +# Sphinx build info version 1 +# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. +config: bda6c2d6f835236c10467efc30bc01d3 +tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/.nojekyll b/.nojekyll new file mode 100644 index 000000000..e69de29bb diff --git a/About.html b/About.html new file mode 100644 index 000000000..74227d211 --- /dev/null +++ b/About.html @@ -0,0 +1,198 @@ + + + + + + + About — HDL Containers: Building and deploying container images for open source Electronic Design Automation latest documentation + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+ + +
+ +
+
+ +
+
+ +
+

About

+

Unai Martinez-Corral [ +@GitHub +@GitLab +@Twitter +] +and contributors

+
+

Context

+

This project started in early 2017 at GitHub repository gh:ghdl/ghdl (which was named tgingold/ghdl back then). +The main purpose was testing GHDL on multiple GNU/Linux distributions (Debian, Ubuntu and Fedora), since +Travis CI supported Ubuntu only and Docker. +For each target platform, two images were used, one for building and another one for testing.

+

Later, most of the Docker related sources were split to repository gh:ghdl/docker. +There, some additional simulation tools were added, such as VUnit and +GtkWave. +Images including the ghdl-language-server were also added. +When experimental synthesis support was added to GHDL in 2019, and since it provides a plugin for Yosys, +containers including tools for providing a complete open source bitstream generation and formal verification workflow +were requested and contributed. +Those were +nextpnr, +icestorm, +prjtrellis, +SymbiYosys, +etc.

+

At some point, ghdl/docker had as much content related to non-GHDL tools, as resources related to the organisation. +In the second half of 2019, sharing the development effort was proposed to maintainers of Yosys (YosysHQ/yosys#1287) +and LibreCores (librecores/docker-images#33), which went unfortunately +unnoticed.

+

At the same time, F4PGA aimed at gathering open source projects for providing an integrated open +source EDA solution. +However, it did not have official container images and help was wanted. +This repository was initially created for moving all the tools which were not part of GHDL, from ghdl/docker to +f4pga/containers. +However, since F4PGA was (partially still is) focused on Verilog, the scope was widened to include VHDL, and the +repository was published at gh:hdl/containers in 2020.

+

In parallel to splitting ghdl/docker form ghdl/ghdl, in early 2019 gh:dbhi/qus (see qemu-user-static (qus) and containers) was created +as a generalisation of gh:multiarch/qemu-user-static. +qus is used in gh:dbhi/containers to build multi-architecture container images and manifests on Continuous +Integration (CI) services with amd64 hosts only (say Travis CI or GitHub Actions). +Currently, hdl/containers uses the same solution to build container images for foreign architectures.

+

Until the end of 2020, the scope of hdl/containers was limited to HDL simulation, formal verification and FPGA bitstream +generation; and container images were distributed through docker.io only. +Since 2021, tools for ASIC development are also provided, and two other registries are used as well: +gcr.io and ghcr.io.

+
+
+

HDL Organisation

+
    +
  • 'hdl/packages GitHub repository'

  • +
  • 'hdl/awesome GitHub repository' 'hdl.github.io/awesome'

  • +
  • 'hdl/constraints GitHub repository' 'hdl.github.io/constraints'

  • +
  • 'hdl/smoke-tests GitHub repository'

  • +
+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/CollectionsAndArchitectures.html b/CollectionsAndArchitectures.html new file mode 100644 index 000000000..0e81044e7 --- /dev/null +++ b/CollectionsAndArchitectures.html @@ -0,0 +1,197 @@ + + + + + + + Collections and architectures — HDL Containers: Building and deploying container images for open source Electronic Design Automation latest documentation + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+ + +
+ +
+
+ +
+
+ +
+

Collections and architectures

+

Images in this repository are organised in collections and built for multiple architectures. +A collection is a set of images which share a common ancestor; a base layer. +Having images with a common ancestor allows reducing bandwidth and disk usage when pulling several of them. +See docs.docker.com: About storage drivers | Images and layers.

+

Collections:

+
    +
  • debian/bookworm based on ARCHITECTURE/debian:bookworm-slim

  • +
  • debian/bullseye based on ARCHITECTURE/debian:bullseye-slim (default)

  • +
  • rockylinux/8 based on ARCHITECTURE/rockylinux:8

  • +
+
+

Important

+

Deprecated:

+
    +
  • None

  • +
+

Removed:

+
    +
  • debian/buster based on ARCHITECTURE/debian:buster-slim

  • +
  • centos/7 based on ARCHITECTURE/centos:7

  • +
+
+

Architectures:

+ +

Each image is published to both gcr.io and ghcr.io:

+

+Full image name (GCR) Full image name (GHCR)

However, fields ARCHITECURE and COLLECTION are optional because:

+
    +
  • Images for the default architecture are mirrored to SHIELD:Mirror:GCR:NoArchitecture and +SHIELD:Mirror:GHCR:NoArchitecture.

  • +
  • Images of the default collection are mirrored to SHIELD:Mirror:GCR:NoCollection and +SHIELD:Mirror:GHCR:NoCollection.

  • +
  • Images of the default collection for the default architecture are mirrored to SHIELD:Mirror:Docker.

  • +
  • Images of the default collection for the default architecture which are not build or pkg are mirrored to +SHIELD:Mirror:GCR:Default and SHIELD:Mirror:GHCR:Default.

  • +
+
+

Important

+

Image names and tags in this documentation are provided without the registry prefix. +Hence, one of the prefixes listed above needs to be used when actually pulling/using the images. +See User Guide for further details.

+
+
+

Important

+

The table in Tools and images shows the tools available in the default collection for the default +architecture. +Some tools are available in a subset of collections or for a subset of architectures only. +Browse the registries and/or the Continuous Integration workflows for finding images available in collections other +than the default.

+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/Doc-License.html b/Doc-License.html new file mode 100644 index 000000000..f9f1d4330 --- /dev/null +++ b/Doc-License.html @@ -0,0 +1,431 @@ + + + + + + + Creative Commons Attribution 4.0 International — HDL Containers: Building and deploying container images for open source Electronic Design Automation latest documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+ + +
+
    +
  • »
  • +
  • Creative Commons Attribution 4.0 International
  • +
  • + Edit on GitHub +
  • +
+
+
+ +
+
+ + +
+

Attention

+

This CC BY 4.0 license applies only to the documentation of this project.

+
+
+

Creative Commons Attribution 4.0 International

+

Creative Commons Corporation (“Creative Commons”) is not a law firm and does not provide legal services or legal advice. +Distribution of Creative Commons public licenses does not create a lawyer-client or other relationship. +Creative Commons makes its licenses and related information available on an “as-is” basis. +Creative Commons gives no warranties regarding its licenses, any material licensed under their terms and conditions, or +any related information. +Creative Commons disclaims all liability for damages resulting from their use to the fullest extent possible.

+
+

Using Creative Commons Public Licenses

+

Creative Commons public licenses provide a standard set of terms and conditions that creators and other rights holders +may use to share original works of authorship and other material subject to copyright and certain other rights specified +in the public license below. +The following considerations are for informational purposes only, are not exhaustive, and do not form part of our +licenses.

+
    +
  • Considerations for licensors: Our public licenses are intended for use by those authorized to give the public +permission to use material in ways otherwise restricted by copyright and certain other rights. +Our licenses are irrevocable. +Licensors should read and understand the terms and conditions of the license they choose before applying it. +Licensors should also secure all rights necessary before applying our licenses so that the public can reuse the +material as expected. +Licensors should clearly mark any material not subject to the license. +This includes other CC-licensed material, or material used under an exception or limitation to copyright. +More considerations for licensors.

  • +
  • Considerations for the public: By using one of our public licenses, a licensor grants the public permission to use +the licensed material under specified terms and conditions. +If the licensor’s permission is not necessary for any reason–for example, because of any applicable exception or +limitation to copyright–then that use is not regulated by the license. +Our licenses grant only permissions under copyright and certain other rights that a licensor has authority to grant. +Use of the licensed material may still be restricted for other reasons, including because others have copyright or +other rights in the material. +A licensor may make special requests, such as asking that all changes be marked or described. +Although not required by our licenses, you are encouraged to respect those requests where reasonable. +More considerations for the public.

  • +
+
+
+

Creative Commons Attribution 4.0 International Public License

+

By exercising the Licensed Rights (defined below), You accept and agree to be bound by the terms and conditions of this +Creative Commons Attribution 4.0 International Public License (“Public License”). +To the extent this Public License may be interpreted as a contract, You are granted the Licensed Rights in consideration +of Your acceptance of these terms and conditions, and the Licensor grants You such rights in consideration of benefits +the Licensor receives from making the Licensed Material available under these terms and conditions.

+
+

Section 1 – Definitions

+
    +
  1. Adapted Material means material subject to Copyright and Similar Rights that is derived from or based upon the +Licensed Material and in which the Licensed Material is translated, altered, arranged, transformed, or otherwise +modified in a manner requiring permission under the Copyright and Similar Rights held by the Licensor. +For purposes of this Public License, where the Licensed Material is a musical work, performance, or sound recording, +Adapted Material is always produced where the Licensed Material is synched in timed relation with a moving image.

  2. +
  3. Adapter’s License means the license You apply to Your Copyright and Similar Rights in Your contributions to +Adapted Material in accordance with the terms and conditions of this Public License.

  4. +
  5. Copyright and Similar Rights means copyright and/or similar rights closely related to copyright including, +without limitation, performance, broadcast, sound recording, and Sui Generis Database Rights, without regard to how +the rights are labeled or categorized. +For purposes of this Public License, the rights specified in Section 2(b)(1)-(2) are not Copyright and Similar Rights.

  6. +
  7. Effective Technological Measures means those measures that, in the absence of proper authority, may not be +circumvented under laws fulfilling obligations under Article 11 of the WIPO Copyright Treaty adopted on December 20, +1996, and/or similar international agreements.

  8. +
  9. Exceptions and Limitations means fair use, fair dealing, and/or any other exception or limitation to Copyright +and Similar Rights that applies to Your use of the Licensed Material.

  10. +
  11. Licensed Material means the artistic or literary work, database, or other material to which the Licensor applied +this Public License.

  12. +
  13. Licensed Rights means the rights granted to You subject to the terms and conditions of this Public License, which +are limited to all Copyright and Similar Rights that apply to Your use of the Licensed Material and that the Licensor +has authority to license.

  14. +
  15. Licensor means the individual(s) or entity(ies) granting rights under this Public License.

  16. +
  17. Share means to provide material to the public by any means or process that requires permission under the Licensed +Rights, such as reproduction, public display, public performance, distribution, dissemination, communication, or +importation, and to make material available to the public including in ways that members of the public may access the +material from a place and at a time individually chosen by them.

  18. +
  19. Sui Generis Database Rights means rights other than copyright resulting from Directive 96/9/EC of the European +Parliament and of the Council of 11 March 1996 on the legal protection of databases, as amended and/or succeeded, as +well as other essentially equivalent rights anywhere in the world.

  20. +
  21. You means the individual or entity exercising the Licensed Rights under this Public License. +Your has a corresponding meaning.

  22. +
+
+
+

Section 2 – Scope

+
    +
  1. License grant.

    +
      +
    1. Subject to the terms and conditions of this Public License, the Licensor hereby grants You a worldwide, +royalty-free, non-sublicensable, non-exclusive, irrevocable license to exercise the Licensed Rights in the +Licensed Material to:

      +
      +
        +
      1. reproduce and Share the Licensed Material, in whole or in part; and

      2. +
      3. produce, reproduce, and Share Adapted Material.

      4. +
      +
      +
    2. +
    3. Exceptions and Limitations. +For the avoidance of doubt, where Exceptions and Limitations apply to Your use, this Public License does not +apply, and You do not need to comply with its terms and conditions.

    4. +
    5. Term. +The term of this Public License is specified in Section 6(a).

    6. +
    7. Media and formats; technical modifications allowed. +The Licensor authorizes You to exercise the Licensed Rights in all media and formats whether now known or +hereafter created, and to make technical modifications necessary to do so. +The Licensor waives and/or agrees not to assert any right or authority to forbid You from making technical +modifications necessary to exercise the Licensed Rights, including technical modifications necessary to circumvent +Effective Technological Measures. +For purposes of this Public License, simply making modifications authorized by this Section 2(a)(4) never produces +Adapted Material.

    8. +
    9. Downstream recipients.

      +
      +
        +
      1. Offer from the Licensor – Licensed Material. +Every recipient of the Licensed Material automatically receives an offer from the Licensor to exercise the +Licensed Rights under the terms and conditions of this Public License.

      2. +
      3. No downstream restrictions. +You may not offer or impose any additional or different terms or conditions on, or apply any Effective +Technological Measures to, the Licensed Material if doing so restricts exercise of the Licensed Rights by any +recipient of the Licensed Material.

      4. +
      +
      +
    10. +
    11. No endorsement. +Nothing in this Public License constitutes or may be construed as permission to assert or imply that You are, or +that Your use of the Licensed Material is, connected with, or sponsored, endorsed, or granted official status by, +the Licensor or others designated to receive attribution as provided in Section 3(a)(1)(A)(i).

    12. +
    +
  2. +
  3. Other rights.

    +
      +
    1. Moral rights, such as the right of integrity, are not licensed under this Public License, nor are publicity, +privacy, and/or other similar personality rights; however, to the extent possible, the Licensor waives and/or +agrees not to assert any such rights held by the Licensor to the limited extent necessary to allow You to exercise +the Licensed Rights, but not otherwise.

    2. +
    3. Patent and trademark rights are not licensed under this Public License.

    4. +
    5. To the extent possible, the Licensor waives any right to collect royalties from You for the exercise of the +Licensed Rights, whether directly or through a collecting society under any voluntary or waivable statutory or +compulsory licensing scheme. +In all other cases the Licensor expressly reserves any right to collect such royalties.

    6. +
    +
  4. +
+
+
+

Section 3 – License Conditions

+

Your exercise of the Licensed Rights is expressly made subject to the following conditions.

+
    +
  1. Attribution.

    +
      +
    1. If You Share the Licensed Material (including in modified form), You must:

      +
      +
        +
      1. retain the following if it is supplied by the Licensor with the Licensed Material:

      2. +
      +
      +
        +
      1. identification of the creator(s) of the Licensed Material and any others designated to receive attribution, +in any reasonable manner requested by the Licensor (including by pseudonym if designated);

      2. +
      3. a copyright notice;

      4. +
      5. a notice that refers to this Public License;

      6. +
      7. a notice that refers to the disclaimer of warranties;

      8. +
      9. a URI or hyperlink to the Licensed Material to the extent reasonably practicable;

      10. +
      +
      +
        +
      1. indicate if You modified the Licensed Material and retain an indication of any previous modifications; and

      2. +
      3. indicate the Licensed Material is licensed under this Public License, and include the text of, or the URI or +hyperlink to, this Public License.

      4. +
      +
      +
    2. +
    3. You may satisfy the conditions in Section 3(a)(1) in any reasonable manner based on the medium, means, and context +in which You Share the Licensed Material. +For example, it may be reasonable to satisfy the conditions by providing a URI or hyperlink to a resource that +includes the required information.

    4. +
    5. If requested by the Licensor, You must remove any of the information required by Section 3(a)(1)(A) to the extent +reasonably practicable.

    6. +
    7. If You Share Adapted Material You produce, the Adapter’s License You apply must not prevent recipients of the +Adapted Material from complying with this Public License.

    8. +
    +
  2. +
+
+
+

Section 4 – Sui Generis Database Rights

+

Where the Licensed Rights include Sui Generis Database Rights that apply to Your use of the Licensed Material:

+
    +
  1. for the avoidance of doubt, Section 2(a)(1) grants You the right to extract, reuse, reproduce, and Share all or a +substantial portion of the contents of the database;

  2. +
  3. if You include all or a substantial portion of the database contents in a database in which You have Sui Generis +Database Rights, then the database in which You have Sui Generis Database Rights (but not its individual contents) is +Adapted Material; and

  4. +
  5. You must comply with the conditions in Section 3(a) if You Share all or a substantial portion of the contents of the +database.

  6. +
+

For the avoidance of doubt, this Section 4 supplements and does not replace Your obligations under this Public License +where the Licensed Rights include other Copyright and Similar Rights.

+
+
+

Section 5 – Disclaimer of Warranties and Limitation of Liability

+
    +
  1. Unless otherwise separately undertaken by the Licensor, to the extent possible, the Licensor offers the Licensed +Material as-is and as-available, and makes no representations or warranties of any kind concerning the Licensed +Material, whether express, implied, statutory, or other. +This includes, without limitation, warranties of title, merchantability, fitness for a particular purpose, +non-infringement, absence of latent or other defects, accuracy, or the presence or absence of errors, whether or not +known or discoverable. +Where disclaimers of warranties are not allowed in full or in part, this disclaimer may not apply to You.

  2. +
  3. To the extent possible, in no event will the Licensor be liable to You on any legal theory (including, without +limitation, negligence) or otherwise for any direct, special, indirect, incidental, consequential, punitive, +exemplary, or other losses, costs, expenses, or damages arising out of this Public License or use of the Licensed +Material, even if the Licensor has been advised of the possibility of such losses, costs, expenses, or damages. +Where a limitation of liability is not allowed in full or in part, this limitation may not apply to You.

  4. +
  5. The disclaimer of warranties and limitation of liability provided above shall be interpreted in a manner that, to the +extent possible, most closely approximates an absolute disclaimer and waiver of all liability.

  6. +
+
+
+

Section 6 – Term and Termination

+
    +
  1. This Public License applies for the term of the Copyright and Similar Rights licensed here. +However, if You fail to comply with this Public License, then Your rights under this Public License terminate +automatically.

  2. +
  3. Where Your right to use the Licensed Material has terminated under Section 6(a), it reinstates:

    +
      +
    1. automatically as of the date the violation is cured, provided it is cured within 30 days of Your discovery of the +violation; or

    2. +
    3. upon express reinstatement by the Licensor.

    4. +
    +

    For the avoidance of doubt, this Section 6(b) does not affect any right the Licensor may have to seek remedies for +Your violations of this Public License.

    +
  4. +
  5. For the avoidance of doubt, the Licensor may also offer the Licensed Material under separate terms or conditions or +stop distributing the Licensed Material at any time; however, doing so will not terminate this Public License.

  6. +
  7. Sections 1, 5, 6, 7, and 8 survive termination of this Public License.

  8. +
+
+
+

Section 7 – Other Terms and Conditions

+
    +
  1. The Licensor shall not be bound by any additional or different terms or conditions communicated by You unless +expressly agreed.

  2. +
  3. Any arrangements, understandings, or agreements regarding the Licensed Material not stated herein are separate from +and independent of the terms and conditions of this Public License.

  4. +
+
+
+

Section 8 – Interpretation

+
    +
  1. For the avoidance of doubt, this Public License does not, and shall not be interpreted to, reduce, limit, restrict, +or impose conditions on any use of the Licensed Material that could lawfully be made without permission under this +Public License.

  2. +
  3. To the extent possible, if any provision of this Public License is deemed unenforceable, it shall be automatically +reformed to the minimum extent necessary to make it enforceable. +If the provision cannot be reformed, it shall be severed from this Public License without affecting the +enforceability of the remaining terms and conditions.

  4. +
  5. No term or condition of this Public License will be waived and no failure to comply consented to unless expressly +agreed to by the Licensor.

  6. +
  7. Nothing in this Public License constitutes or may be interpreted as a limitation upon, or waiver of, any privileges +and immunities that apply to the Licensor or You, including from the legal processes of any jurisdiction or +authority.

  8. +
+
+

Creative Commons is not a party to its public licenses. +Notwithstanding, Creative Commons may elect to apply one of its public licenses to material it publishes and in those +instances will be considered the “Licensor.” Except for the limited purpose of indicating that material is shared under +a Creative Commons public license or as otherwise permitted by the Creative Commons policies published at creativecommons.org/policies, +Creative Commons does not authorize the use of the trademark “Creative Commons” or any other trademark or logo of +Creative Commons without its prior written consent including, without limitation, in connection with any unauthorized +modifications to any of its public licenses or any other arrangements, understandings, or agreements concerning use of +licensed material. +For the avoidance of doubt, this paragraph does not form part of the public licenses.

+

Creative Commons may be contacted at creativecommons.org

+
+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/License.html b/License.html new file mode 100644 index 000000000..fb1cf08cc --- /dev/null +++ b/License.html @@ -0,0 +1,304 @@ + + + + + + + Apache License 2.0 — HDL Containers: Building and deploying container images for open source Electronic Design Automation latest documentation + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+ + +
+ +
+
+ +
+
+ +
+

Note

+

This is a local copy of the Apache License Version 2.0.

+
+
+

Attention

+

This Apache License, 2.0 applies to all source and configuration files of project, except documentation.

+
+
+

Apache License 2.0

+

Version 2.0, January 2004

+

TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

+
+

1. Definitions

+

“License” shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 +through 9 of this document.

+

“Licensor” shall mean the copyright owner or entity authorized by the copyright owner that is granting the License.

+

“Legal Entity” shall mean the union of the acting entity and all other entities that control, are controlled by, or +are under common control with that entity. +For the purposes of this definition, “control” means (i) the power, direct or indirect, to cause the direction or +management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the +outstanding shares, or (iii) beneficial ownership of such entity.

+

“You” (or “Your”) shall mean an individual or Legal Entity exercising permissions granted by this License.

+

“Source” form shall mean the preferred form for making modifications, including but not limited to software source +code, documentation source, and configuration files.

+

“Object” form shall mean any form resulting from mechanical transformation or translation of a Source form, +including but not limited to compiled object code, generated documentation, and conversions to other media types.

+

“Work” shall mean the work of authorship, whether in Source or Object form, made available under the License, as +indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix +below).

+

“Derivative Works” shall mean any work, whether in Source or Object form, that is based on (or derived from) the +Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an +original work of authorship. +For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link +(or bind by name) to the interfaces of, the Work and Derivative Works thereof.

+

“Contribution” shall mean any work of authorship, including the original version of the Work and any modifications +or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the +Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. +For the purposes of this definition, “submitted” means any form of electronic, verbal, or written communication sent +to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source +code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of +discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in +writing by the copyright owner as “Not a Contribution.”

+

“Contributor” shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been +received by Licensor and subsequently incorporated within the Work.

+
+ +
+

3. Grant of Patent License

+

Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, +non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have +made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent +claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of +their Contribution(s) with the Work to which such Contribution(s) was submitted. +If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging +that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, +then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation +is filed.

+
+
+

4. Redistribution

+

You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without +modifications, and in Source or Object form, provided that You meet the following conditions:

+
    +
  • You must give any other recipients of the Work or Derivative Works a copy of this License; and

  • +
  • You must cause any modified files to carry prominent notices stating that You changed the files; and

  • +
  • You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and +attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the +Derivative Works; and

  • +
  • If the Work includes a “NOTICE” text file as part of its distribution, then any Derivative Works that You +distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those +notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a +NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided +along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such +third-party notices normally appear. +The contents of the NOTICE file are for informational purposes only and do not modify the License. +You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to +the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the +License.

  • +
+

You may add Your own copyright statement to Your modifications and may provide additional or different license terms and +conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, +provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this +License.

+
+
+

5. Submission of Contributions

+

Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the +Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. +Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may +have executed with Licensor regarding such Contributions.

+
+
+

6. Trademarks

+

This License does not grant permission to use the trade names, trademarks, service marks, or product names of the +Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the +content of the NOTICE file.

+
+
+

7. Disclaimer of Warranty

+

Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its +Contributions) on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, +without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A +PARTICULAR PURPOSE. +You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks +associated with Your exercise of permissions under this License.

+
+
+

8. Limitation of Liability

+

In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required +by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be +liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any +character arising as a result of this License or out of the use or inability to use the Work (including but not limited +to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages +or losses), even if such Contributor has been advised of the possibility of such damages.

+
+
+

9. Accepting Warranty or Additional Liability

+

While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of +support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. +However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on +behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any +liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or +additional liability.

+
+
+

Appendix: How to apply the Apache License to your work

+

To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets +“[]” replaced with your own identifying information. +(Don’t include the brackets!) +The text should be enclosed in the appropriate comment syntax for the file format. +We also recommend that a file or class name and description of purpose be included on the same “printed page” as the +copyright notice for easier identification within third-party archives.

+
Copyright [yyyy] [name of copyright owner]
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+
+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/References.html b/References.html new file mode 100644 index 000000000..59ba062a2 --- /dev/null +++ b/References.html @@ -0,0 +1,253 @@ + + + + + + + References — HDL Containers: Building and deploying container images for open source Electronic Design Automation latest documentation + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+ + +
+ +
+
+ +
+
+ +
+

References

+ +
+

F4PGA

+ +
+
+

distroless

+ +
+

Wolfi

+ +
+
+
+

NixOS

+
+
+
+
+

LibreCores

+
+
+
+
+
+

ASIC

+ +
+
+

Google Container Regisry (GCR)

+ +
+
+

USB/IP

+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/ToolsAndImages.html b/ToolsAndImages.html new file mode 100644 index 000000000..65798c07c --- /dev/null +++ b/ToolsAndImages.html @@ -0,0 +1,752 @@ + + + + + + + Tools and images — HDL Containers: Building and deploying container images for open source Electronic Design Automation latest documentation + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+ + +
+ +
+
+ +
+
+ +
+

Tools and images

+

By default, latest development versions (branches master | main) of tools are built. +Then, smoke tests are executed and, if successful, the corresponding images are updated in the registries. +However, some specific tools are not built from sources, but installed through (system) package managers. +Those are marked with ! in the table below.

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

Tool

Package

Ready-to-use

S

I

F

P

Others

apicula

    +
  • 'pkg/apicula container image size'

  • +
+
    +
  • 'apicula container image size'

  • +
+

🗆

🗆

🗆

🗆

arachne-pnr

    +
  • 'pkg/arachne-pnr container image size'

  • +
+
    +
  • 'arachne-pnr container image size'

  • +
+

🗆

🗆

🗆

🗆

boolector

    +
  • 'pkg/boolector container image size'

  • +
+

🗆

🗆

F

🗆

cocotb

S

🗆

🗆

🗆

cvc

    +
  • 'pkg/cvc container image size'

  • +
+

🗆

🗆

F

🗆

ghdl

    +
  • 'pkg/ghdl container image size'

  • +
  • 'pkg/ghdl/llvm container image size'

  • +
+
    +
  • 'ghdl container image size'

  • +
  • 'ghdl/llvm container image size'

  • +
+

S

I

F

🗆

ghdl/yosys

ghdl-yosys-plugin

    +
  • 'pkg/ghdl-yosys-plugin container image size'

  • +
+
    +
  • 'ghdl/yosys container image size'

  • +
+

🗆

I

F

🗆

graphviz !

🗆

I

F

🗆

yosys, ghdl/yosys

gtkwave

    +
  • 'pkg/gtkwave container image size'

  • +
+
    +
  • 'gtkwave container image size'

  • +
+

🗆

🗆

🗆

🗆

icestorm

    +
  • 'pkg/icestorm container image size'

  • +
+
    +
  • 'icestorm container image size'

  • +
+

🗆

I

🗆

P

nextpnr/icestorm

irsim

    +
  • 'pkg/irsim container image size'

  • +
+
    +
  • 'irsim container image size'

  • +
+

🗆

🗆

🗆

🗆

magic/irsim

iverilog

    +
  • 'pkg/iverilog container image size'

  • +
+
    +
  • 'iverilog container image size'

  • +
+

S

🗆

🗆

🗆

klayout

    +
  • 'pkg/klayout container image size'

  • +
+
    +
  • 'klayout container image size'

  • +
+

🗆

🗆

🗆

🗆

magic

    +
  • 'pkg/magic container image size'

  • +
+
    +
  • 'magic container image size'

  • +
  • 'magic/irsim container image size'

  • +
+

🗆

🗆

🗆

🗆

netgen

    +
  • 'pkg/netgen container image size'

  • +
+
    +
  • 'netgen container image size'

  • +
+

🗆

🗆

🗆

🗆

nextpnr

    +
  • 'pkg/nextpnr/generic container image size'

  • +
  • 'pkg/nextpnr/ice40 container image size'

  • +
  • 'pkg/nextpnr/nexus container image size'

  • +
  • 'pkg/nextpnr/ecp5 container image size'

  • +
+
    +
  • 'nextpnr/generic container image size'

  • +
  • 'nextpnr/ice40 container image size'

  • +
  • 'nextpnr/nexus container image size'

  • +
  • 'nextpnr/ecp5 container image size'

  • +
  • 'nextpnr/icestorm container image size'

  • +
  • 'nextpnr/prjoxide container image size'

  • +
  • 'nextpnr/prjtrellis container image size'

  • +
  • 'nextpnr container image size'

  • +
+

🗆

I

🗆

🗆

nvc

    +
  • 'pkg/nvc container image size'

  • +
+
    +
  • 'nvc container image size'

  • +
+

S

🗆

🗆

🗆

openfpgaloader

    +
  • 'pkg/openfpgaloader container image size'

  • +
+
    +
  • 'openfpgaloader container image size'

  • +
+

🗆

🗆

🗆

🗆

openocd !

🗆

🗆

🗆

P

openroad

    +
  • 'pkg/openroad container image size'

  • +
  • 'pkg/openroad/gui container image size'

  • +
+
    +
  • 'openroad container image size'

  • +
  • 'openroad/gui container image size'

  • +
+

🗆

🗆

🗆

🗆

pono

    +
  • 'pkg/pono container image size'

  • +
+

🗆

🗆

F

🗆

prjoxide

    +
  • 'pkg/prjoxide container image size'

  • +
+
    +
  • 'prjoxide container image size'

  • +
+

🗆

I

🗆

🗆

nextpnr/prjoxide

prjtrellis

    +
  • 'pkg/prjtrellis container image size'

  • +
+
    +
  • 'prjtrellis container image size'

  • +
+

🗆

I

🗆

🗆

nextpnr/prjtrellis

superprove

    +
  • 'pkg/superprove container image size'

  • +
+

🗆

🗆

F

🗆

sby

    +
  • 'pkg/sby container image size'

  • +
+

🗆

🗆

F

🗆

verible

    +
  • 'pkg/verible container image size'

  • +
+
    +
  • 'verible container image size'

  • +
+

🗆

🗆

🗆

🗆

verilator

    +
  • 'pkg/verilator container image size'

  • +
+
    +
  • 'verilator container image size'

  • +
+

S

🗆

🗆

🗆

vtr

    +
  • 'pkg/vtr container image size'

  • +
+
    +
  • 'vtr container image size'

  • +
+

🗆

🗆

🗆

🗆

vunit

S

🗆

🗆

🗆

yices2

    +
  • 'pkg/yices2 container image size'

  • +
+

🗆

🗆

F

🗆

xschem

    +
  • 'pkg/xschem container image size'

  • +
+
    +
  • 'xschem container image size'

  • +
+

🗆

🗆

🗆

🗆

xyce

    +
  • 'pkg/xyce container image size'

  • +
+
    +
  • 'xyce container image size'

  • +
+

🗆

🗆

🗆

🗆

yosys

    +
  • 'pkg/yosys container image size'

  • +
+
    +
  • 'yosys container image size'

  • +
+

🗆

I

F

🗆

ghdl/yosys

z3

    +
  • 'pkg/z3 container image size'

  • +
+

🗆

🗆

F

🗆

+
+

Note

+

Package images are not to be used for executing the tools, but for composing images including multiple resources. +See Package images for further details.

+
+
+

Images including multiple tools

+
    +
  • Simulation:

    +
      +
    • 'sim container image size' GHDL + NVC + Verilator + Icarus Verilog

    • +
    • 'sim/osvb container image size' CoCoTb, OSVVM and VUnit; on top of sim.

    • +
    • 'sim/scipy-slim container image size' matplotlib and numpy; on top of sim.

    • +
    • 'sim/scipy container image size' osvb; on top of sim/scipy-slim.

    • +
    • 'sim/octave-slim container image size' octave; on top of sim.

    • +
    • 'sim/octave container image size' osvb; on top of sim/octave-slim.

      +
        +
      • 'sim/octave/gnuplot container image size' gnuplot; on top of sim/octave.

      • +
      +
    • +
    +
  • +
  • Implementation: GHDL + Yosys + nextpnr

    +
      +
    • 'impl/ice40 container image size' nextpnr-ice40 only, and 'impl/icestorm container image size' including icestorm.

    • +
    • 'impl/ecp5 container image size' nextpnr-ecp5 only, and 'impl/prjtrellis container image size' including prjtrellis.

    • +
    • 'impl/nexus container image size' nextpnr-nexus only, and 'impl/prjoxide container image size' including prjoxide.

    • +
    • 'impl/generic container image size' nextpnr-generic only.

    • +
    • 'impl/pnr container image size' all nextpnr targets (ecp5, ice40, nexus, and generic).

    • +
    • 'impl container image size' impl:pnr, including icestorm, prjtrellis and prjoxide.

    • +
    +
  • +
  • Formal:

    +
      +
    • 'formal container image size' all solvers depending on Python 3.

    • +
    • 'formal/min container image size' Z3 only.

    • +
    • 'formal/all container image size' all solvers, depending on either Python 2 or Python 3.

    • +
    +
  • +
  • Programming: 'prog container image size'

  • +
+
+
+

F4PGA (Conda)

+

F4PGA is an ecosystem of EDA tools for the development of FPGAs of multiple vendors. +The tools used in the F4PGA ecosystem are packaged by Antmicro and contributors using +Conda. +The sources of Conda packages for EDA tooling are found in +'hdl/conda-ci GitHub repository', +'hdl/conda-compilers GitHub repository', +'hdl/conda-eda GitHub repository', +'hdl/conda-misc GitHub repository' and +'hdl/conda-prog GitHub repository'.

+

In HDL Containers, as a complement to container images based on tools built on other container images, a set of +Conda-based F4PGA images is provided. +The base is 'conda container image size', which includes a Miniconda setup. +On top of that, the following ready-to-use images allow following the guidelines in +'chipsalliance/f4pga-examples GitHub repository' ( 'f4pga-examples.rtfd.io' ):

+
    +
  • 'conda/f4pga/xc7/toolchain container image size': the toolchain for FPGA_FAM=xc7, on top of conda. +The following images are based on this:

    +
      +
    • 'conda/f4pga/xc7/a50t container image size': includes architecture definitions for xc7a50t.

    • +
    • 'conda/f4pga/xc7/a100t container image size': includes architecture definitions for xc7a100t.

    • +
    • 'conda/f4pga/xc7/a200t container image size': includes architecture definitions for xc7a200t.

    • +
    • 'conda/f4pga/xc7/z010 container image size': includes architecture definitions for xc7z010.

    • +
    • 'conda/f4pga/xc7/z020 container image size': includes architecture definitions for xc7z020.

    • +
    • 'conda/f4pga/xc7 container image size': includes all the architecture definitions for the xc7 family, except +xc7a200t (due to hard disk limits on GitHub Actions).

    • +
    +
  • +
  • 'conda/f4pga/eos-s3 container image size': the toolchain for FPGA_FAM=eos-s3 and the architecture definitions, on top +of conda.

  • +
+
+

Important

+

The compression ratio of these images is very high compared to other container images. +That is because these include a significant amount of data in text format, which is much better compressed than +binaries. +As a result, the size of the images when pulled is approximately as follows:

+
    +
  • xc7/toolchain: 3 GB

  • +
  • xc7/a50t: 6 GB

  • +
  • xc7/a100t: 8.5 GB

  • +
  • xc7/a200t: 15 GB

  • +
  • xc7/z010: 5 GB

  • +
  • xc7/z020: 7.5 GB

  • +
  • xc7: 18 GB (would be 30 GB if a200t was included)

  • +
  • eos-s3: 2 GB

  • +
+
+
+
+

To Do

+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/_images/banner_path.svg b/_images/banner_path.svg new file mode 100644 index 000000000..d72727aa4 --- /dev/null +++ b/_images/banner_path.svg @@ -0,0 +1,412 @@ + + + + + + + image/svg+xml + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/_images/continuous_integration.svg b/_images/continuous_integration.svg new file mode 100644 index 000000000..7f41678b0 --- /dev/null +++ b/_images/continuous_integration.svg @@ -0,0 +1,3 @@ + + +
Common
(Reusable Workflow)
Common...
matrix
matrix
Job
Job
JavaScript
JavaScript
Bash
Bash
Python
Python
Legend:
Legend:
Uncoditioned
Uncoditioned
Conditioned
Conditioned
[Pull,] Build [and Test]
(heredoc python script)
[Pull,] Build [and Test]...
[conditionally] Pull
(pyHDLC pull ...)
[conditionally] Pull...
Build [and conditionally Test]
(pyHDLC build ... -d ...)
Build [and conditionally T...
build-test-release
(Composite Action)
build-test-release...
Setup
(./utils/setup.sh)
Setup...
[Pull,] Build [and Test]
(heredoc python script)
[Pull,] Build [and Test]...
[conditionally] Release
(pyTooling/Actions/with-post-step)
[conditionally] Release...
Setup
(./utils/setup.sh)
Setup...
generate
(pyHDLC jobs <key>)
generate...
actions/checkout
(JavaScript Action)
actions/checkout...
jobs
jobs
./utils/build-test-release
(Local Composite Action)
./utils/build-test-rele...
actions/checkout
(JavaScript Action)
actions/checkout...
pyHDLC
(Local Python Utilities)
pyHDLC...
__init__.py
__init__.py
cli.py
cli.py
run.py
run.py
config.yml
config.yml
Dispatch
(Dispatchable Workflow)
Dispatch...
hdl/containers/.github/workflows/common.yml
(Reusable Workflow)
hdl/containers/.github/workflows/common.yml...
Viewer does not support full SVG 1.1
\ No newline at end of file diff --git a/_images/dive.png b/_images/dive.png new file mode 100644 index 000000000..5d9aa4230 Binary files /dev/null and b/_images/dive.png differ diff --git a/_images/graphviz-16c0d5510e7581c3cb1e8c4f05c757f040481d12.png b/_images/graphviz-16c0d5510e7581c3cb1e8c4f05c757f040481d12.png new file mode 100644 index 000000000..823f975d1 Binary files /dev/null and b/_images/graphviz-16c0d5510e7581c3cb1e8c4f05c757f040481d12.png differ diff --git a/_images/graphviz-16c0d5510e7581c3cb1e8c4f05c757f040481d12.png.map b/_images/graphviz-16c0d5510e7581c3cb1e8c4f05c757f040481d12.png.map new file mode 100644 index 000000000..8be6a309f --- /dev/null +++ b/_images/graphviz-16c0d5510e7581c3cb1e8c4f05c757f040481d12.png.map @@ -0,0 +1,2 @@ + + diff --git a/_images/graphviz-1c9c8facfb297ddb9ceb294cc06459ffd28f3e7e.png b/_images/graphviz-1c9c8facfb297ddb9ceb294cc06459ffd28f3e7e.png new file mode 100644 index 000000000..db990ef50 Binary files /dev/null and b/_images/graphviz-1c9c8facfb297ddb9ceb294cc06459ffd28f3e7e.png differ diff --git a/_images/graphviz-1c9c8facfb297ddb9ceb294cc06459ffd28f3e7e.png.map b/_images/graphviz-1c9c8facfb297ddb9ceb294cc06459ffd28f3e7e.png.map new file mode 100644 index 000000000..8be6a309f --- /dev/null +++ b/_images/graphviz-1c9c8facfb297ddb9ceb294cc06459ffd28f3e7e.png.map @@ -0,0 +1,2 @@ + + diff --git a/_images/graphviz-217eef15beb804a93225b61e5218f870719d62d3.png b/_images/graphviz-217eef15beb804a93225b61e5218f870719d62d3.png new file mode 100644 index 000000000..7cbe4a907 Binary files /dev/null and b/_images/graphviz-217eef15beb804a93225b61e5218f870719d62d3.png differ diff --git a/_images/graphviz-217eef15beb804a93225b61e5218f870719d62d3.png.map b/_images/graphviz-217eef15beb804a93225b61e5218f870719d62d3.png.map new file mode 100644 index 000000000..8be6a309f --- /dev/null +++ b/_images/graphviz-217eef15beb804a93225b61e5218f870719d62d3.png.map @@ -0,0 +1,2 @@ + + diff --git a/_images/graphviz-38082d0c527f48bb90cde9b0c9b0a352e2cd73e3.png b/_images/graphviz-38082d0c527f48bb90cde9b0c9b0a352e2cd73e3.png new file mode 100644 index 000000000..bd39f697c Binary files /dev/null and b/_images/graphviz-38082d0c527f48bb90cde9b0c9b0a352e2cd73e3.png differ diff --git a/_images/graphviz-38082d0c527f48bb90cde9b0c9b0a352e2cd73e3.png.map b/_images/graphviz-38082d0c527f48bb90cde9b0c9b0a352e2cd73e3.png.map new file mode 100644 index 000000000..8be6a309f --- /dev/null +++ b/_images/graphviz-38082d0c527f48bb90cde9b0c9b0a352e2cd73e3.png.map @@ -0,0 +1,2 @@ + + diff --git a/_images/graphviz-5e9ad22d55898867de0ce75c2e889becce885c65.png b/_images/graphviz-5e9ad22d55898867de0ce75c2e889becce885c65.png new file mode 100644 index 000000000..7466fb646 Binary files /dev/null and b/_images/graphviz-5e9ad22d55898867de0ce75c2e889becce885c65.png differ diff --git a/_images/graphviz-5e9ad22d55898867de0ce75c2e889becce885c65.png.map b/_images/graphviz-5e9ad22d55898867de0ce75c2e889becce885c65.png.map new file mode 100644 index 000000000..8be6a309f --- /dev/null +++ b/_images/graphviz-5e9ad22d55898867de0ce75c2e889becce885c65.png.map @@ -0,0 +1,2 @@ + + diff --git a/_images/graphviz-79bd996b73b1758b4727bc22b9c30b4a636bbf5c.png b/_images/graphviz-79bd996b73b1758b4727bc22b9c30b4a636bbf5c.png new file mode 100644 index 000000000..c0bbbae99 Binary files /dev/null and b/_images/graphviz-79bd996b73b1758b4727bc22b9c30b4a636bbf5c.png differ diff --git a/_images/graphviz-79bd996b73b1758b4727bc22b9c30b4a636bbf5c.png.map b/_images/graphviz-79bd996b73b1758b4727bc22b9c30b4a636bbf5c.png.map new file mode 100644 index 000000000..8be6a309f --- /dev/null +++ b/_images/graphviz-79bd996b73b1758b4727bc22b9c30b4a636bbf5c.png.map @@ -0,0 +1,2 @@ + + diff --git a/_images/graphviz-a0d9e80e7dcb95d74d485c588065a4491e218a1d.png b/_images/graphviz-a0d9e80e7dcb95d74d485c588065a4491e218a1d.png new file mode 100644 index 000000000..d60067265 Binary files /dev/null and b/_images/graphviz-a0d9e80e7dcb95d74d485c588065a4491e218a1d.png differ diff --git a/_images/graphviz-a0d9e80e7dcb95d74d485c588065a4491e218a1d.png.map b/_images/graphviz-a0d9e80e7dcb95d74d485c588065a4491e218a1d.png.map new file mode 100644 index 000000000..8be6a309f --- /dev/null +++ b/_images/graphviz-a0d9e80e7dcb95d74d485c588065a4491e218a1d.png.map @@ -0,0 +1,2 @@ + + diff --git a/_images/graphviz-cf39a6a1f148fc0f2dd0aba526abe91e83101128.png b/_images/graphviz-cf39a6a1f148fc0f2dd0aba526abe91e83101128.png new file mode 100644 index 000000000..89a4c6c7b Binary files /dev/null and b/_images/graphviz-cf39a6a1f148fc0f2dd0aba526abe91e83101128.png differ diff --git a/_images/graphviz-cf39a6a1f148fc0f2dd0aba526abe91e83101128.png.map b/_images/graphviz-cf39a6a1f148fc0f2dd0aba526abe91e83101128.png.map new file mode 100644 index 000000000..8be6a309f --- /dev/null +++ b/_images/graphviz-cf39a6a1f148fc0f2dd0aba526abe91e83101128.png.map @@ -0,0 +1,2 @@ + + diff --git a/_images/graphviz-e1d43b6a79cb5de6f59d8605f3a4172146bbf9d1.png b/_images/graphviz-e1d43b6a79cb5de6f59d8605f3a4172146bbf9d1.png new file mode 100644 index 000000000..3e0421eed Binary files /dev/null and b/_images/graphviz-e1d43b6a79cb5de6f59d8605f3a4172146bbf9d1.png differ diff --git a/_images/graphviz-e1d43b6a79cb5de6f59d8605f3a4172146bbf9d1.png.map b/_images/graphviz-e1d43b6a79cb5de6f59d8605f3a4172146bbf9d1.png.map new file mode 100644 index 000000000..8be6a309f --- /dev/null +++ b/_images/graphviz-e1d43b6a79cb5de6f59d8605f3a4172146bbf9d1.png.map @@ -0,0 +1,2 @@ + + diff --git a/_images/x11docker_klayout.gif b/_images/x11docker_klayout.gif new file mode 100644 index 000000000..b9701b86e Binary files /dev/null and b/_images/x11docker_klayout.gif differ diff --git a/_sources/About.rst.txt b/_sources/About.rst.txt new file mode 100644 index 000000000..6be918533 --- /dev/null +++ b/_sources/About.rst.txt @@ -0,0 +1,70 @@ +.. _context: + +About +##### + +Unai Martinez-Corral [ +:gh:`@GitHub ` +`@GitLab `__ +`@Twitter `__ +] +and :gh:`contributors ` + +Context +======= + +This project started in early 2017 at GitHub repository :gh:`ghdl/ghdl` (which was named tgingold/ghdl back then). +The main purpose was testing GHDL on multiple GNU/Linux distributions (Debian, Ubuntu and Fedora), since +`Travis CI `__ supported Ubuntu only and Docker. +For each target platform, two images were used, one for building and another one for testing. + +Later, most of the Docker related sources were split to repository :gh:`ghdl/docker`. +There, some additional simulation tools were added, such as `VUnit `__ and +`GtkWave `__. +Images including the :gh:`ghdl-language-server ` were also added. +When experimental synthesis support was added to GHDL in 2019, and since it provides a plugin for :gh:`Yosys `, +containers including tools for providing a complete open source bitstream generation and formal verification workflow +were requested and contributed. +Those were +:gh:`nextpnr `, +:gh:`icestorm `, +:gh:`prjtrellis `, +:gh:`SymbiYosys `, +etc. + +At some point, ghdl/docker had as much content related to non-GHDL tools, as resources related to the organisation. +In the second half of 2019, sharing the development effort was proposed to maintainers of Yosys (:gh:`YosysHQ/yosys#1287 `) +and LibreCores (:gh:`librecores/docker-images#33 `), which went unfortunately +unnoticed. + +At the same time, `F4PGA `__ aimed at gathering open source projects for providing an integrated open +source EDA solution. +However, it did not have official container images and `help was wanted `__. +This repository was initially created for moving all the tools which were not part of GHDL, from ghdl/docker to +f4pga/containers. +However, since F4PGA was (partially still is) focused on Verilog, the scope was widened to include VHDL, and the +repository was published at :gh:`hdl/containers` in 2020. + +In parallel to splitting ghdl/docker form ghdl/ghdl, in early 2019 :gh:`dbhi/qus` (see :doc:`qus:index`) was created +as a generalisation of :gh:`multiarch/qemu-user-static`. +*qus* is used in :gh:`dbhi/containers` to build multi-architecture container images and manifests on Continuous +Integration (CI) services with amd64 hosts only (say Travis CI or :gh:`GitHub Actions `). +Currently, hdl/containers uses the same solution to build container images for *foreign* architectures. + +Until the end of 2020, the scope of hdl/containers was limited to HDL simulation, formal verification and FPGA bitstream +generation; and container images were distributed through ``docker.io`` only. +Since 2021, tools for ASIC development are also provided, and two other registries are used as well: +``gcr.io`` and ``ghcr.io``. + +HDL Organisation +================ + +.. include:: shields/shields.hdl.inc + +* |SHIELD:HDL:packages| + +* |SHIELD:HDL:awesome| |SHIELD:Site:awesome| + +* |SHIELD:HDL:constraints| |SHIELD:Documentation:constraints| + +* |SHIELD:HDL:smoke-tests| diff --git a/_sources/CollectionsAndArchitectures.rst.txt b/_sources/CollectionsAndArchitectures.rst.txt new file mode 100644 index 000000000..e9e943c90 --- /dev/null +++ b/_sources/CollectionsAndArchitectures.rst.txt @@ -0,0 +1,66 @@ +.. include:: shields/shields.collections.inc + +.. _colections: + +Collections and architectures +============================= + +Images in this repository are organised in *collections* and built for multiple architectures. +A *collection* is a set of images which share a common ancestor; a base layer. +Having images with a common ancestor allows reducing bandwidth and disk usage when pulling several of them. +See `docs.docker.com: About storage drivers | Images and layers `__. + +Collections: + +* ``debian/bookworm`` based on ``ARCHITECTURE/debian:bookworm-slim`` +* ``debian/bullseye`` based on ``ARCHITECTURE/debian:bullseye-slim`` (default) +* ``rockylinux/8`` based on ``ARCHITECTURE/rockylinux:8`` + +.. IMPORTANT:: + Deprecated: + + * *None* + + Removed: + + * ``debian/buster`` based on ``ARCHITECTURE/debian:buster-slim`` + * ``centos/7`` based on ``ARCHITECTURE/centos:7`` + +Architectures: + +* `amd64 `__ +* `arm32v7 `__ +* `arm64v8 `__ +* `ppc64le `__ +* `s390x `__ +* `mips64le `__ +* `riscv64 `__ + +Each image is published to both `gcr.io` and `ghcr.io`: + +.. centered:: |SHIELD:Generic:GCR| |SHIELD:Generic:GHCR| + +However, fields ``ARCHITECURE`` and ``COLLECTION`` are optional because: + +* Images for the default architecture are mirrored to |SHIELD:Mirror:GCR:NoArchitecture| and + |SHIELD:Mirror:GHCR:NoArchitecture|. + +* Images of the default collection are mirrored to |SHIELD:Mirror:GCR:NoCollection| and + |SHIELD:Mirror:GHCR:NoCollection|. + +* Images of the default collection for the default architecture are mirrored to |SHIELD:Mirror:Docker|. + +* Images of the default collection for the default architecture which are not ``build`` or ``pkg`` are mirrored to + |SHIELD:Mirror:GCR:Default| and |SHIELD:Mirror:GHCR:Default|. + +.. important:: + Image names and tags in this documentation are provided without the *registry prefix*. + Hence, one of the prefixes listed above needs to be used when actually pulling/using the images. + See :ref:`User Guide ` for further details. + +.. important:: + The table in :ref:`tools-and-images` shows the tools available in the default collection for the default + architecture. + Some tools are available in a subset of collections or for a subset of architectures only. + Browse the registries and/or the Continuous Integration workflows for finding images available in collections other + than the default. diff --git a/_sources/Doc-License.rst.txt b/_sources/Doc-License.rst.txt new file mode 100644 index 000000000..86dc3d10d --- /dev/null +++ b/_sources/Doc-License.rst.txt @@ -0,0 +1,299 @@ +.. _DOCLICENSE: + +.. Note:: This is a local copy of the `Creative Commons - Attribution 4.0 International (CC BY 4.0) `__. + +.. Attention:: This **CC BY 4.0** license applies only to the **documentation** of this project. + + +Creative Commons Attribution 4.0 International +############################################## + +Creative Commons Corporation (“Creative Commons”) is not a law firm and does not provide legal services or legal advice. +Distribution of Creative Commons public licenses does not create a lawyer-client or other relationship. +Creative Commons makes its licenses and related information available on an “as-is” basis. +Creative Commons gives no warranties regarding its licenses, any material licensed under their terms and conditions, or +any related information. +Creative Commons disclaims all liability for damages resulting from their use to the fullest extent possible. + +Using Creative Commons Public Licenses +====================================== + +Creative Commons public licenses provide a standard set of terms and conditions that creators and other rights holders +may use to share original works of authorship and other material subject to copyright and certain other rights specified +in the public license below. +The following considerations are for informational purposes only, are not exhaustive, and do not form part of our +licenses. + +* **Considerations for licensors:** Our public licenses are intended for use by those authorized to give the public + permission to use material in ways otherwise restricted by copyright and certain other rights. + Our licenses are irrevocable. + Licensors should read and understand the terms and conditions of the license they choose before applying it. + Licensors should also secure all rights necessary before applying our licenses so that the public can reuse the + material as expected. + Licensors should clearly mark any material not subject to the license. + This includes other CC-licensed material, or material used under an exception or limitation to copyright. + `More considerations for licensors `__. + +* **Considerations for the public:** By using one of our public licenses, a licensor grants the public permission to use + the licensed material under specified terms and conditions. + If the licensor’s permission is not necessary for any reason–for example, because of any applicable exception or + limitation to copyright–then that use is not regulated by the license. + Our licenses grant only permissions under copyright and certain other rights that a licensor has authority to grant. + Use of the licensed material may still be restricted for other reasons, including because others have copyright or + other rights in the material. + A licensor may make special requests, such as asking that all changes be marked or described. + Although not required by our licenses, you are encouraged to respect those requests where reasonable. + `More considerations for the public `__. + +Creative Commons Attribution 4.0 International Public License +============================================================= + +By exercising the Licensed Rights (defined below), You accept and agree to be bound by the terms and conditions of this +Creative Commons Attribution 4.0 International Public License ("Public License"). +To the extent this Public License may be interpreted as a contract, You are granted the Licensed Rights in consideration +of Your acceptance of these terms and conditions, and the Licensor grants You such rights in consideration of benefits +the Licensor receives from making the Licensed Material available under these terms and conditions. + +Section 1 – Definitions +----------------------- + +a. **Adapted Material** means material subject to Copyright and Similar Rights that is derived from or based upon the + Licensed Material and in which the Licensed Material is translated, altered, arranged, transformed, or otherwise + modified in a manner requiring permission under the Copyright and Similar Rights held by the Licensor. + For purposes of this Public License, where the Licensed Material is a musical work, performance, or sound recording, + Adapted Material is always produced where the Licensed Material is synched in timed relation with a moving image. + +b. **Adapter's License** means the license You apply to Your Copyright and Similar Rights in Your contributions to + Adapted Material in accordance with the terms and conditions of this Public License. + +c. **Copyright and Similar Rights** means copyright and/or similar rights closely related to copyright including, + without limitation, performance, broadcast, sound recording, and Sui Generis Database Rights, without regard to how + the rights are labeled or categorized. + For purposes of this Public License, the rights specified in Section 2(b)(1)-(2) are not Copyright and Similar Rights. + +d. **Effective Technological Measures** means those measures that, in the absence of proper authority, may not be + circumvented under laws fulfilling obligations under Article 11 of the WIPO Copyright Treaty adopted on December 20, + 1996, and/or similar international agreements. + +e. **Exceptions and Limitations** means fair use, fair dealing, and/or any other exception or limitation to Copyright + and Similar Rights that applies to Your use of the Licensed Material. + +f. **Licensed Material** means the artistic or literary work, database, or other material to which the Licensor applied + this Public License. + +g. **Licensed Rights** means the rights granted to You subject to the terms and conditions of this Public License, which + are limited to all Copyright and Similar Rights that apply to Your use of the Licensed Material and that the Licensor + has authority to license. + +h. **Licensor** means the individual(s) or entity(ies) granting rights under this Public License. + +i. **Share** means to provide material to the public by any means or process that requires permission under the Licensed + Rights, such as reproduction, public display, public performance, distribution, dissemination, communication, or + importation, and to make material available to the public including in ways that members of the public may access the + material from a place and at a time individually chosen by them. + +j. **Sui Generis Database Rights** means rights other than copyright resulting from Directive 96/9/EC of the European + Parliament and of the Council of 11 March 1996 on the legal protection of databases, as amended and/or succeeded, as + well as other essentially equivalent rights anywhere in the world. + +k. **You** means the individual or entity exercising the Licensed Rights under this Public License. + **Your** has a corresponding meaning. + +Section 2 – Scope +----------------- + +a. **License grant.** + + 1. Subject to the terms and conditions of this Public License, the Licensor hereby grants You a worldwide, + royalty-free, non-sublicensable, non-exclusive, irrevocable license to exercise the Licensed Rights in the + Licensed Material to: + + A. reproduce and Share the Licensed Material, in whole or in part; and + + B. produce, reproduce, and Share Adapted Material. + + 2. **Exceptions and Limitations.** + For the avoidance of doubt, where Exceptions and Limitations apply to Your use, this Public License does not + apply, and You do not need to comply with its terms and conditions. + + 3. **Term.** + The term of this Public License is specified in Section 6(a). + + 4. **Media and formats; technical modifications allowed.** + The Licensor authorizes You to exercise the Licensed Rights in all media and formats whether now known or + hereafter created, and to make technical modifications necessary to do so. + The Licensor waives and/or agrees not to assert any right or authority to forbid You from making technical + modifications necessary to exercise the Licensed Rights, including technical modifications necessary to circumvent + Effective Technological Measures. + For purposes of this Public License, simply making modifications authorized by this Section 2(a)(4) never produces + Adapted Material. + + 5. **Downstream recipients.** + + A. **Offer from the Licensor – Licensed Material.** + Every recipient of the Licensed Material automatically receives an offer from the Licensor to exercise the + Licensed Rights under the terms and conditions of this Public License. + + B. **No downstream restrictions.** + You may not offer or impose any additional or different terms or conditions on, or apply any Effective + Technological Measures to, the Licensed Material if doing so restricts exercise of the Licensed Rights by any + recipient of the Licensed Material. + + 6. **No endorsement.** + Nothing in this Public License constitutes or may be construed as permission to assert or imply that You are, or + that Your use of the Licensed Material is, connected with, or sponsored, endorsed, or granted official status by, + the Licensor or others designated to receive attribution as provided in Section 3(a)(1)(A)(i). + +b. **Other rights.** + + 1. Moral rights, such as the right of integrity, are not licensed under this Public License, nor are publicity, + privacy, and/or other similar personality rights; however, to the extent possible, the Licensor waives and/or + agrees not to assert any such rights held by the Licensor to the limited extent necessary to allow You to exercise + the Licensed Rights, but not otherwise. + + 2. Patent and trademark rights are not licensed under this Public License. + + 3. To the extent possible, the Licensor waives any right to collect royalties from You for the exercise of the + Licensed Rights, whether directly or through a collecting society under any voluntary or waivable statutory or + compulsory licensing scheme. + In all other cases the Licensor expressly reserves any right to collect such royalties. + +Section 3 – License Conditions +------------------------------ + +Your exercise of the Licensed Rights is expressly made subject to the following conditions. + +a. **Attribution.** + + 1. If You Share the Licensed Material (including in modified form), You must: + + A. retain the following if it is supplied by the Licensor with the Licensed Material: + + i. identification of the creator(s) of the Licensed Material and any others designated to receive attribution, + in any reasonable manner requested by the Licensor (including by pseudonym if designated); + + ii. a copyright notice; + + iii. a notice that refers to this Public License; + + iv. a notice that refers to the disclaimer of warranties; + + v. a URI or hyperlink to the Licensed Material to the extent reasonably practicable; + + B. indicate if You modified the Licensed Material and retain an indication of any previous modifications; and + + C. indicate the Licensed Material is licensed under this Public License, and include the text of, or the URI or + hyperlink to, this Public License. + + 2. You may satisfy the conditions in Section 3(a)(1) in any reasonable manner based on the medium, means, and context + in which You Share the Licensed Material. + For example, it may be reasonable to satisfy the conditions by providing a URI or hyperlink to a resource that + includes the required information. + + 3. If requested by the Licensor, You must remove any of the information required by Section 3(a)(1)(A) to the extent + reasonably practicable. + + 4. If You Share Adapted Material You produce, the Adapter's License You apply must not prevent recipients of the + Adapted Material from complying with this Public License. + +Section 4 – Sui Generis Database Rights +--------------------------------------- + +Where the Licensed Rights include Sui Generis Database Rights that apply to Your use of the Licensed Material: + +a. for the avoidance of doubt, Section 2(a)(1) grants You the right to extract, reuse, reproduce, and Share all or a + substantial portion of the contents of the database; + +b. if You include all or a substantial portion of the database contents in a database in which You have Sui Generis + Database Rights, then the database in which You have Sui Generis Database Rights (but not its individual contents) is + Adapted Material; and + +c. You must comply with the conditions in Section 3(a) if You Share all or a substantial portion of the contents of the + database. + +For the avoidance of doubt, this Section 4 supplements and does not replace Your obligations under this Public License +where the Licensed Rights include other Copyright and Similar Rights. + +Section 5 – Disclaimer of Warranties and Limitation of Liability +---------------------------------------------------------------- + +a. **Unless otherwise separately undertaken by the Licensor, to the extent possible, the Licensor offers the Licensed + Material as-is and as-available, and makes no representations or warranties of any kind concerning the Licensed + Material, whether express, implied, statutory, or other. + This includes, without limitation, warranties of title, merchantability, fitness for a particular purpose, + non-infringement, absence of latent or other defects, accuracy, or the presence or absence of errors, whether or not + known or discoverable. + Where disclaimers of warranties are not allowed in full or in part, this disclaimer may not apply to You.** + +b. **To the extent possible, in no event will the Licensor be liable to You on any legal theory (including, without + limitation, negligence) or otherwise for any direct, special, indirect, incidental, consequential, punitive, + exemplary, or other losses, costs, expenses, or damages arising out of this Public License or use of the Licensed + Material, even if the Licensor has been advised of the possibility of such losses, costs, expenses, or damages. + Where a limitation of liability is not allowed in full or in part, this limitation may not apply to You.** + +c. The disclaimer of warranties and limitation of liability provided above shall be interpreted in a manner that, to the + extent possible, most closely approximates an absolute disclaimer and waiver of all liability. + +Section 6 – Term and Termination +-------------------------------- + +a. This Public License applies for the term of the Copyright and Similar Rights licensed here. + However, if You fail to comply with this Public License, then Your rights under this Public License terminate + automatically. + +b. Where Your right to use the Licensed Material has terminated under Section 6(a), it reinstates: + + 1. automatically as of the date the violation is cured, provided it is cured within 30 days of Your discovery of the + violation; or + + 2. upon express reinstatement by the Licensor. + + For the avoidance of doubt, this Section 6(b) does not affect any right the Licensor may have to seek remedies for + Your violations of this Public License. + +c. For the avoidance of doubt, the Licensor may also offer the Licensed Material under separate terms or conditions or + stop distributing the Licensed Material at any time; however, doing so will not terminate this Public License. + +d. Sections 1, 5, 6, 7, and 8 survive termination of this Public License. + +Section 7 – Other Terms and Conditions +-------------------------------------- + +a. The Licensor shall not be bound by any additional or different terms or conditions communicated by You unless + expressly agreed. + +b. Any arrangements, understandings, or agreements regarding the Licensed Material not stated herein are separate from + and independent of the terms and conditions of this Public License. + +Section 8 – Interpretation +-------------------------- + +a. For the avoidance of doubt, this Public License does not, and shall not be interpreted to, reduce, limit, restrict, + or impose conditions on any use of the Licensed Material that could lawfully be made without permission under this + Public License. + +b. To the extent possible, if any provision of this Public License is deemed unenforceable, it shall be automatically + reformed to the minimum extent necessary to make it enforceable. + If the provision cannot be reformed, it shall be severed from this Public License without affecting the + enforceability of the remaining terms and conditions. + +c. No term or condition of this Public License will be waived and no failure to comply consented to unless expressly + agreed to by the Licensor. + +d. Nothing in this Public License constitutes or may be interpreted as a limitation upon, or waiver of, any privileges + and immunities that apply to the Licensor or You, including from the legal processes of any jurisdiction or + authority. + +------------------ + +Creative Commons is not a party to its public licenses. +Notwithstanding, Creative Commons may elect to apply one of its public licenses to material it publishes and in those +instances will be considered the “Licensor.” Except for the limited purpose of indicating that material is shared under +a Creative Commons public license or as otherwise permitted by the Creative Commons policies published at `creativecommons.org/policies `__, +Creative Commons does not authorize the use of the trademark “Creative Commons” or any other trademark or logo of +Creative Commons without its prior written consent including, without limitation, in connection with any unauthorized +modifications to any of its public licenses or any other arrangements, understandings, or agreements concerning use of +licensed material. +For the avoidance of doubt, this paragraph does not form part of the public licenses. + +Creative Commons may be contacted at `creativecommons.org `__ diff --git a/_sources/License.rst.txt b/_sources/License.rst.txt new file mode 100644 index 000000000..21d1c2b26 --- /dev/null +++ b/_sources/License.rst.txt @@ -0,0 +1,178 @@ +.. _SRCLICENSE: + +.. Note:: + This is a local copy of the `Apache License Version 2.0 `__. + +.. Attention:: + This **Apache License, 2.0** applies to all **source and configuration files of project**, **except documentation**. + +Apache License 2.0 +################## + +Version 2.0, January 2004 + +TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + +1. Definitions +============== + +**"License"** shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 +through 9 of this document. + +**"Licensor"** shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. + +**"Legal Entity"** shall mean the union of the acting entity and all other entities that control, are controlled by, or +are under common control with that entity. +For the purposes of this definition, **"control"** means (i) the power, direct or indirect, to cause the direction or +management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the +outstanding shares, or (iii) beneficial ownership of such entity. + +**"You"** (or **"Your"**) shall mean an individual or Legal Entity exercising permissions granted by this License. + +**"Source"** form shall mean the preferred form for making modifications, including but not limited to software source +code, documentation source, and configuration files. + +**"Object"** form shall mean any form resulting from mechanical transformation or translation of a Source form, +including but not limited to compiled object code, generated documentation, and conversions to other media types. + +**"Work"** shall mean the work of authorship, whether in Source or Object form, made available under the License, as +indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix +below). + +**"Derivative Works"** shall mean any work, whether in Source or Object form, that is based on (or derived from) the +Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an +original work of authorship. +For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link +(or bind by name) to the interfaces of, the Work and Derivative Works thereof. + +**"Contribution"** shall mean any work of authorship, including the original version of the Work and any modifications +or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the +Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. +For the purposes of this definition, **"submitted"** means any form of electronic, verbal, or written communication sent +to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source +code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of +discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in +writing by the copyright owner as **"Not a Contribution."** + +**"Contributor"** shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been +received by Licensor and subsequently incorporated within the Work. + +2. Grant of Copyright License +============================= + +Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, +non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, +publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object +form. + +3. Grant of Patent License +========================== + +Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, +non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have +made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent +claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of +their Contribution(s) with the Work to which such Contribution(s) was submitted. +If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging +that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, +then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation +is filed. + +4. Redistribution +================= + +You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without +modifications, and in Source or Object form, provided that You meet the following conditions: + +* You must give any other recipients of the Work or Derivative Works a copy of this License; and +* You must cause any modified files to carry prominent notices stating that You changed the files; and +* You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the + Derivative Works; and +* If the Work includes a **"NOTICE"** text file as part of its distribution, then any Derivative Works that You + distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those + notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a + NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided + along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such + third-party notices normally appear. + The contents of the NOTICE file are for informational purposes only and do not modify the License. + You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to + the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the + License. + +You may add Your own copyright statement to Your modifications and may provide additional or different license terms and +conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, +provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this +License. + +5. Submission of Contributions +============================== + +Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the +Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. +Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may +have executed with Licensor regarding such Contributions. + +6. Trademarks +============= + +This License does not grant permission to use the trade names, trademarks, service marks, or product names of the +Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the +content of the NOTICE file. + +7. Disclaimer of Warranty +========================= + +Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its +Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, +without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A +PARTICULAR PURPOSE. +You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks +associated with Your exercise of permissions under this License. + +8. Limitation of Liability +========================== + +In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required +by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be +liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any +character arising as a result of this License or out of the use or inability to use the Work (including but not limited +to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages +or losses), even if such Contributor has been advised of the possibility of such damages. + +9. Accepting Warranty or Additional Liability +============================================= + +While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of +support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. +However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on +behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any +liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or +additional liability. + +Appendix: How to apply the Apache License to your work +====================================================== + +To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets +"[]" replaced with your own identifying information. +(Don't include the brackets!) +The text should be enclosed in the appropriate comment syntax for the file format. +We also recommend that a file or class name and description of purpose be included on the same "printed page" as the +copyright notice for easier identification within third-party archives. + +.. sourcecode:: none + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/_sources/References.rst.txt b/_sources/References.rst.txt new file mode 100644 index 000000000..a7b918da6 --- /dev/null +++ b/_sources/References.rst.txt @@ -0,0 +1,87 @@ +.. _references: + +References +########## + +* :gh:`hadolint/hadolint`: Haskell Dockerfile Linter +* :gh:`0x01be/rudder` +* :gh:`Mluckydwyer/hw-ci` +* :gh:`limerainne/Dockerize-EDA` +* :gh:`alpin3/ulx3s` +* :gh:`vmunoz82/eda_tools` +* :gh:`eine/elide ` +* :gh:`cdsteinkuehler/QuartusBuildVMs` +* :gh:`ghdl/setup-ghdl-ci` +* :gh:`hackfin/ghdl-cross.mk` +* :gh:`rfdonnelly/docker-questa` + +F4PGA +===== + +* :gh:`SymbiFlow/make-env` + + * `bit.ly/edda-conda-eda-spec `__: Conda based system for FPGA and ASIC Dev + * :gh:`Support providing the environment using docker rather than conda #15 ` + +* :gh:`im-tomu/fomu-toolchain` +* :gh:`antmicro/runner` + +distroless +========== + +* :gh:`GoogleContainerTools/distroless` + +Wolfi +----- + +* :gh:`wolfi-dev` +* :gh:`chainguard-dev/melange` +* :gh:`chainguard-dev/apko` + +NixOS +===== + + * `nixos.org/manual: pkgs.dockerTools `__ + * `nix.dev/tutorials: Building and running Docker images `__ + +LibreCores +========== + + * :gh:`librecores/ci-docker-image` + * :gh:`librecores/docker-images` + * LibreCores CI Infrastructure (LCCI): + + * :gh:`lccitools` + * :gh:`lccidocker` + +ASIC +==== + +* :gh:`The-OpenROAD-Project` +* :gh:`efabless/openlane` + + * :gh:`efabless/foss-asic-tools` + * :gh:`hpretl/iic-osic-tools` + +* :gh:`mabrains/OpenAnalogDesign` +* :gh:`RISC-V bring-up tracker ` +* `A Step-by-Step Example: Layout of a CMOS Inverter Using SkyWater Technology (SKW) 130nm Process `__ + +Google Container Regisry (GCR) +============================== + +* :gh:`salrashid123/gcr_stats` +* :gh:`gregsramblings/google-cloud-4-words`: The Google Cloud Developer's Cheat Sheet +* :gh:`gh:google/go-containerregistry: cmd/crane/README.md ` + +USB/IP +====== + +* :gh:`gw0/docker-alpine-kernel-modules` +* :gh:`virtualhere/docker` + + * `Windows USB Server `__ + * `USB Client `__ + * `Linux Console Client `__ + * `Client API `__ + * `hub.docker.com/r/virtualhere/virtualhere-client `__ diff --git a/_sources/ToolsAndImages.rst.txt b/_sources/ToolsAndImages.rst.txt new file mode 100644 index 000000000..7aad02885 --- /dev/null +++ b/_sources/ToolsAndImages.rst.txt @@ -0,0 +1,139 @@ +.. _tools-and-images: + +Tools and images +################ + +.. include:: shields/shields.tools.gen.inc + +By default, latest development versions (branches ``master`` | ``main``) of tools are built. +Then, smoke tests are executed and, if successful, the corresponding images are updated in the registries. +However, some specific tools are *not* built from sources, but installed through (system) package managers. +Those are marked with ``!`` in the table below. + +.. include:: ToolsTable.inc + +.. NOTE:: + Package images are not to be used for executing the tools, but for composing images including multiple resources. + See :ref:`Development:package-images` for further details. + +Images including multiple tools +=============================== + +* **S**\ imulation: + + * |SHIELD:Image:sim| GHDL + NVC + Verilator + Icarus Verilog + * |SHIELD:Image:sim/osvb| CoCoTb, OSVVM and VUnit; on top of ``sim``. + * |SHIELD:Image:sim/scipy-slim| matplotlib and numpy; on top of ``sim``. + * |SHIELD:Image:sim/scipy| ``osvb``; on top of ``sim/scipy-slim``. + * |SHIELD:Image:sim/octave-slim| ``octave``; on top of ``sim``. + * |SHIELD:Image:sim/octave| ``osvb``; on top of ``sim/octave-slim``. + + * |SHIELD:Image:sim/octave/gnuplot| gnuplot; on top of ``sim/octave``. + +* **I**\ mplementation: GHDL + Yosys + nextpnr + + * |SHIELD:Image:impl/ice40| nextpnr-ice40 only, and |SHIELD:Image:impl/icestorm| including icestorm. + * |SHIELD:Image:impl/ecp5| nextpnr-ecp5 only, and |SHIELD:Image:impl/prjtrellis| including prjtrellis. + * |SHIELD:Image:impl/nexus| nextpnr-nexus only, and |SHIELD:Image:impl/prjoxide| including prjoxide. + * |SHIELD:Image:impl/generic| nextpnr-generic only. + * |SHIELD:Image:impl/pnr| all nextpnr targets (ecp5, ice40, nexus, and generic). + * |SHIELD:Image:impl| impl:pnr, including icestorm, prjtrellis and prjoxide. + +* **F**\ ormal: + + * |SHIELD:Image:formal| all solvers depending on Python 3. + * |SHIELD:Image:formal/min| Z3 only. + * |SHIELD:Image:formal/all| all solvers, depending on either Python 2 or Python 3. + +* **P**\ rogramming: |SHIELD:Image:prog| + +.. _tools-and-images:f4pga: + +F4PGA (Conda) +============= + +.. include:: shields/shields.conda.inc + +:awesome:`F4PGA ` is an ecosystem of EDA tools for the development of FPGAs of multiple vendors. +The tools used in the F4PGA ecosystem are packaged by `Antmicro `__ and contributors using +`Conda `__. +The sources of Conda packages for EDA tooling are found in +|SHIELD:HDL:conda-ci|, +|SHIELD:HDL:conda-compilers|, +|SHIELD:HDL:conda-eda|, +|SHIELD:HDL:conda-misc| and +|SHIELD:HDL:conda-prog|. + +.. |SHIELD:F4PGA-Examples:Repository| image:: https://img.shields.io/badge/chipsalliance-f4pga--examples-9258ff.svg?longCache=true&style=flat-square&logo=GitHub&logoColor=f2f1ef&labelColor=5a2ab5 + :alt: 'chipsalliance/f4pga-examples GitHub repository' + :height: 22 + :target: https://github.com/chipsalliance/f4pga-examples + +.. |SHIELD:F4PGA-Examples:Documentation| image:: https://img.shields.io/website.svg?label=f4pga-examples.rtfd.io&longCache=true&style=flat-square&url=http%3A%2F%2Ff4pga-examples.rtfd.io%2Fen%2Flatest%2Findex.html&logo=ReadTheDocs&logoColor=fff + :alt: 'f4pga-examples.rtfd.io' + :height: 22 + :target: https://f4pga-examples.rtfd.io/en/latest/building-examples.html + +In HDL Containers, as a complement to container images based on tools built on other container images, a set of +Conda-based F4PGA images is provided. +The base is |SHIELD:Image:conda|, which includes a `Miniconda `__ setup. +On top of that, the following ready-to-use images allow following the guidelines in +|SHIELD:F4PGA-Examples:Repository| ( |SHIELD:F4PGA-Examples:Documentation| ): + +* |SHIELD:Image:conda/f4pga/xc7/toolchain|: the toolchain for ``FPGA_FAM=xc7``, on top of ``conda``. + The following images are based on this: + + * |SHIELD:Image:conda/f4pga/xc7/a50t|: includes architecture definitions for *xc7a50t*. + + * |SHIELD:Image:conda/f4pga/xc7/a100t|: includes architecture definitions for *xc7a100t*. + + * |SHIELD:Image:conda/f4pga/xc7/a200t|: includes architecture definitions for *xc7a200t*. + + * |SHIELD:Image:conda/f4pga/xc7/z010|: includes architecture definitions for *xc7z010*. + + * |SHIELD:Image:conda/f4pga/xc7/z020|: includes architecture definitions for *xc7z020*. + + * |SHIELD:Image:conda/f4pga/xc7|: includes all the architecture definitions for the *xc7* family, except + *xc7a200t* (due to hard disk limits on GitHub Actions). + +* |SHIELD:Image:conda/f4pga/eos-s3|: the toolchain for ``FPGA_FAM=eos-s3`` and the architecture definitions, on top + of ``conda``. + +.. important:: + The compression ratio of these images is very high compared to other container images. + That is because these include a significant amount of data in text format, which is much better compressed than + binaries. + As a result, the size of the images when pulled is approximately as follows: + + * xc7/toolchain: 3 GB + + * xc7/a50t: 6 GB + + * xc7/a100t: 8.5 GB + + * xc7/a200t: 15 GB + + * xc7/z010: 5 GB + + * xc7/z020: 7.5 GB + + * xc7: 18 GB (would be 30 GB if a200t was included) + + * eos-s3: 2 GB + +.. _tools-and-images:to-do: + +To Do +===== + +* :awesome:`ngspice` + + * :gh:`google/skywater-pdk#374 ` + +* :gh:`BitMan ` +* :awesome:`ecpprog` +* :awesome:`fujprog` +* :awesome:`netlistsvg` +* :gh:`ecpdap ` +* :gh:`LSOracle ` +* :gh:`OpenSourceTCAD ` diff --git a/_sources/dev/CI.rst.txt b/_sources/dev/CI.rst.txt new file mode 100644 index 000000000..2a2ba602b --- /dev/null +++ b/_sources/dev/CI.rst.txt @@ -0,0 +1,57 @@ +.. _Development:continous-integration: + +Continuous Integration (CI) +########################### + +.. NOTE:: + At the moment, there is no triggering mechanism set up between different GitHub repositories. + All the workflows in this repo are triggered by push events, CRON jobs, or manually. + +.. _Development:continous-integration:status: + +Status +====== + +.. include:: ../CIStatus.inc + +.. _Development:continous-integration:structure: + +Structure +========= + +The continuous integration in this repository is based on commands ``pull`` and ``build`` provided by the Python utils +(see :ref:`Development:utils:pyHDLC:Reference`); so, contributors can execute exactly the same commands locally, for +debugging and development. +However, there are several layers of complexity around those commands, in order to precisely decide which images to +build in each workflow/job execution. + +.. figure:: ../_static/img/continuous_integration.svg + :name: img-ci + :alt: Structure of the Continuous Integration (CI) + :width: 100% + :align: center + + Structure of the Continuous Integration (CI) in this repository. + +As shown in :numref:`img-ci`, the following wrappers are used: + +.. TIP:: + In :gh:`pyTooling/Actions: Context `, details about Action and Workflow kinds supported in + GitHub Actions are explained. + See also `Workflow syntax for GitHub Actions `__. + +* :ghsrc:`build-test-release ` is a local Composite Action with three steps, + including setup, pulling/building/testing and releasing. +* :ghsrc:`Common <.github/workflows/common.yml>` is a Reusable Workflow with two jobs. + The first job, named *matrix*, uses ``pyHDLC jobs`` to generate a list of tasks to be used in the second job, named + *jobs* (see `docs.github.com: Workflow syntax for GitHub Actions » jobs..outputs `__). + Then, the Composite Action is used in each of the dynamically generated jobs. +* :ghsrc:`Dispatch <.github/workflows/dispatch.yml>` is a Dispatchable Workflow, which calls the Reusable Workflow. + In practice, *Dispatch* documents the internal triggering interface, but it is not used explicitly. + There are dozens of workflows (one per tool or group) which are equivalent to *Dispatch* with some hardcoded inputs. + Those are triggered through scheduled (CRON) events, by pushes, by Pull Requests or manually. + +Since most of the complexity of the orchestration is defined in the YAML configuration file used by pyHDLC, reading +:ref:`Development:configuration` is strongly recommended. +As shown in :numref:`img-ci`, data from the configuration file is used in the Reusable Workflow *Common* and in the +build step of the Composite Action *build-test-release*. diff --git a/_sources/dev/Contributing.rst.txt b/_sources/dev/Contributing.rst.txt new file mode 100644 index 000000000..bed0b8324 --- /dev/null +++ b/_sources/dev/Contributing.rst.txt @@ -0,0 +1,296 @@ +.. _Development:contributing: + +Contributing +############ + +As explained in :ref:`Tools and images ` and in the :ref:`User Guide `, +multiple collections of images are provided. +For each collection, a set of base images is provided, which are to be used for building and for runtime. +These are defined in ``base.dockerfile``. +See, for instance, :ghsrc:`debian-bookworm/base.dockerfile `. +All the images in the ecosystem are based on these: + +.. include:: ../shields/shields.build.gen.inc + +* |SHIELD:Image:build/base| Debian Bookworm, Debian Bullseye or Rocky Linux 8, with updated ``ca-certificates``, + ``curl`` and Python 3. + +* |SHIELD:Image:build/build| based on ``base``, includes ``clang`` and ``make``. + +* |SHIELD:Image:build/dev| based on ``build``, includes ``cmake``, ``libboost-all-dev`` and ``python3-dev``. + +Then, for each project/tool there are dockerfiles (one for each collection), a GitHub Actions workflow, and one or more +test scripts. +Those are used for: + +* Tools are built using ``REGISTRY/[ARCHITECTURE/][COLLECTION/]build`` images. + +* Package images based on ``scratch`` (and/or other reusable packages) are produced. + +* Ready-to-use images based on the runtime base image (``REGISTRY/[ARCHITECTURE/][COLLECTION/]build/base``) are produced. + +* Ready-to-use images are tested before uploading. + +The :ref:`Package images ` created in some dockerfiles/workflows are based on ``scratch`` +and contain pre-built assets. +Therefore, they are not really useful *per se*, but meant to be used for building other. +In fact, multiple tools are merged into ready-to-use images for common use cases (such as ``impl``, +``formal`` or ``prog``). + +.. IMPORTANT:: + Before working on adding or extending the support for a tool, please check the + :gh:`issues ` and :gh:`pull requests `; + :gh:`open an issue ` + or `let us know through the chat `__. + Someone might be working on that already! + +.. NOTE:: + Currently, many projects don't use containers at all, hence, all images are generated in this repository. + However, the workload is expected to be distributed between multiple projects in the ecosystem. + + +.. _Development:contributing:Dockerfiles: + +Dockerfiles +=========== + +Two kinds of `Dockerfile `__ definitions are supported by the utils +used in this repository: single-file solutions, or aided by additional assets. +Nonetheless, all dockerfiles use, at least, two or three stages: + +* A global argument named ``REGISTRY`` defines the default registry path and collection to be used. + +* One stage, named ``build``, based on ``$REGISTRY/build/base`` or ``$REGISTRY/build/build`` or ``$REGISTRY/build/dev``, + is used to (optionally) install build dependencies, and to actually build the tool. + + * The tool/project is built using the standard ``PREFIX``, but installed to a custom location using ``DESTDIR``. + See :ref:`Package images `. + +* If the tool/project is to be packaged, one stage based on image ``scratch`` is named ``pkg`` and it contains the + artifacts of the build stage only. + + * Tool artifacts are copied from the build stage using ``COPY --from=STAGE_NAME``. + +* If the tool/project is to be used standalone, a final stage based on image ``$REGISTRY/build/base`` is used to + (optionally) install runtime dependencies, to copy the build artifacts from the build stage, and to (optionally) set + the default command for the image. + +.. NOTE:: + In some dockerfiles, global argument ``IMAGE`` is used to compose stages on top of multiple intermediate images. + + +.. _Development:contributing:Dockerfiles:single-file: + +Single-file example +------------------- + +Some tools are defined in a dockerfile only, without any additional assets. +In those cases, the dockerfile is named after the name of the main tool/image built there. + +.. sourcecode:: dockerfile + :caption: Reference Dockerfile to build a TOOL and generate a regular image and a package image. + + ARG REGISTRY='gcr.io/hdl-containers/debian/bookworm' + + #-- + + FROM $REGISTRY/build/build AS build + + RUN apt-get update -qq \ + && DEBIAN_FRONTEND=noninteractive apt-get -y install --no-install-recommends \ + ... \ + && apt-get autoclean && apt-get clean && apt-get -y autoremove \ + && rm -rf /var/lib/apt/lists/* + + RUN git clone REPOSITORY_URL /tmp/TOOL \ + && cd /tmp/TOOL \ + && ./configure \ + && make -j$(nproc) \ + && make DESTDIR=/opt/TOOL install + + #--- + + FROM scratch AS pkg + COPY --from=build /opt/TOOL /TOOL + + #--- + + FROM $REGISTRY/build/base + + RUN apt-get update -qq \ + && DEBIAN_FRONTEND=noninteractive apt-get -y install --no-install-recommends \ + ... \ + && apt-get autoclean && apt-get clean && apt-get -y autoremove \ + && rm -rf /var/lib/apt/lists/* + + COPY --from=build /opt/TOOL / + CMD ["TOOL"] + +.. NOTE:: + Typically, stage ``pkg`` is used as a target to build a package image, and the dockerfile is used without a target in + order to build the regular image for the tool. + However, some tools/groups require additional stages, and some other don't have the package or the regular stage. + + +.. _Development:contributing:Dockerfiles:with-assets: + +Example with HDLC script +------------------------ + +On the other hand, the dockerfiles to build tools with additional assets are named ``Dockerfile`` and located in a +subdir under the collection directory, named after the name of the main tool/image built there. +Those are typically used along with a shell script named ``HDLC``. +The structure of these dockerfiles is similar to the :ref:`Development:contributing:Dockerfiles:single-file`, however, +BuilKit's ``--mount`` feature is used to source a helper script (``HDLC``) without creating additional stages/steps (see +:ref:`Development:contributing:BuildKit`). +A similar strategy can be used to run or copy additional assets into the images. + +.. sourcecode:: bash + :caption: Reference HDLC script to decouple dependency lists and build steps from the Dockerfile. + + makedepends=( + ... + ) + + build() { + mkdir /tmp/TOOL + cd /tmp/TOOL + git clone REPOSITORY_URL ./ + ./configure + make -j$(nproc) + make DESTDIR=/opt/TOOL install + } + + depends=( + ... + ) + +.. NOTE:: + The default shell in the collections used in this repository is set to ``bash``. + Therefore, arrays and other bash extensions are supported in these scripts. + +.. sourcecode:: dockerfile + :caption: + Reference Dockerfile to build a TOOL and generate a regular image and a package image, using an HDLC script and + BuildKit mount features. + + ARG REGISTRY='gcr.io/hdl-containers/debian/bookworm' + + #--- + + FROM $REGISTRY/build/build AS build + + RUN --mount=type=bind,target=/tmp/ctx . /tmp/ctx/HDLC \ + && mkdir -p /usr/share/man/man1/ \ + && apt-get update -qq \ + && DEBIAN_FRONTEND=noninteractive apt-get -y install --no-install-recommends ${makedepends[@]} \ + && apt-get autoclean && apt-get clean && apt-get -y autoremove \ + && update-ca-certificates \ + && rm -rf /var/lib/apt/lists/* + + RUN --mount=type=bind,target=/tmp/ctx . /tmp/ctx/HDLC && build + + #--- + + FROM scratch AS pkg + COPY --from=build /opt/TOOL /TOOL + + #--- + + FROM $REGISTRY/build/base + + RUN --mount=type=bind,target=/tmp/ctx . /tmp/ctx/HDLC \ + && apt-get update -qq \ + && DEBIAN_FRONTEND=noninteractive apt-get -y install --no-install-recommends ${depends[@]} \ + && apt-get autoclean && apt-get clean && apt-get -y autoremove \ + && rm -rf /var/lib/apt/lists/* + + COPY --from=build /opt/TOOL / + CMD ["TOOL"] + + +.. _Development:contributing:BuildKit: + +BuildKit +======== + +The usage of dockerfiles in this repository relies on the image build engine making an analysis and pruning of the stages. +Furthermore, option ``--mount`` used in some of the dockerfiles requires `docs.docker.com: BuildKit `__. +Therefore, enabling BuildKit is required in order to build the images. + +Depending on the version of Docker on your host or CI service, BuildKit features might need to be enabled explicitly. +As explained in `docs.docker.com: To enable BuildKit builds `__, either set the ``DOCKER_BUILDKIT=1`` environment variable, or set the daemon feature to +``true`` in the JSON configuration file: (``{ "features": { "buildkit": true } }``). + +Find further details about BuildKit's mount syntax in :gh:`moby/buildkit: frontend/dockerfile/docs/syntax.md `. + +* :gh:`bind ` +* :gh:`cache ` +* :gh:`tmpfs ` +* :gh:`secret ` +* :gh:`ssh ` +* :gh:`here-documents ` + +.. NOTE:: + In order to use those features, apart from using BuildKit ``# syntax=docker/dockerfile:1.3`` might need to be added as + the first line of the Dockerfile. + That depends on the version of Docker. + Recent versions should not require it. + +.. _Development:contributing:checklist: + +Step by step checklist +====================== + +.. role:: maroon + +1. Create or update dockerfile(s). + + * For each tool and collection, a Dockerfile recipe exists. + Find details about the requirements when writing dockerfiles in :ref:`Development:contributing:Dockerfiles`. + + * Optionally, add tools to multiple collections at the same time. + That is, create one dockerfile for each collection. + + * Some tools are to be added to existing images which include several tools (coloured :maroon:`BROWN` in the + :ref:`Graphs `). + After creating the dockerfile where the corresponding package image is defined, add + ``COPY --from=$REGISTRY/pkg/TOOL_NAME`` statements to the dockerfiles of multi-tool images. + +2. Build and test the dockerfile(s) locally. + Use helper scripts from subdir :ghsrc:`utils/`, as explained in :ref:`Development:utils`. + + * If a new tool was added, or a new image is to be generated, a test script needs to be added to :ghsrc:`test/`. + See :ref:`Development:test` for naming guidelines. + + * Be careful with the order. + If you add a new tool and include it in one of the multi-tool images, the package image needs to be built first. + +3. Create or update workflow(s). + + * For each tool or multi-tool image, a GitHub Actions workflow is added to :ghsrc:`.github/workflows <.github/workflows/>`. + In each workflow, multiple images produced from stages of the corresponding dockerfile are built, tested and pushed. + Scripts from :ghsrc:`utils/` are used. + Find details at :ref:`Development:continous-integration:structure`. + + * Copying some of the existing workflows in this repo and adapting it is suggested. + + * If necessary, update the :ghsrc:`config.yml ` to override the defaults or to define new + job/task lists. + +4. Update the documentation. + + * If a new tool was added, + + * Ensure that the tool is listed at :gh:`hdl/awesome`, since that's where all the tool/projects in + :ref:`tools-and-images` point to. + + * If a tool from the :ref:`tools-and-images:to-do` list was added, remove it from the list. + + * Add a shield/badge to :ref:`Continuous Integration (CI) » Status ` by + editing variable ``CIWorkflows`` in :ghsrc:`doc/conf.py`. + + * Edit :ghsrc:`doc/tools.yml `. + The table in :ref:`Tools and images ` is autogenerated from that YAML file. + + * Update the :ref:`Graphs ` in :ghsrc:`doc/graph/`. diff --git a/_sources/dev/GraphGeneration.rst.txt b/_sources/dev/GraphGeneration.rst.txt new file mode 100644 index 000000000..6762b82ed --- /dev/null +++ b/_sources/dev/GraphGeneration.rst.txt @@ -0,0 +1,122 @@ +.. _Development:graph-generation: + +Graph generation/parsing +======================== + +Currently, the :ref:`Graphs ` are updated manually. +That is error prone, because the information shown in them is also defined in the dockerfiles, configuration YAML file +and CI workflows. +Ideally, graphs would be auto-generated by parsing/analysing those. +However, the complexity of the graphs is non-trivial. +There are many tools for automatically generating diagrams from large datasets, but not so many with features for +visualizing complex hierarchical nets. +The requirements we are willing to satisfy are the following: + +* Open source tool and format(s). +* Generates diagrams programmatically from a text representation and/or through a Python or Golang API. +* Supports hierarchical DAGs with multiple levels of hierarchy. I.e. (nested) clusters which are nodes and have ports. +* Generates SVG of the hierarchical DAGs. +* Supports node styles (shape and colour). +* Ideally: + + * Clusters are collapsible when shown in an HTML site. + * Text in the nodes can be links to web sites. + +So far, the following options were analysed: + +* `Graphviz `__ + + * :gh:`windler/dotgraph` + * `blockdiag `__ + +* `Gephi `__ + + * :gh:`gh:gephi/gephi#1594 ` + +* `aafigure `__ +* `draw.io `__ + + * :gh:`jgraph/mxgraph` + +* `yEd `__ +* `texample.net/tikz `__ +* :gh:`ajstarks/svgo` +* :gh:`kieler/elkjs` (:gh:`Nic30/d3-hwschematic`, :gh:`nturley/netlistsvg`) +* :gh:`gh:dagrejs/dagre-d3 ` +* `graphdracula.net `__ + +Graphviz and Gephi are probably the most known tools for generating all kinds of diagrams. +Unfortunately, none of them supports hierarchical clusters as required in this use case. +The same issue applies to aafigure and graphdracula. + +yEd is a very interesting product, and fits most (if not all) the technical constraints. +However, it's not open source. +The editor is freeware and the SDK is paid. +For programmatic generation, the SDK is required. +The draw.io/mxgraph toolkit seems to be the most similar open source solution. +However, using SDKs for building custom interactive diagraming tools feels overkill in this use case. +We don't need graphs to be editable through a GUI! + +Similarly, Tikz and SVG generation libraries (such as svgo) can be used for having the work done, but they require +writing a non-negligible plumbing which would increase the maintenance burden, instead of reducing it. +This would be a last resort. + +Although d3-hwschematic and netlistsvg are very different use cases, the JSON format used in elkjs might be suitable. + +dagre-d3 is meant for DAGs and it supports nested clusters (experimentally, +`Dagre D3 Demo: Clusters `__). +Although clusters seem not to have ports, it might be an easy update from the current solution. +Since it's a client-side JS library, it does not write an SVG file to disk by default, but achieving it should be +trivial. + +As a result, it seems that the most suitable solution might be using the JSON format from elkjs, either with elkjs or +with dagre-d3. +Yet, generating an SVG programmatically seems not to be as straightforward as using other solutions such as Graphviz's +``dot``. +The following references illustrate advanced features for building custom views/GUIs/editors: + +* :gh:`kieler/elkjs` + +* `eclipse.org/elk/documentation: JSON format `__ + +* `rtsys.informatik.uni-kiel.de/elklive `__ + +* `rtsys.informatik.uni-kiel.de/elklive/elkgraph `__ + +* :gh:`eclipse/sprotty` + +However, it seems that writing a JSON is cumbersome. +On the one hand, some nodes need to have a size for them to be shown. +On the other hand, it seems not possible to draw edges across hierarchies. +Ports need to be explicitly defined for that purpose. +Therefore, the complexity of generating the JSON given a set of nodes, edges and clusters is non-trivial. + +.. NOTE:: + Branch :gh:`utils/pyHDLC/map.py@pymap ` contains work in progress. + First, ``GenerateMap`` builds a DAG by parsing the dockerfiles. + Then, ``report`` prints the content in the terminal, for debugging purposes. + Last, ``dotgraph`` generates a Graphviz dot diagram. + The dot diagram does not have clusters. + We want to add those by parsing the GitHub Actions workflows (see below). + However, we want to first reproduce the dot output using elkjs. + See function ``elkjsgraph`` in :gh:`utils/pyHDLC/map.py@pymap `. + Do you want to give it a try? :gh:`Let us know ` or `join the chat `__! + +Reading dockerfiles +------------------- + +One of the two sources of information for the graph are dockerfiles. +As far as we are aware, there is no tool for generating a DAG from the stages of a dockerfile. +However, :gh:`asottile/dockerfile` is an interesting Python module which wraps docker/moby's golang parser. +Hence, it can be used for getting the stages and ``COPY --from`` or ``--mount`` statements for generating the hierarchy. +See :ghsrc:`utils/pyHDLC/map.py `. + +Reading GitHub Actions workflow files +------------------------------------- + +The second source of information are CI workflow files. +Since YAML is used, reading it from any language is trivial, however, semantic analysis needs to be done. +Particularly, variables from ``matrix`` need to be expanded/replaced. +:gh:`nektos/act` is written in golang, and it allows executing GitHub Actions workflows locally. +Therefore, it might have the required features. +However, as far as we are aware, it's not meant to be used as a library. diff --git a/_sources/dev/Graphs.rst.txt b/_sources/dev/Graphs.rst.txt new file mode 100644 index 000000000..66c3ca221 --- /dev/null +++ b/_sources/dev/Graphs.rst.txt @@ -0,0 +1,80 @@ +.. _Development:graphs: + +Graphs +###### + +Understanding how all the pieces in this project fit together might be daunting for newcomers. +Fortunately, there is a map for helping maintainers and contributors traveling through the ecosystem. +Subdir :ghsrc:`doc/graph/ ` contains the sources of :wikipedia:`directed graphs `, where the +relations between workflows, dockerfiles, images and tests are shown. + +(`Graphviz `__)'s ``digraph`` format is used, hence, graphs can be rendered to multiple image +formats. +The output shown in :numref:`img-graph` describes which images are created in each map. +See the details in the figure corresponding to the name of the subgraph: +Base (:numref:`img-graph-base`), +Sim (:numref:`img-graph-sim`), +Synth (:numref:`img-graph-synth`), +Impl (:numref:`img-graph-impl`), +Formal (:numref:`img-graph-formal`), +ASIC (:numref:`img-graph-asic`), and +F4PGA (:numref:`img-graph-f4pga`). +Multiple colours and arrow types are used for describing different dependency types. +All of those are explained in the legend: :numref:`img-graph-legend`. + +.. IMPORTANT:: + These graphs represent a single collection of images (the *virtual* aggregation of others). + In practice, some tools might be missing in some collections. + For instance, a tool might be available in Debian Buster based containers, but not in CentOS 7. + That info is not tracked in the graphs yet. + Please, see whether a dockerfile exists in the corresponding subdir. + +.. graphviz:: ../graph/graph.dot + :name: img-graph + :align: center + :caption: Subgraphs and images + +.. graphviz:: ../graph/base.dot + :name: img-graph-base + :align: center + :caption: Base: workflows, dockerfiles, images and tests. + +.. graphviz:: ../graph/sim.dot + :name: img-graph-sim + :align: center + :caption: Sim: workflows, dockerfiles, images and tests. + +.. graphviz:: ../graph/synth.dot + :name: img-graph-synth + :align: center + :caption: Synth: workflows, dockerfiles, images and tests. + +.. graphviz:: ../graph/impl.dot + :name: img-graph-impl + :align: center + :caption: Impl: workflows, dockerfiles, images and tests. + +.. graphviz:: ../graph/formal.dot + :name: img-graph-formal + :align: center + :caption: Formal: workflows, dockerfiles, images and tests. + +.. graphviz:: ../graph/asic.dot + :name: img-graph-asic + :align: center + :caption: ASIC: workflows, dockerfiles, images and tests. + +.. graphviz:: ../graph/f4pga.dot + :name: img-graph-f4pga + :align: center + :caption: F4PGA: workflows, dockerfiles, images and tests. + +.. graphviz:: ../graph/legend.dot + :name: img-graph-legend + :align: center + :caption: Legend of the directed graph. + +.. toctree:: + :hidden: + + GraphGeneration diff --git a/_sources/dev/PackageImages.rst.txt b/_sources/dev/PackageImages.rst.txt new file mode 100644 index 000000000..2a3298dad --- /dev/null +++ b/_sources/dev/PackageImages.rst.txt @@ -0,0 +1,38 @@ +.. _Development:package-images: + +Package images +############## + +.. role:: blue + +Each EDA tool/project is built once only for each collection and architecture in this image/container ecosystem. +However, some (many) of the tools need to be included in multiple images for different purposes. +Moreover, it is desirable to keep build recipes separated, in order to better understand the dependencies of each +tool/project. +Therefore, ``REGISTRY/[ARCHITECTURE/][COLLECTION/]pkg/`` images are created/used (coloured :blue:`BLUE` in the +:ref:`Graphs `). +These are all based on ``scratch`` and are not runnable. +Instead, they contain pre-built artifacts, to be then added into other images through ``COPY --from=``. + +Since ``pkg`` images are not runnable *per se*, but an intermediate utility, the usage of environment variables +``PREFIX`` and ``DESTDIR`` in the dockerfiles might be misleading. +All the tools in the ecosystem are expected to be installed into ``/usr/local``, the standard location for user built +tools on most GNU/Linux distributions. +Hence: + +* ``PREFIX`` should typically not need to be modified. + Most of the tools will default to ``PREFIX=/usr/local``, which is correct. + Yet, some tools might default to ``/`` or ``/usr``. + In those cases, setting it explicitly is required. + +* ``DESTDIR`` must be set to an empty location when calling ``make install`` or when copying the artifacts otherhow. + The content of the corresponding package images is taken from that empty location. + Therefore, if ``DESTDIR`` was unset, the artifacts of the tool might potentially be mixed with other existing assets + in ``/usr/local``. + In most of the dockerfiles, ``/opt/TOOL_NAME`` is used as the temporary empty location. + +Despite the usage of these variables being documented in `GNU Coding Standards `__, +``DESTDIR`` seems not to be very used, except by packagers. +As a result, contributors might need to patch the build scripts upstream. +Sometimes ``DESTDIR`` is not supported at all, or it is supported but some lines in the makefiles are missing it. +Do not hesitate to reach for help through the issues or the chat! diff --git a/_sources/dev/Tasks.rst.txt b/_sources/dev/Tasks.rst.txt new file mode 100644 index 000000000..8579ecb72 --- /dev/null +++ b/_sources/dev/Tasks.rst.txt @@ -0,0 +1,44 @@ +.. _Development:tasks: + +Tasks +##### + +.. _Development:credentials: + +Credentials +=========== + +In order to push images to container registries, credentials are required. +The default ``github.token`` is enough for publishing to GHCR, however, docker.io and GCR do need specific secrets to be +setup. + +In The Google Cloud Platform (GCP), credentials are managed through a CLI tool named ``gcloud``. +Periodically, a new key needs to be created and the outdated ones need to be removed. + +.. sourcecode:: shell + + # List the projects: + ~ gcloud projects list + + # Set the project for the current workspace: + ~ gcloud config set project [PROJECT_ID] + + # List the available service accounts: + ~ gcloud iam service-accounts list + + # Note the e-mail of the service account, and list the keys: + ~ gcloud iam service-accounts keys list --iam-account=[NAME]@[PROJECT_ID].iam.gserviceaccount.com + + # Create a new key and save it to a file: + ~ gcloud iam service-accounts keys create keyfile.json --iam-account [NAME]@[PROJECT_ID].iam.gserviceaccount.com + + # Go to organisation secrets and update the GCR_JSON_KEY secret with the whole content of the JSON file + # https://github.com/organizations/hdl/settings/secrets/actions + + # Remove the JSON file + ~ rm keyfile.json + + # Remove other (expired) keys + ~ gcloud iam service-accounts keys delete KEY_ID --iam-account [NAME]@[PROJECT_ID].iam.gserviceaccount.com + +See `cloud.google.com/container-registry/docs/advanced-authentication#json-key `__. diff --git a/_sources/dev/Utils.rst.txt b/_sources/dev/Utils.rst.txt new file mode 100644 index 000000000..65e749f7b --- /dev/null +++ b/_sources/dev/Utils.rst.txt @@ -0,0 +1,235 @@ +.. _Development:utils: + +Utils +##### + +.. toctree:: + :hidden: + + pyHDLC_Reference + +Some helper shell and Python utilities are available in :ghsrc:`utils/bin ` and +:ghsrc:`utils/pyHDLC `, respectively. +A :ghsrc:`utils/setup.sh ` script is provided for installing Python dependencies and adding the ``bin`` +subdir to the ``PATH``. +Since ``pip`` is used for installing :ghsrc:`utils/pyHDLC/requirements.txt `, it is +desirable to create a virtual environment (`docs.python.org/3/library/venv `__) +before running ``setup.sh``: + +.. sourcecode:: shell + + virtualenv venv + source venv/bin/activate + ./utils/setup.sh + +.. _Development:utils:pyHDLC: + +.. autoprogram:: pyHDLC.cli:CLI().MainParser + :prog: pyHDLC + :groups: + + +.. _Development:test: + +Smoke-tests +=========== + +There is a test script in :ghsrc:`test/ ` for each image in this ecosystem, according to the following +convention: + +* Scripts for package images, ``/[ARCHITECTURE/][COLLECTION/]pkg/TOOL_NAME[/SUBNAME]``, are named + ``TOOL_NAME[--SUBNAME].pkg.sh``. + +* Scripts for other images, ``/[ARCHITECTURE/][COLLECTION/]NAME[/SUBNAME]``, are named ``NAME[--SUBNAME].sh``. + +* Other helper scripts are named ``_*.sh``. + +Furthermore, :gh:`hdl/smoke-tests` is a submodule of this repository (:ghsrc:`test/smoke-tests `). +Smoke-tests contains fine-grained tests that cover the most important functionalities of the tools. +Those are used in other packaging projects too. +Therefore, container tests are expected to execute the smoke-tests corresponding to the tools available in the image, +before executing more specific tests. + +``pyHDLC test`` allows testing the runnable and package images. +It is used in CI but can be useful locally too. +When using `pyHDLC test`, ``DirName`` allows to optionally specify the name of the directory inside the package image +which needs to be copied to the temporary image for testing. +By default, the escaped name of the image is used as the location. + + +.. _Development:inspect: + +Inspect +======= + +.. role:: green + +.. role:: maroon + +All ready-to-use images (coloured :green:`GREEN` or :maroon:`BROWN` in the :ref:`Graphs `) are +runnable. +Therefore, users/contributors can run containers and test the tools interactively or through scripting. +However, since ``pkg`` images are not runnable, creating another image is required in order to inspect their content +from a container. +For instance: + +.. sourcecode:: dockerfile + + FROM busybox + COPY --from=REGISTRY/pkg/TOOL_NAME /TOOL_NAME / + +In fact, ``pyHDLC test`` uses a similar dockerfile for running ``.pkg.sh`` scripts from :ghsrc:`test/ `. +See :ref:`Test `. + +Alternatively, or as a complement, :gh:`wagoodman/dive` is a lightweight tool with a nice terminal based GUI for +exploring layers and contents of container images. +It can be downloaded as a tarball/zipfile, or used as a container: + +.. sourcecode:: bash + + docker run --rm -it \ + -v //var/run/docker.sock://var/run/docker.sock \ + wagoodman/dive \ + REGISTRY/[ARCHITECTURE/][COLLECTION/]IMAGE[:TAG] + +.. figure:: ../_static/img/dive.png + :alt: gh:wagoodman/dive + :width: 100% + :align: center + + Inspection of ``REGISTRY/pkg/yosys`` with :gh:`wagoodman/dive`. + +:ghsrc:`dockerDive ` is a wrapper around the wagoodman/dive container, which supports one +or two arguments for specifying the image to be inspected. +The default registry prefix is ``gcr.io/hdl-containers``, however, it can be overriden through envvar ``HDL_REGISTRY``. + +For instance, inspect image ``gcr.io/hdl-containers/debian/bullseye/ghdl``: + +.. sourcecode:: bash + + dockerDive debian/bullseye ghdl + +or, inspect any image from any registry: + +.. sourcecode:: bash + + HDL_REGISTRY=docker.io dockerDive python:slim-bookworm + + +.. _Development:configuration: + +YAML Configuration File +======================= + +Most of the complexity regarding images, dockerfiles, arguments and jobs is defined in the YAML configuration file +(see :ghsrc:`config.yml `), which contains two data fields: + +* **defaults**: which dockerfile and (optionally) target stage or base image to be used when building "non-regular" images. + That is, using a non-empty target, an specific base image, etc. + If the image name is not defined in this field, the dockerfile defaults to the image name and the target depends on + option *package*. +* **jobs**: which images and for which collections and architectures to build each list of tasks. + For convenienve, the keywords match the name of the main tool/group in the list. + +.. TIP:: + Contributors will find that field **anchors** in :ghsrc:`config.yml ` is ignored by pyHDLC + commands when analyzing the file. + That's because anchors are used to reduce the verbosity of the YAML file, but they are resolved by the loader. + + * `yaml.org `__ + * `blog.daemonl.com: YAML - Anchors, References, Extend `__ + +The fields and types supported in the configuration file are defined through dataclasses (see :ref:`Development:utils:pyHDLC:Reference:Dataclasses`). +However, some details about the syntax can be non-obvious. +See the clarifications below: + +.. _Development:configuration:defaults: + +Defaults +-------- + +If the following conditions are met, images need not to be explicitly listed in the configuration file: + +* The dockerfile to be used matches the image name. +* The default target is empty, or ``pkg`` if a package image is being built. +* The ``argimg`` is empty. + +Otherwise, a dictionary is expected, with the fields that need to be overriden (``dockerfile``, ``target`` and/or +``argimg``). + +.. _Development:configuration:jobs: + +Jobs +---- + +There are four kinds of job lists: + +* **default**: two images are built for each collection and architecture, a regular image and a package image. +* **pkgonly**: a package image is built for each collection and architecture. +* **runonly**: a regular image is built for each collection and architecture. +* **custom**: the lists of jobs/tasks are declared as cross-products, and ``exclude`` is supported. + +In **default**, **pkgonly** and **runonly**, a dictionary of lists is expected per keyword; each key corresponding to a +collection and the lists specifying the architectures. +Conversely, in **custom** three fields are expected: + +* **sys**: a dictionary of lists, such as the one expected in **default**, **pkgonly** and **runonly**. + +* **images**: either a list or a list of lists of image names. + + * If a single list is provided, all images are built sequentially in a single job: + + .. sourcecode:: yaml + + images: + - formal/min + - formal + - formal/all + + If a list of lists is provided, each of them is built sequentially in a different job: + + .. sourcecode:: yaml + + images: + - [ conda/f4pga/xc7/a50t ] + - [ conda/f4pga/xc7/a100t ] + - [ conda/f4pga/xc7/a200t ] + + * Argument substitution is supported through ``${arg}``. + If any of the items in the list is a dictionary, instead of a string, it is used as an argument in the substitution + phase. + If the same argument is provided multiple times, a cross-product of the arguments and the lists is produced: + + .. sourcecode:: yaml + + images: + - sim/${prj}-slim + - sim/${prj} + - prj: scipy + - prj: octave + + .. sourcecode:: yaml + + images: + - pkg/nextpnr/${arch} + - nextpnr/${arch} + - nextpnr/${prj} + - { arch: ice40, prj: icestorm } + - { arch: ecp5, prj: prjtrellis } + +* **exclude**: optionally, declare combinations of *sys* and *images* which should be excluded from the produced + cross-products. + For example: + + .. sourcecode:: yaml + + images: + - pkg/nextpnr/${arch} + - nextpnr/${arch} + - nextpnr/${prj} + - { arch: ecp5, prj: prjtrellis } + - { arch: nexus, prj: prjoxide } + sys: *SysDebianAmd64 + exclude: + - sys: { debian/buster: [amd64] } + params: { arch: nexus, prj: prjoxide } diff --git a/_sources/dev/pyHDLC_Reference.rst.txt b/_sources/dev/pyHDLC_Reference.rst.txt new file mode 100644 index 000000000..c0bb8c580 --- /dev/null +++ b/_sources/dev/pyHDLC_Reference.rst.txt @@ -0,0 +1,21 @@ +.. _Development:utils:pyHDLC:Reference: + +pyHDLC Reference +================ + +.. _Development:utils:pyHDLC:Reference:Functions: + +Functions +--------- + +.. automodule:: pyHDLC + :exclude-members: Config, ConfigDefaultImageItem, ConfigDefaults, ConfigJobs, ConfigJobsCustomItem, ConfigJobsCustomExcludeItem + +.. _Development:utils:pyHDLC:Reference:Dataclasses: + +Dataclasses +----------- + +.. automodule:: pyHDLC + :exclude-members: BuildImage, GenerateJobList, PullImage, PushImage, TestImage + :noindex: diff --git a/_sources/index.rst.txt b/_sources/index.rst.txt new file mode 100644 index 000000000..b52a09f00 --- /dev/null +++ b/_sources/index.rst.txt @@ -0,0 +1,71 @@ +HDL Containers +############## + +.. include:: shields/shields.index.inc + +.. centered:: + |SHIELD:Code:Repository| + |SHIELD:Code:License| + |SHIELD:Documentation:License| + |SHIELD:Community:Chat| + +.. raw:: html + +
+ +.. image:: _static/banner_path.svg + :width: 500 px + :align: center + :target: https://github.com/hdl/containers + +.. raw:: html + +
+ +
+ +This repository contains scripts and recipes for building, testing and deploying `OCI `__ +images (aka `Docker `__ | `Podman `__ images) including open source +:wikipedia:`Electronic Design Automation (EDA) ` tooling. +All the images are pushed to `gcr.io/hdl-containers `__, and mirrored to +`ghcr.io/hdl `__ and `hub.docker.com/u/hdlc `__: + +.. centered:: |SHIELD:Registry:GCR| |SHIELD:Registry:GHCR| |SHIELD:Registry:Docker| + +.. toctree:: + :hidden: + + Home + CollectionsAndArchitectures + ToolsAndImages + About + +.. toctree:: + :caption: User Guide + :hidden: + + ug/index + ug/FineGrained + ug/AllInOne + ug/GUI + USB/IP + +.. toctree:: + :caption: Development + :hidden: + + dev/Contributing + dev/Graphs + dev/PackageImages + dev/Utils + dev/CI + dev/Tasks + +.. toctree:: + :caption: Appendix + :hidden: + + References + License + Doc-License + diff --git a/_sources/ug/AllInOne.rst.txt b/_sources/ug/AllInOne.rst.txt new file mode 100644 index 000000000..0db0c601c --- /dev/null +++ b/_sources/ug/AllInOne.rst.txt @@ -0,0 +1,89 @@ +.. _UserGuide:all-in-one: + +All-in-one images +################# + +.. role:: maroon + +.. NOTE:: + These images are coloured :maroon:`BROWN` in the :ref:`Development:graphs`. + +Multiple tools from fine-grained images are included in larger images for common use cases. +These are named ``REGISTRY_PREFIX/[ARCHITECTURE/][COLLECTION/]MAIN_USAGE``. +This is the recommended approach for users who are less familiar with containers and want a quick replacement for +full-featured virtual machines. +Coherently, some common Unix tools (such as make or cmake) are also included in these all-in-one images. + +* :gh:`tmeissner/formal_hw_verification`: + the CI workflow uses image ``REGISTRY_PREFIX/[ARCHITECTURE/][COLLECTION/]formal/all`` along with GitHub Actions' + *Docker Step* syntax. + +* :gh:`stnolting/neorv32-setups`: + the implementation workflow (for generating bitstreams from VHDL sources) uses image + ``REGISTRY_PREFIX/[ARCHITECTURE/][COLLECTION/]impl`` along with GitHub Actions' *Docker Step* syntax. + +.. TIP:: + * :gh:`pyTooling/Actions ` + * `docs.github.com: Learn GitHub Actions » Referencing a container on Docker Hub `__ + + +F4PGA +===== + +.. |SHIELD:F4PGA:Examples| image:: https://img.shields.io/website.svg?label=f4pga-examples.rtfd.io&longCache=true&style=flat-square&url=http%3A%2F%2Ff4pga-examples.rtfd.io%2Fen%2Flatest%2Findex.html&logo=ReadTheDocs&logoColor=fff + :alt: 'f4pga-examples.rtfd.io' + :height: 22 + :target: https://f4pga-examples.rtfd.io/en/latest/building-examples.html + +As explained in :ref:`F4PGA (Conda) `, multiple ready-to-use images are provided +including Miniconda, F4PGA toolchains and architecture definitions for Xilinx's **xc7** or QuickLogic's **eos-s3** +devices. +These container images are expected to be used as explained in |SHIELD:F4PGA:Examples|, assuming that the +environment is prepared already and available in the PATH. +Hence, the Conda environment can be activated straightaway. +See, for instance: + +.. sourcecode:: bash + + :~# git clone https://github.com/chipsalliance/f4pga-examples + ... + :~# cd f4pga-examples + + :~/f4pga-examples# docker run --rm -it \ + -v /$(pwd)://wrk \ + -w //wrk \ + gcr.io/hdl-containers/conda/f4pga/xc7/a100t + + ... + (xc7) root@c3d4dd1d97cc:/wrk# TARGET="arty_100" make -C xc7/picosoc_demo/ + ... + (xc7) root@c3d4dd1d97cc:/wrk# ls -1 xc7/picosoc_demo/build/arty_100/ + constraints.place + fasm.log + pack.log + packing_pin_util.rpt + place.log + pre_pack.report_timing.setup.rpt + report_timing.hold.rpt + report_timing.setup.rpt + report_unconstrained_timing.hold.rpt + report_unconstrained_timing.setup.rpt + route.log + top.bit + top.eblif + top.fasm + top.ioplace + top.json + top.json.carry_fixup.json + top.json.carry_fixup_out.json + top.json.post_abc9.ilang + top.json.pre_abc9.ilang + top.net + top.net.post_routing + top.place + top.route + top.sdc + top_io.json + top_synth.log + top_synth.v + top_synth.v.premap.v diff --git a/_sources/ug/FineGrained.rst.txt b/_sources/ug/FineGrained.rst.txt new file mode 100644 index 000000000..8a46ef11a --- /dev/null +++ b/_sources/ug/FineGrained.rst.txt @@ -0,0 +1,74 @@ +.. _UserGuide:fine-grained: + +Fine-grained pulling +#################### + +.. role:: green + +.. NOTE:: + These images are coloured :green:`GREEN` in the :ref:`Development:graphs`. + +Ready-to-use images are provided for each tool, which contain the tool and the dependencies for it to run successfully. +These are typically named ``REGISTRY_PREFIX/[ARCHITECTURE/][COLLECTION/]TOOL_NAME``. + +.. HINT:: + Since all the images in each collection are based on the same root image, pulling multiple images involves retrieving + a few additional layers only. + Therefore, this is the recommended approach for CI or other environments with limited resources. + +Makefiles +========= + +* :gh:`ghdl-yosys-blink: Makefile `: + an example showcasing how to use this fine-grained approach with a makefile. + The same make based strategy is used in :gh:`gh:antonblanchard/microwatt `. + +* :gh:`marph91/icestick-remote`: the CI workflow for synthesis uses this approach. + +Those projects use a partial Makefile such as the following, for optionally wrapping regular tool calls: + +.. sourcecode:: bash + + CONTAINER_ENGINE ?= docker + + PWD = $(shell pwd) + CONTAINER_ARGS = run --rm -v $(PWD):/wrk -w /wrk + + GHDL = $(CONTAINER_ENGINE) $(CONTAINER_ARGS) gcr.io/hdl-containers/ghdl/yosys ghdl + YOSYS = $(CONTAINER_ENGINE) $(CONTAINER_ARGS) gcr.io/hdl-containers/ghdl/yosys yosys + NEXTPNR = $(CONTAINER_ENGINE) $(CONTAINER_ARGS) gcr.io/hdl-containers/nextpnr/ice40 nextpnr-ice40 + ICEPACK = $(CONTAINER_ENGINE) $(CONTAINER_ARGS) gcr.io/hdl-containers/icestorm icepack + +Python launchers +================ + +There are several EDA tooling management projects which allow wrapping the execution of commands on containers. +Any of them can be used with the containers provided in this repository. + +EDA²'s Docker abstraction +------------------------- + +Layer CLITool of EDA² (see :doc:`edaa:index` and :doc:`clitool:index`), provides ``Docker.py`` to be combined with any +of the tools supported in the same repository. + +Edalize's Launcher +------------------ + +Edalize (see :doc:`edalize:index`) provides ``EDALIZE_LAUNCHER``, which allows overriding each command: +:gh:`olofk/edalize: search?q=EDALIZE_LAUNCHER `. +:gh:`el_docker ` is a built-in launcher for Docker. +See also: + +* `olofkindgren.blogspot.com: Edalize 0.3.0 `__ +* :gh:`Support for open source EDA tools from containers (gh:olofk/edalize#221) ` +* :gh:`librecores/eda-container-wrapper` +* `carlosedp/runme.py `__ + + * :gh:`Improve launcher script with new containers (gh:olofk/edalize#299) ` + +PyFPGA's OpenFlow +----------------- + +PyFPGA's OpenFlow (see :doc:`pyfpga:index` and :gh:`PyFPGA/openflow`) allows running tools in containers, similarly to +``el_docker``. +In fact, OpenFlow can be used along with :gh:`Edalize `'s ``EDALIZE_LAUNCHER`` environment variable. diff --git a/_sources/ug/GUI.rst.txt b/_sources/ug/GUI.rst.txt new file mode 100644 index 000000000..3ba15bb88 --- /dev/null +++ b/_sources/ug/GUI.rst.txt @@ -0,0 +1,23 @@ +.. _UserGuide:GUI: + +Tools with GUI +############## + +By default, tools with Graphical User Interface (GUI) cannot be used in containers, because there is no graphical +server. +However, there are multiple alternatives for making an :wikipedia:`X11 ` or +:wikipedia:`Wayland ` server visible to the container. +:gh:`mviereck/x11docker` and :gh:`mviereck/runx` are full-featured helper scripts for setting up the environment and +running GUI applications and desktop environments in OCI containers. +GNU/Linux and Windows hosts are supported, and security related options are provided (such as cookie authentication). +Users of GTKWave, KLayout, nextpnr and other tools will likely want to try x11docker (and runx). + +.. figure:: ../_static/img/x11docker_klayout.gif + :alt: Block diagram of the OSVB + :width: 100% + :align: center + + Execution of KLayout in a container on Windows 10 (MSYS2/MINGW64) with + :gh:`mviereck/x11docker`, :gh:`mviereck/runx` and `VcxSrv `__. + +* `x11docker: Run GUI applications in Docker containers; Journal of Open Source Hardware `__ diff --git a/_sources/ug/USBIP.rst.txt b/_sources/ug/USBIP.rst.txt new file mode 100644 index 000000000..7a7caec80 --- /dev/null +++ b/_sources/ug/USBIP.rst.txt @@ -0,0 +1,132 @@ +.. _UserGuide:USBIP: + +USB/IP protocol support for Docker Desktop +########################################## + +Virtual Machines used on Windows for running either Windows Subsystem for Linux (WSL) or Docker Desktop by default do +not support sharing USB devices with the containers. +Only those that are identified as storage or COM devices can be bind directly. +See :gh:`microsoft/WSL#5158 `. +That prevents using arbitrary drivers inside the containers. +As a result, most container users on Windows do install board programming tools through MSYS2 (see :gh:`hdl/MINGW-packages`). + +Nevertheless, USB/IP protocol allows passing USB device(s) from server(s) to client(s) over the network. +As explained at `kernel.org/doc/readme/tools-usb-usbip-README `__, +on GNU/Linux, USB/IP is implemented as a few kernel modules with companion userspace tools. +However, the default underlying Hyper-V VM machine (based on `Alpine Linux `__) shipped with +*Docker Desktop* (aka *docker-for-win*/*docker-for-mac*) does not include the required kernel modules. +Fortunately, privileged docker containers allow installing missing kernel modules. +The shell script in :ghsrc:`usbip/ ` supports customising the native VM in *Docker Desktop* for adding +USB over IP support. + +.. sourcecode:: bash + + # Build kernel modules: in an unprivileged `alpine` container, retrieve the corresponding + # kernel sources, copy runtime config and enable USB/IP features, build `drivers/usb/usbip` + # and save `*.ko` artifacts to relative subdir `dist` on the host. + ./run.sh -m + + # Load/insert kernel modules: use a privileged `busybox` container to load kernel modules + # `usbip-core.ko` and `vhci-hcd.ko` from relative subdir `dist` on the host to the + # underlying Hyper-V VM. + ./run.sh -l + + # Build image `vhcli`, using `busybox` as a base, and including the + # [VirtualHere](https://www.virtualhere.com) GNU/Linux client for x86_64 along with the + # `*.ko` files built previously through `./run.sh -m`. + ./run.sh -v + +.. NOTE:: + For manually selecting configuration options, building and inserting modules, see detailed procedure in + :gh:`gw0/docker-alpine-kernel-modules#usage `. + +.. NOTE:: + Modules will be removed when the Hyper-V VM is restarted (i.e. when the host or *Docker Desktop* are restarted). + For a *permanent* install, modules need to be copied to ``/lib/modules`` in the underlying VM, and ``/stc/modules`` + needs to be configured accordingly. + Use ``$(command -v winpty) docker run --rm -it --privileged --pid=host alpine nsenter -t 1 -m -u -n -i sh`` to access + a shell with full permissions on the VM. + +.. NOTE:: + USB/IP is supported in Renode too. + See `renode.rtfd.io/en/latest/tutorials/usbip `__. + +Example session +=============== + +How to connect a *Docker Desktop* container to *VirtualHere USB Server for Windows*. + +* Start `vhusbdwin64.exe `__ on the host +* Ensure that the firewall is not blocking it. + +.. sourcecode:: bash + + # Start container named 'vhclient' + ./run.sh -s + # List usb devices available in the container + ./run.sh -e lsusb + # LIST hubs/devices found by vhclient + ./run.sh -c "LIST" + # Manually add to the client the hub/server running on the host + ./run.sh -c "MANUAL HUB ADD,host.docker.internal:7575" + + sleep 10 + + ./run.sh -c "LIST" + # Use a remote device in the container + ./run.sh -c "USE,.1" + + sleep 4 + + # Check that the device is now available in the container + ./run.sh -e lsusb + +.. IMPORTANT:: + There is an issue/bug in *Docker Desktop* (:gh:`docker/for-win#4548 `) that prevents the + container where the USB device is added from seeing it. + The workaround is to execute the board programming tool in a sibling container. + For example: ``docker run --rm --privileged */prog iceprog -t``. + +Alternatives +============ + +.. IMPORTANT:: + Using `VirtualHere `__ is the only solution we could successfully use in order to share + FTDI devices (:ref:`boards:icestick` boards) between a Windows 10 host and a Docker + Desktop container running on the same host. + However, since the USB/IP protocol is open source, we'd like to try any other (preferredly open and free source) + server for Windows along with the default GNU/Linux usbip-tools. + Should you know about any, please :gh:`let us know `! + + We are aware of :gh:`cezuni/usbip-win`. + However, it seems to be in very early development state and the install procedure is quite complex yet. + + +Serial (COM) devices can be shared with open source tools. +On the one hand, `hub4com `__ from project +`com0com `__ allows to publish a port through a RFC2217 server. +On the other hand, ``socat`` can be used to link the network connection to a virtual ``tty`` device. + +.. sourcecode:: + + HOST CONTAINER + --------------------------- ------------------------------------- + USB <-> | COMX <-> RFC2217 server | <-> network <-> | socat <-> /dev/ttySY <-> app/tool | + --------------------------- ------------------------------------- + + +.. sourcecode:: doscon + + > REM On the Windows host + > com2tcp-rfc2217.bat COM + +.. sourcecode:: bash + + # In the container + socat pty,link=/dev/ttyS tcp:host.docker.internal: + +It might be possible to replace ``hub4com`` with :gh:`pyserial/pyserial`. +However, we did not test it. + +* `pyserial.rtfd.io: Single-port TCP/IP - serial bridge (RFC 2217) `__ +* :gh:`espressif/esp-idf#204 ` diff --git a/_sources/ug/index.rst.txt b/_sources/ug/index.rst.txt new file mode 100644 index 000000000..c9f2b407d --- /dev/null +++ b/_sources/ug/index.rst.txt @@ -0,0 +1,29 @@ +.. _UserGuide: + +Introduction +############ + + +.. important:: + Image names and tags in this documentation are provided without the *registry prefix*. + Hence, ``REGISTRY/[ARCHITECTURE/][COLLECTION/]*`` needs to be prefixed to the image names shown in :ref:`tools-and-images`. + +Official guidelines and recommendations for using containers suggest keeping them small and specific for each tool/purpose +(see `docs.docker.com: Best practices for writing Dockerfiles `__). +That fits well with the field of web *microservices*, which communicate through TCP/IP and which need to be composed, +scaled and balanced all around the globe. + +However, tooling in other camps is expected to communicate using a shared or local filesystem and/or pipes; therefore, +many users treat containters as *lightweight virtual machines*. +That is, they put all the tools in a single (heavy) container. +Those containers are typically not moved around as frequently as *microservices*, but cached on developers' workstations. + +In this project, both paradigms are supported; fine-grained images are available, as well as all-in-one images. + +.. note:: + ``hdl`` examples in :gh:`im-tomu/fomu-workshop` showcase a Makefile based solution that supports both strategies: + the fine-grained pulling and the all-in-one approach. + An environment variable (``CONTAINER_ENGINE``) is used for selecting which approach to use. + For didactic purposes, both of them are used in Continuous Integration (CI). + See :gh:`im-tomu/fomu-workshop: .github/workflows/test.yml `. + diff --git a/_static/_sphinx_javascript_frameworks_compat.js b/_static/_sphinx_javascript_frameworks_compat.js new file mode 100644 index 000000000..8549469dc --- /dev/null +++ b/_static/_sphinx_javascript_frameworks_compat.js @@ -0,0 +1,134 @@ +/* + * _sphinx_javascript_frameworks_compat.js + * ~~~~~~~~~~ + * + * Compatability shim for jQuery and underscores.js. + * + * WILL BE REMOVED IN Sphinx 6.0 + * xref RemovedInSphinx60Warning + * + */ + +/** + * select a different prefix for underscore + */ +$u = _.noConflict(); + + +/** + * small helper function to urldecode strings + * + * See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/decodeURIComponent#Decoding_query_parameters_from_a_URL + */ +jQuery.urldecode = function(x) { + if (!x) { + return x + } + return decodeURIComponent(x.replace(/\+/g, ' ')); +}; + +/** + * small helper function to urlencode strings + */ +jQuery.urlencode = encodeURIComponent; + +/** + * This function returns the parsed url parameters of the + * current request. Multiple values per key are supported, + * it will always return arrays of strings for the value parts. + */ +jQuery.getQueryParameters = function(s) { + if (typeof s === 'undefined') + s = document.location.search; + var parts = s.substr(s.indexOf('?') + 1).split('&'); + var result = {}; + for (var i = 0; i < parts.length; i++) { + var tmp = parts[i].split('=', 2); + var key = jQuery.urldecode(tmp[0]); + var value = jQuery.urldecode(tmp[1]); + if (key in result) + result[key].push(value); + else + result[key] = [value]; + } + return result; +}; + +/** + * highlight a given string on a jquery object by wrapping it in + * span elements with the given class name. + */ +jQuery.fn.highlightText = function(text, className) { + function highlight(node, addItems) { + if (node.nodeType === 3) { + var val = node.nodeValue; + var pos = val.toLowerCase().indexOf(text); + if (pos >= 0 && + !jQuery(node.parentNode).hasClass(className) && + !jQuery(node.parentNode).hasClass("nohighlight")) { + var span; + var isInSVG = jQuery(node).closest("body, svg, foreignObject").is("svg"); + if (isInSVG) { + span = document.createElementNS("http://www.w3.org/2000/svg", "tspan"); + } else { + span = document.createElement("span"); + span.className = className; + } + span.appendChild(document.createTextNode(val.substr(pos, text.length))); + node.parentNode.insertBefore(span, node.parentNode.insertBefore( + document.createTextNode(val.substr(pos + text.length)), + node.nextSibling)); + node.nodeValue = val.substr(0, pos); + if (isInSVG) { + var rect = document.createElementNS("http://www.w3.org/2000/svg", "rect"); + var bbox = node.parentElement.getBBox(); + rect.x.baseVal.value = bbox.x; + rect.y.baseVal.value = bbox.y; + rect.width.baseVal.value = bbox.width; + rect.height.baseVal.value = bbox.height; + rect.setAttribute('class', className); + addItems.push({ + "parent": node.parentNode, + "target": rect}); + } + } + } + else if (!jQuery(node).is("button, select, textarea")) { + jQuery.each(node.childNodes, function() { + highlight(this, addItems); + }); + } + } + var addItems = []; + var result = this.each(function() { + highlight(this, addItems); + }); + for (var i = 0; i < addItems.length; ++i) { + jQuery(addItems[i].parent).before(addItems[i].target); + } + return result; +}; + +/* + * backward compatibility for jQuery.browser + * This will be supported until firefox bug is fixed. + */ +if (!jQuery.browser) { + jQuery.uaMatch = function(ua) { + ua = ua.toLowerCase(); + + var match = /(chrome)[ \/]([\w.]+)/.exec(ua) || + /(webkit)[ \/]([\w.]+)/.exec(ua) || + /(opera)(?:.*version|)[ \/]([\w.]+)/.exec(ua) || + /(msie) ([\w.]+)/.exec(ua) || + ua.indexOf("compatible") < 0 && /(mozilla)(?:.*? rv:([\w.]+)|)/.exec(ua) || + []; + + return { + browser: match[ 1 ] || "", + version: match[ 2 ] || "0" + }; + }; + jQuery.browser = {}; + jQuery.browser[jQuery.uaMatch(navigator.userAgent).browser] = true; +} diff --git a/_static/banner.svg b/_static/banner.svg new file mode 100644 index 000000000..66b4ee9a2 --- /dev/null +++ b/_static/banner.svg @@ -0,0 +1,370 @@ + + + + + + + image/svg+xml + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + HDLContainers + + + + + + diff --git a/_static/banner_path.svg b/_static/banner_path.svg new file mode 100644 index 000000000..d72727aa4 --- /dev/null +++ b/_static/banner_path.svg @@ -0,0 +1,412 @@ + + + + + + + image/svg+xml + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/_static/basic.css b/_static/basic.css new file mode 100644 index 000000000..4e9a9f1fa --- /dev/null +++ b/_static/basic.css @@ -0,0 +1,900 @@ +/* + * basic.css + * ~~~~~~~~~ + * + * Sphinx stylesheet -- basic theme. + * + * :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ + +/* -- main layout ----------------------------------------------------------- */ + +div.clearer { + clear: both; +} + +div.section::after { + display: block; + content: ''; + clear: left; +} + +/* -- relbar ---------------------------------------------------------------- */ + +div.related { + width: 100%; + font-size: 90%; +} + +div.related h3 { + display: none; +} + +div.related ul { + margin: 0; + padding: 0 0 0 10px; + list-style: none; +} + +div.related li { + display: inline; +} + +div.related li.right { + float: right; + margin-right: 5px; +} + +/* -- sidebar --------------------------------------------------------------- */ + +div.sphinxsidebarwrapper { + padding: 10px 5px 0 10px; +} + +div.sphinxsidebar { + float: left; + width: 230px; + margin-left: -100%; + font-size: 90%; + word-wrap: break-word; + overflow-wrap : break-word; +} + +div.sphinxsidebar ul { + list-style: none; +} + +div.sphinxsidebar ul ul, +div.sphinxsidebar ul.want-points { + margin-left: 20px; + list-style: square; +} + +div.sphinxsidebar ul ul { + margin-top: 0; + margin-bottom: 0; +} + +div.sphinxsidebar form { + margin-top: 10px; +} + +div.sphinxsidebar input { + border: 1px solid #98dbcc; + font-family: sans-serif; + font-size: 1em; +} + +div.sphinxsidebar #searchbox form.search { + overflow: hidden; +} + +div.sphinxsidebar #searchbox input[type="text"] { + float: left; + width: 80%; + padding: 0.25em; + box-sizing: border-box; +} + +div.sphinxsidebar #searchbox input[type="submit"] { + float: left; + width: 20%; + border-left: none; + padding: 0.25em; + box-sizing: border-box; +} + + +img { + border: 0; + max-width: 100%; +} + +/* -- search page ----------------------------------------------------------- */ + +ul.search { + margin: 10px 0 0 20px; + padding: 0; +} + +ul.search li { + padding: 5px 0 5px 20px; + background-image: url(file.png); + background-repeat: no-repeat; + background-position: 0 7px; +} + +ul.search li a { + font-weight: bold; +} + +ul.search li p.context { + color: #888; + margin: 2px 0 0 30px; + text-align: left; +} + +ul.keywordmatches li.goodmatch a { + font-weight: bold; +} + +/* -- index page ------------------------------------------------------------ */ + +table.contentstable { + width: 90%; + margin-left: auto; + margin-right: auto; +} + +table.contentstable p.biglink { + line-height: 150%; +} + +a.biglink { + font-size: 1.3em; +} + +span.linkdescr { + font-style: italic; + padding-top: 5px; + font-size: 90%; +} + +/* -- general index --------------------------------------------------------- */ + +table.indextable { + width: 100%; +} + +table.indextable td { + text-align: left; + vertical-align: top; +} + +table.indextable ul { + margin-top: 0; + margin-bottom: 0; + list-style-type: none; +} + +table.indextable > tbody > tr > td > ul { + padding-left: 0em; +} + +table.indextable tr.pcap { + height: 10px; +} + +table.indextable tr.cap { + margin-top: 10px; + background-color: #f2f2f2; +} + +img.toggler { + margin-right: 3px; + margin-top: 3px; + cursor: pointer; +} + +div.modindex-jumpbox { + border-top: 1px solid #ddd; + border-bottom: 1px solid #ddd; + margin: 1em 0 1em 0; + padding: 0.4em; +} + +div.genindex-jumpbox { + border-top: 1px solid #ddd; + border-bottom: 1px solid #ddd; + margin: 1em 0 1em 0; + padding: 0.4em; +} + +/* -- domain module index --------------------------------------------------- */ + +table.modindextable td { + padding: 2px; + border-collapse: collapse; +} + +/* -- general body styles --------------------------------------------------- */ + +div.body { + min-width: 360px; + max-width: 800px; +} + +div.body p, div.body dd, div.body li, div.body blockquote { + -moz-hyphens: auto; + -ms-hyphens: auto; + -webkit-hyphens: auto; + hyphens: auto; +} + +a.headerlink { + visibility: hidden; +} + +h1:hover > a.headerlink, +h2:hover > a.headerlink, +h3:hover > a.headerlink, +h4:hover > a.headerlink, +h5:hover > a.headerlink, +h6:hover > a.headerlink, +dt:hover > a.headerlink, +caption:hover > a.headerlink, +p.caption:hover > a.headerlink, +div.code-block-caption:hover > a.headerlink { + visibility: visible; +} + +div.body p.caption { + text-align: inherit; +} + +div.body td { + text-align: left; +} + +.first { + margin-top: 0 !important; +} + +p.rubric { + margin-top: 30px; + font-weight: bold; +} + +img.align-left, figure.align-left, .figure.align-left, object.align-left { + clear: left; + float: left; + margin-right: 1em; +} + +img.align-right, figure.align-right, .figure.align-right, object.align-right { + clear: right; + float: right; + margin-left: 1em; +} + +img.align-center, figure.align-center, .figure.align-center, object.align-center { + display: block; + margin-left: auto; + margin-right: auto; +} + +img.align-default, figure.align-default, .figure.align-default { + display: block; + margin-left: auto; + margin-right: auto; +} + +.align-left { + text-align: left; +} + +.align-center { + text-align: center; +} + +.align-default { + text-align: center; +} + +.align-right { + text-align: right; +} + +/* -- sidebars -------------------------------------------------------------- */ + +div.sidebar, +aside.sidebar { + margin: 0 0 0.5em 1em; + border: 1px solid #ddb; + padding: 7px; + background-color: #ffe; + width: 40%; + float: right; + clear: right; + overflow-x: auto; +} + +p.sidebar-title { + font-weight: bold; +} +nav.contents, +aside.topic, +div.admonition, div.topic, blockquote { + clear: left; +} + +/* -- topics ---------------------------------------------------------------- */ +nav.contents, +aside.topic, +div.topic { + border: 1px solid #ccc; + padding: 7px; + margin: 10px 0 10px 0; +} + +p.topic-title { + font-size: 1.1em; + font-weight: bold; + margin-top: 10px; +} + +/* -- admonitions ----------------------------------------------------------- */ + +div.admonition { + margin-top: 10px; + margin-bottom: 10px; + padding: 7px; +} + +div.admonition dt { + font-weight: bold; +} + +p.admonition-title { + margin: 0px 10px 5px 0px; + font-weight: bold; +} + +div.body p.centered { + text-align: center; + margin-top: 25px; +} + +/* -- content of sidebars/topics/admonitions -------------------------------- */ + +div.sidebar > :last-child, +aside.sidebar > :last-child, +nav.contents > :last-child, +aside.topic > :last-child, +div.topic > :last-child, +div.admonition > :last-child { + margin-bottom: 0; +} + +div.sidebar::after, +aside.sidebar::after, +nav.contents::after, +aside.topic::after, +div.topic::after, +div.admonition::after, +blockquote::after { + display: block; + content: ''; + clear: both; +} + +/* -- tables ---------------------------------------------------------------- */ + +table.docutils { + margin-top: 10px; + margin-bottom: 10px; + border: 0; + border-collapse: collapse; +} + +table.align-center { + margin-left: auto; + margin-right: auto; +} + +table.align-default { + margin-left: auto; + margin-right: auto; +} + +table caption span.caption-number { + font-style: italic; +} + +table caption span.caption-text { +} + +table.docutils td, table.docutils th { + padding: 1px 8px 1px 5px; + border-top: 0; + border-left: 0; + border-right: 0; + border-bottom: 1px solid #aaa; +} + +th { + text-align: left; + padding-right: 5px; +} + +table.citation { + border-left: solid 1px gray; + margin-left: 1px; +} + +table.citation td { + border-bottom: none; +} + +th > :first-child, +td > :first-child { + margin-top: 0px; +} + +th > :last-child, +td > :last-child { + margin-bottom: 0px; +} + +/* -- figures --------------------------------------------------------------- */ + +div.figure, figure { + margin: 0.5em; + padding: 0.5em; +} + +div.figure p.caption, figcaption { + padding: 0.3em; +} + +div.figure p.caption span.caption-number, +figcaption span.caption-number { + font-style: italic; +} + +div.figure p.caption span.caption-text, +figcaption span.caption-text { +} + +/* -- field list styles ----------------------------------------------------- */ + +table.field-list td, table.field-list th { + border: 0 !important; +} + +.field-list ul { + margin: 0; + padding-left: 1em; +} + +.field-list p { + margin: 0; +} + +.field-name { + -moz-hyphens: manual; + -ms-hyphens: manual; + -webkit-hyphens: manual; + hyphens: manual; +} + +/* -- hlist styles ---------------------------------------------------------- */ + +table.hlist { + margin: 1em 0; +} + +table.hlist td { + vertical-align: top; +} + +/* -- object description styles --------------------------------------------- */ + +.sig { + font-family: 'Consolas', 'Menlo', 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', monospace; +} + +.sig-name, code.descname { + background-color: transparent; + font-weight: bold; +} + +.sig-name { + font-size: 1.1em; +} + +code.descname { + font-size: 1.2em; +} + +.sig-prename, code.descclassname { + background-color: transparent; +} + +.optional { + font-size: 1.3em; +} + +.sig-paren { + font-size: larger; +} + +.sig-param.n { + font-style: italic; +} + +/* C++ specific styling */ + +.sig-inline.c-texpr, +.sig-inline.cpp-texpr { + font-family: unset; +} + +.sig.c .k, .sig.c .kt, +.sig.cpp .k, .sig.cpp .kt { + color: #0033B3; +} + +.sig.c .m, +.sig.cpp .m { + color: #1750EB; +} + +.sig.c .s, .sig.c .sc, +.sig.cpp .s, .sig.cpp .sc { + color: #067D17; +} + + +/* -- other body styles ----------------------------------------------------- */ + +ol.arabic { + list-style: decimal; +} + +ol.loweralpha { + list-style: lower-alpha; +} + +ol.upperalpha { + list-style: upper-alpha; +} + +ol.lowerroman { + list-style: lower-roman; +} + +ol.upperroman { + list-style: upper-roman; +} + +:not(li) > ol > li:first-child > :first-child, +:not(li) > ul > li:first-child > :first-child { + margin-top: 0px; +} + +:not(li) > ol > li:last-child > :last-child, +:not(li) > ul > li:last-child > :last-child { + margin-bottom: 0px; +} + +ol.simple ol p, +ol.simple ul p, +ul.simple ol p, +ul.simple ul p { + margin-top: 0; +} + +ol.simple > li:not(:first-child) > p, +ul.simple > li:not(:first-child) > p { + margin-top: 0; +} + +ol.simple p, +ul.simple p { + margin-bottom: 0; +} +aside.footnote > span, +div.citation > span { + float: left; +} +aside.footnote > span:last-of-type, +div.citation > span:last-of-type { + padding-right: 0.5em; +} +aside.footnote > p { + margin-left: 2em; +} +div.citation > p { + margin-left: 4em; +} +aside.footnote > p:last-of-type, +div.citation > p:last-of-type { + margin-bottom: 0em; +} +aside.footnote > p:last-of-type:after, +div.citation > p:last-of-type:after { + content: ""; + clear: both; +} + +dl.field-list { + display: grid; + grid-template-columns: fit-content(30%) auto; +} + +dl.field-list > dt { + font-weight: bold; + word-break: break-word; + padding-left: 0.5em; + padding-right: 5px; +} + +dl.field-list > dd { + padding-left: 0.5em; + margin-top: 0em; + margin-left: 0em; + margin-bottom: 0em; +} + +dl { + margin-bottom: 15px; +} + +dd > :first-child { + margin-top: 0px; +} + +dd ul, dd table { + margin-bottom: 10px; +} + +dd { + margin-top: 3px; + margin-bottom: 10px; + margin-left: 30px; +} + +dl > dd:last-child, +dl > dd:last-child > :last-child { + margin-bottom: 0; +} + +dt:target, span.highlighted { + background-color: #fbe54e; +} + +rect.highlighted { + fill: #fbe54e; +} + +dl.glossary dt { + font-weight: bold; + font-size: 1.1em; +} + +.versionmodified { + font-style: italic; +} + +.system-message { + background-color: #fda; + padding: 5px; + border: 3px solid red; +} + +.footnote:target { + background-color: #ffa; +} + +.line-block { + display: block; + margin-top: 1em; + margin-bottom: 1em; +} + +.line-block .line-block { + margin-top: 0; + margin-bottom: 0; + margin-left: 1.5em; +} + +.guilabel, .menuselection { + font-family: sans-serif; +} + +.accelerator { + text-decoration: underline; +} + +.classifier { + font-style: oblique; +} + +.classifier:before { + font-style: normal; + margin: 0 0.5em; + content: ":"; + display: inline-block; +} + +abbr, acronym { + border-bottom: dotted 1px; + cursor: help; +} + +/* -- code displays --------------------------------------------------------- */ + +pre { + overflow: auto; + overflow-y: hidden; /* fixes display issues on Chrome browsers */ +} + +pre, div[class*="highlight-"] { + clear: both; +} + +span.pre { + -moz-hyphens: none; + -ms-hyphens: none; + -webkit-hyphens: none; + hyphens: none; + white-space: nowrap; +} + +div[class*="highlight-"] { + margin: 1em 0; +} + +td.linenos pre { + border: 0; + background-color: transparent; + color: #aaa; +} + +table.highlighttable { + display: block; +} + +table.highlighttable tbody { + display: block; +} + +table.highlighttable tr { + display: flex; +} + +table.highlighttable td { + margin: 0; + padding: 0; +} + +table.highlighttable td.linenos { + padding-right: 0.5em; +} + +table.highlighttable td.code { + flex: 1; + overflow: hidden; +} + +.highlight .hll { + display: block; +} + +div.highlight pre, +table.highlighttable pre { + margin: 0; +} + +div.code-block-caption + div { + margin-top: 0; +} + +div.code-block-caption { + margin-top: 1em; + padding: 2px 5px; + font-size: small; +} + +div.code-block-caption code { + background-color: transparent; +} + +table.highlighttable td.linenos, +span.linenos, +div.highlight span.gp { /* gp: Generic.Prompt */ + user-select: none; + -webkit-user-select: text; /* Safari fallback only */ + -webkit-user-select: none; /* Chrome/Safari */ + -moz-user-select: none; /* Firefox */ + -ms-user-select: none; /* IE10+ */ +} + +div.code-block-caption span.caption-number { + padding: 0.1em 0.3em; + font-style: italic; +} + +div.code-block-caption span.caption-text { +} + +div.literal-block-wrapper { + margin: 1em 0; +} + +code.xref, a code { + background-color: transparent; + font-weight: bold; +} + +h1 code, h2 code, h3 code, h4 code, h5 code, h6 code { + background-color: transparent; +} + +.viewcode-link { + float: right; +} + +.viewcode-back { + float: right; + font-family: sans-serif; +} + +div.viewcode-block:target { + margin: -1px -10px; + padding: 0 10px; +} + +/* -- math display ---------------------------------------------------------- */ + +img.math { + vertical-align: middle; +} + +div.body div.math p { + text-align: center; +} + +span.eqno { + float: right; +} + +span.eqno a.headerlink { + position: absolute; + z-index: 1; +} + +div.math:hover a.headerlink { + visibility: visible; +} + +/* -- printout stylesheet --------------------------------------------------- */ + +@media print { + div.document, + div.documentwrapper, + div.bodywrapper { + margin: 0 !important; + width: 100%; + } + + div.sphinxsidebar, + div.related, + div.footer, + #top-link { + display: none; + } +} \ No newline at end of file diff --git a/_static/css/badge_only.css b/_static/css/badge_only.css new file mode 100644 index 000000000..ec0f9a893 --- /dev/null +++ b/_static/css/badge_only.css @@ -0,0 +1 @@ +.fa:before{-webkit-font-smoothing:antialiased}.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:#1f1f1f;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:#262626;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 #404040}.rst-versions .rst-other-versions dd{display:inline-block;margin:0}.rst-versions .rst-other-versions dd a{display:inline-block;padding:6px;color:#fcfcfc}.rst-versions.rst-badge{width:auto;bottom:20px;right:20px;left:auto;border:none;max-width:300px;max-height:90%}.rst-versions.rst-badge .fa-book,.rst-versions.rst-badge .icon-book{float:none;line-height:30px}.rst-versions.rst-badge.shift-up .rst-current-version{text-align:right}.rst-versions.rst-badge.shift-up .rst-current-version .fa-book,.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge>.rst-current-version{width:auto;height:30px;line-height:30px;padding:0 6px;display:block;text-align:center}@media screen and (max-width:768px){.rst-versions{width:85%;display:none}.rst-versions.shift{display:block}} \ No newline at end of file diff --git a/_static/css/fonts/Roboto-Slab-Bold.woff b/_static/css/fonts/Roboto-Slab-Bold.woff new file mode 100644 index 000000000..6cb600001 Binary files /dev/null and b/_static/css/fonts/Roboto-Slab-Bold.woff differ diff --git a/_static/css/fonts/Roboto-Slab-Bold.woff2 b/_static/css/fonts/Roboto-Slab-Bold.woff2 new file mode 100644 index 000000000..7059e2314 Binary files /dev/null and b/_static/css/fonts/Roboto-Slab-Bold.woff2 differ diff --git a/_static/css/fonts/Roboto-Slab-Regular.woff b/_static/css/fonts/Roboto-Slab-Regular.woff new file mode 100644 index 000000000..f815f63f9 Binary files /dev/null and b/_static/css/fonts/Roboto-Slab-Regular.woff differ diff --git a/_static/css/fonts/Roboto-Slab-Regular.woff2 b/_static/css/fonts/Roboto-Slab-Regular.woff2 new file mode 100644 index 000000000..f2c76e5bd Binary files /dev/null and b/_static/css/fonts/Roboto-Slab-Regular.woff2 differ diff --git a/_static/css/fonts/fontawesome-webfont.eot b/_static/css/fonts/fontawesome-webfont.eot new file mode 100644 index 000000000..e9f60ca95 Binary files /dev/null and b/_static/css/fonts/fontawesome-webfont.eot differ diff --git a/_static/css/fonts/fontawesome-webfont.svg b/_static/css/fonts/fontawesome-webfont.svg new file mode 100644 index 000000000..855c845e5 --- /dev/null +++ b/_static/css/fonts/fontawesome-webfont.svg @@ -0,0 +1,2671 @@ + + + + +Created by FontForge 20120731 at Mon Oct 24 17:37:40 2016 + By ,,, +Copyright Dave Gandy 2016. All rights reserved. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/_static/css/fonts/fontawesome-webfont.ttf b/_static/css/fonts/fontawesome-webfont.ttf new file mode 100644 index 000000000..35acda2fa Binary files /dev/null and b/_static/css/fonts/fontawesome-webfont.ttf differ diff --git a/_static/css/fonts/fontawesome-webfont.woff b/_static/css/fonts/fontawesome-webfont.woff new file mode 100644 index 000000000..400014a4b Binary files /dev/null and b/_static/css/fonts/fontawesome-webfont.woff differ diff --git a/_static/css/fonts/fontawesome-webfont.woff2 b/_static/css/fonts/fontawesome-webfont.woff2 new file mode 100644 index 000000000..4d13fc604 Binary files /dev/null and b/_static/css/fonts/fontawesome-webfont.woff2 differ diff --git a/_static/css/fonts/lato-bold-italic.woff b/_static/css/fonts/lato-bold-italic.woff new file mode 100644 index 000000000..88ad05b9f Binary files /dev/null and b/_static/css/fonts/lato-bold-italic.woff differ diff --git a/_static/css/fonts/lato-bold-italic.woff2 b/_static/css/fonts/lato-bold-italic.woff2 new file mode 100644 index 000000000..c4e3d804b Binary files /dev/null and b/_static/css/fonts/lato-bold-italic.woff2 differ diff --git a/_static/css/fonts/lato-bold.woff b/_static/css/fonts/lato-bold.woff new file mode 100644 index 000000000..c6dff51f0 Binary files /dev/null and b/_static/css/fonts/lato-bold.woff differ diff --git a/_static/css/fonts/lato-bold.woff2 b/_static/css/fonts/lato-bold.woff2 new file mode 100644 index 000000000..bb195043c Binary files /dev/null and b/_static/css/fonts/lato-bold.woff2 differ diff --git a/_static/css/fonts/lato-normal-italic.woff b/_static/css/fonts/lato-normal-italic.woff new file mode 100644 index 000000000..76114bc03 Binary files /dev/null and b/_static/css/fonts/lato-normal-italic.woff differ diff --git a/_static/css/fonts/lato-normal-italic.woff2 b/_static/css/fonts/lato-normal-italic.woff2 new file mode 100644 index 000000000..3404f37e2 Binary files /dev/null and b/_static/css/fonts/lato-normal-italic.woff2 differ diff --git a/_static/css/fonts/lato-normal.woff b/_static/css/fonts/lato-normal.woff new file mode 100644 index 000000000..ae1307ff5 Binary files /dev/null and b/_static/css/fonts/lato-normal.woff differ diff --git a/_static/css/fonts/lato-normal.woff2 b/_static/css/fonts/lato-normal.woff2 new file mode 100644 index 000000000..3bf984332 Binary files /dev/null and b/_static/css/fonts/lato-normal.woff2 differ diff --git a/_static/css/theme.css b/_static/css/theme.css new file mode 100644 index 000000000..2d181942d --- /dev/null +++ b/_static/css/theme.css @@ -0,0 +1,4 @@ +html{box-sizing:border-box}*,:after,:before{box-sizing:inherit}article,aside,details,figcaption,figure,footer,header,hgroup,nav,section{display:block}audio,canvas,video{display:inline-block;*display:inline;*zoom:1}[hidden],audio:not([controls]){display:none}*{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}html{font-size:100%;-webkit-text-size-adjust:100%;-ms-text-size-adjust:100%}body{margin:0}a:active,a:hover{outline:0}abbr[title]{border-bottom:1px dotted}b,strong{font-weight:700}blockquote{margin:0}dfn{font-style:italic}ins{background:#ff9;text-decoration:none}ins,mark{color:#000}mark{background:#ff0;font-style:italic;font-weight:700}.rst-content code,.rst-content tt,code,kbd,pre,samp{font-family:monospace,serif;_font-family:courier new,monospace;font-size:1em}pre{white-space:pre}q{quotes:none}q:after,q:before{content:"";content:none}small{font-size:85%}sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}sup{top:-.5em}sub{bottom:-.25em}dl,ol,ul{margin:0;padding:0;list-style:none;list-style-image:none}li{list-style:none}dd{margin:0}img{border:0;-ms-interpolation-mode:bicubic;vertical-align:middle;max-width:100%}svg:not(:root){overflow:hidden}figure,form{margin:0}label{cursor:pointer}button,input,select,textarea{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle}button,input{line-height:normal}button,input[type=button],input[type=reset],input[type=submit]{cursor:pointer;-webkit-appearance:button;*overflow:visible}button[disabled],input[disabled]{cursor:default}input[type=search]{-webkit-appearance:textfield;-moz-box-sizing:content-box;-webkit-box-sizing:content-box;box-sizing:content-box}textarea{resize:vertical}table{border-collapse:collapse;border-spacing:0}td{vertical-align:top}.chromeframe{margin:.2em 0;background:#ccc;color:#000;padding:.2em 0}.ir{display:block;border:0;text-indent:-999em;overflow:hidden;background-color:transparent;background-repeat:no-repeat;text-align:left;direction:ltr;*line-height:0}.ir br{display:none}.hidden{display:none!important;visibility:hidden}.visuallyhidden{border:0;clip:rect(0 0 0 0);height:1px;margin:-1px;overflow:hidden;padding:0;position:absolute;width:1px}.visuallyhidden.focusable:active,.visuallyhidden.focusable:focus{clip:auto;height:auto;margin:0;overflow:visible;position:static;width:auto}.invisible{visibility:hidden}.relative{position:relative}big,small{font-size:100%}@media print{body,html,section{background:none!important}*{box-shadow:none!important;text-shadow:none!important;filter:none!important;-ms-filter:none!important}a,a:visited{text-decoration:underline}.ir a:after,a[href^="#"]:after,a[href^="javascript:"]:after{content:""}blockquote,pre{page-break-inside:avoid}thead{display:table-header-group}img,tr{page-break-inside:avoid}img{max-width:100%!important}@page{margin:.5cm}.rst-content .toctree-wrapper>p.caption,h2,h3,p{orphans:3;widows:3}.rst-content .toctree-wrapper>p.caption,h2,h3{page-break-after:avoid}}.btn,.fa:before,.icon:before,.rst-content .admonition,.rst-content .admonition-title:before,.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .code-block-caption .headerlink:before,.rst-content .danger,.rst-content .eqno .headerlink:before,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .note,.rst-content .seealso,.rst-content .tip,.rst-content .warning,.rst-content code.download span:first-child:before,.rst-content dl dt .headerlink:before,.rst-content h1 .headerlink:before,.rst-content h2 .headerlink:before,.rst-content h3 .headerlink:before,.rst-content h4 .headerlink:before,.rst-content h5 .headerlink:before,.rst-content h6 .headerlink:before,.rst-content p.caption .headerlink:before,.rst-content p .headerlink:before,.rst-content table>caption .headerlink:before,.rst-content tt.download span:first-child:before,.wy-alert,.wy-dropdown .caret:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before,.wy-menu-vertical li.current>a,.wy-menu-vertical li.current>a button.toctree-expand:before,.wy-menu-vertical li.on a,.wy-menu-vertical li.on a button.toctree-expand:before,.wy-menu-vertical li button.toctree-expand:before,.wy-nav-top a,.wy-side-nav-search .wy-dropdown>a,.wy-side-nav-search>a,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:15px;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}.wy-breadcrumbs li.wy-breadcrumbs-aside{float:right}.wy-breadcrumbs li a{display:inline-block;padding:5px}.wy-breadcrumbs li a:first-child{padding-left:0}.rst-content .wy-breadcrumbs li tt,.wy-breadcrumbs li .rst-content tt,.wy-breadcrumbs li code{padding:5px;border:none;background:none}.rst-content .wy-breadcrumbs li tt.literal,.wy-breadcrumbs li .rst-content tt.literal,.wy-breadcrumbs li code.literal{color:#404040}.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:15px}.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:30px;display:inline-block;line-height:30px;padding:0 15px}.wy-menu-vertical{width:300px}.wy-menu-vertical header,.wy-menu-vertical p.caption{color:#9b9b9b;height:30px;line-height:30px;padding:0 .809em;margin:6px 0 0;border-top:1px solid #9b9b9b;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:#4d4d4d;cursor:pointer}.wy-menu-vertical a:hover button.toctree-expand{color:#d9d9d9}.wy-menu-vertical a:active{background-color:#333;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:0;z-index:200;background-color:#333;text-align:center}.wy-side-nav-search input[type=text]{width:100%;border-radius:0;padding:6px 12px;border-color:#2472a4}.wy-side-nav-search img{display:block;margin:auto auto .809em;height:45px;width:45px;background-color:#333;padding:5px;border-radius:100%}.wy-side-nav-search .wy-dropdown>a,.wy-side-nav-search>a{font-size:100%;font-weight:700;display:inline-block;padding:4px 6px;margin-bottom:.4045em;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:0 0 .809em;font-weight:400}.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:#333;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:#333;z-index:200}.wy-side-scroll{width:320px;position:relative;overflow-x:hidden;overflow-y:scroll;height:100%}.wy-nav-top{display:none;background:#333;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:#333;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:1024px;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;font-size:95%;text-align:center}footer p{margin-bottom:0;font-size:95%}.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 print{.rst-versions,.wy-nav-side,footer{display:none}.wy-nav-content-wrap{margin-left:0}}.rst-content .toctree-wrapper>p.caption,h1,h2,h3,h4,h5,h6,p{margin-bottom:12px}h1{display:none}.rst-content .toctree-wrapper>p.caption,h2{border-bottom:1px solid #e1e4e5;padding:0 0 3px;font-size:130%}h3{font-size:115%;text-decoration:underline}.section p,.simple li,section>p{text-align:justify}.rst-versions{position:fixed;bottom:0;left:0;width:300px;color:#fcfcfc;background:#1f1f1f;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:#262626;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 #404040}.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%}.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 .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 .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.field-list,html.writer-html5 .rst-content dl.footnote{display:grid;grid-template-columns:max-content auto}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.field-list>dt:after,html.writer-html5 .rst-content dl.footnote>dt:after{content:":"}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.footnote{font-size:.9rem}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.footnote>dt>span.brackets{margin-right:.5rem}html.writer-html5 .rst-content dl.footnote>dt>span.brackets:before{content:"["}html.writer-html5 .rst-content dl.footnote>dt>span.brackets:after{content:"]"}html.writer-html5 .rst-content dl.footnote>dt>span.fn-backref{font-style:italic}html.writer-html5 .rst-content dl.footnote>dd{margin:0 0 .5rem;line-height:1.2rem}html.writer-html5 .rst-content dl.footnote>dd p,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 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 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{font-size:inherit;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}.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}html.writer-html4 .rst-content dl:not(.docutils),html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):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(.glossary):not(.simple)>dt{display:table;margin:6px 0;font-size:90%;line-height:normal;background:#b3b3b3;color:#333;border-top:3px solid #666;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(.glossary):not(.simple)>dt:before{color:#666}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(.glossary):not(.simple)>dt .headerlink{color:#404040;font-size:100%!important}html.writer-html4 .rst-content dl:not(.docutils) dl:not(.field-list)>dt,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) dl:not(.field-list)>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(.field-list)>dt .headerlink,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) dl:not(.field-list)>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(.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(.glossary):not(.simple) code.descclassname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) code.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) tt.descclassname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):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(.glossary):not(.simple) code.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):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(.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(.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(.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(.glossary):not(.simple) .descclassname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) .descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):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{border:1px solid #737373;background:#b3b3b3;font-size:80%;font-weight:700;border-radius:4px;padding:2.4px 6px;margin:auto 2px}.rst-content .versionmodified{font-style:italic}@media screen and (max-width:480px){.rst-content .sidebar{width:100%}}span[id*=MathJax-Span]{color:#404040}.math{text-align:center}@font-face{font-family:Lato;src:url(fonts/lato-normal.woff2?bd03a2cc277bbbc338d464e679fe9942) format("woff2"),url(fonts/lato-normal.woff?27bd77b9162d388cb8d4c4217c7c5e2a) format("woff");font-weight:400;font-style:normal;font-display:block}@font-face{font-family:Lato;src:url(fonts/lato-bold.woff2?cccb897485813c7c256901dbca54ecf2) format("woff2"),url(fonts/lato-bold.woff?d878b6c29b10beca227e9eef4246111b) format("woff");font-weight:700;font-style:normal;font-display:block}@font-face{font-family:Lato;src:url(fonts/lato-bold-italic.woff2?0b6bb6725576b072c5d0b02ecdd1900d) format("woff2"),url(fonts/lato-bold-italic.woff?9c7e4e9eb485b4a121c760e61bc3707c) format("woff");font-weight:700;font-style:italic;font-display:block}@font-face{font-family:Lato;src:url(fonts/lato-normal-italic.woff2?4eb103b4d12be57cb1d040ed5e162e9d) format("woff2"),url(fonts/lato-normal-italic.woff?f28f2d6482446544ef1ea1ccc6dd5892) format("woff");font-weight:400;font-style:italic;font-display:block}@font-face{font-family:Roboto Slab;font-style:normal;font-weight:400;src:url(fonts/Roboto-Slab-Regular.woff2?7abf5b8d04d26a2cafea937019bca958) format("woff2"),url(fonts/Roboto-Slab-Regular.woff?c1be9284088d487c5e3ff0a10a92e58c) format("woff");font-display:block}@font-face{font-family:Roboto Slab;font-style:normal;font-weight:700;src:url(fonts/Roboto-Slab-Bold.woff2?9984f4a9bda09be08e83f2506954adbe) format("woff2"),url(fonts/Roboto-Slab-Bold.woff?bed5564a116b05148e3b3bea6fb1162a) format("woff");font-display:block} \ No newline at end of file diff --git a/_static/doctools.js b/_static/doctools.js new file mode 100644 index 000000000..527b876ca --- /dev/null +++ b/_static/doctools.js @@ -0,0 +1,156 @@ +/* + * doctools.js + * ~~~~~~~~~~~ + * + * Base JavaScript utilities for all Sphinx HTML documentation. + * + * :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ +"use strict"; + +const BLACKLISTED_KEY_CONTROL_ELEMENTS = new Set([ + "TEXTAREA", + "INPUT", + "SELECT", + "BUTTON", +]); + +const _ready = (callback) => { + if (document.readyState !== "loading") { + callback(); + } else { + document.addEventListener("DOMContentLoaded", callback); + } +}; + +/** + * Small JavaScript module for the documentation. + */ +const Documentation = { + init: () => { + Documentation.initDomainIndexTable(); + Documentation.initOnKeyListeners(); + }, + + /** + * i18n support + */ + TRANSLATIONS: {}, + PLURAL_EXPR: (n) => (n === 1 ? 0 : 1), + LOCALE: "unknown", + + // gettext and ngettext don't access this so that the functions + // can safely bound to a different name (_ = Documentation.gettext) + gettext: (string) => { + const translated = Documentation.TRANSLATIONS[string]; + switch (typeof translated) { + case "undefined": + return string; // no translation + case "string": + return translated; // translation exists + default: + return translated[0]; // (singular, plural) translation tuple exists + } + }, + + ngettext: (singular, plural, n) => { + const translated = Documentation.TRANSLATIONS[singular]; + if (typeof translated !== "undefined") + return translated[Documentation.PLURAL_EXPR(n)]; + return n === 1 ? singular : plural; + }, + + addTranslations: (catalog) => { + Object.assign(Documentation.TRANSLATIONS, catalog.messages); + Documentation.PLURAL_EXPR = new Function( + "n", + `return (${catalog.plural_expr})` + ); + Documentation.LOCALE = catalog.locale; + }, + + /** + * helper function to focus on search bar + */ + focusSearchBar: () => { + document.querySelectorAll("input[name=q]")[0]?.focus(); + }, + + /** + * Initialise the domain index toggle buttons + */ + initDomainIndexTable: () => { + const toggler = (el) => { + const idNumber = el.id.substr(7); + const toggledRows = document.querySelectorAll(`tr.cg-${idNumber}`); + if (el.src.substr(-9) === "minus.png") { + el.src = `${el.src.substr(0, el.src.length - 9)}plus.png`; + toggledRows.forEach((el) => (el.style.display = "none")); + } else { + el.src = `${el.src.substr(0, el.src.length - 8)}minus.png`; + toggledRows.forEach((el) => (el.style.display = "")); + } + }; + + const togglerElements = document.querySelectorAll("img.toggler"); + togglerElements.forEach((el) => + el.addEventListener("click", (event) => toggler(event.currentTarget)) + ); + togglerElements.forEach((el) => (el.style.display = "")); + if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) togglerElements.forEach(toggler); + }, + + initOnKeyListeners: () => { + // only install a listener if it is really needed + if ( + !DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS && + !DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS + ) + return; + + document.addEventListener("keydown", (event) => { + // bail for input elements + if (BLACKLISTED_KEY_CONTROL_ELEMENTS.has(document.activeElement.tagName)) return; + // bail with special keys + if (event.altKey || event.ctrlKey || event.metaKey) return; + + if (!event.shiftKey) { + switch (event.key) { + case "ArrowLeft": + if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) break; + + const prevLink = document.querySelector('link[rel="prev"]'); + if (prevLink && prevLink.href) { + window.location.href = prevLink.href; + event.preventDefault(); + } + break; + case "ArrowRight": + if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) break; + + const nextLink = document.querySelector('link[rel="next"]'); + if (nextLink && nextLink.href) { + window.location.href = nextLink.href; + event.preventDefault(); + } + break; + } + } + + // some keyboard layouts may need Shift to get / + switch (event.key) { + case "/": + if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS) break; + Documentation.focusSearchBar(); + event.preventDefault(); + } + }); + }, +}; + +// quick alias for translations +const _ = Documentation.gettext; + +_ready(Documentation.init); diff --git a/_static/documentation_options.js b/_static/documentation_options.js new file mode 100644 index 000000000..f8d32270a --- /dev/null +++ b/_static/documentation_options.js @@ -0,0 +1,14 @@ +var DOCUMENTATION_OPTIONS = { + URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'), + VERSION: 'latest', + 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/_static/file.png b/_static/file.png new file mode 100644 index 000000000..a858a410e Binary files /dev/null and b/_static/file.png differ diff --git a/_static/graphviz.css b/_static/graphviz.css new file mode 100644 index 000000000..19e7afd38 --- /dev/null +++ b/_static/graphviz.css @@ -0,0 +1,19 @@ +/* + * graphviz.css + * ~~~~~~~~~~~~ + * + * Sphinx stylesheet -- graphviz extension. + * + * :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ + +img.graphviz { + border: 0; + max-width: 100%; +} + +object.graphviz { + max-width: 100%; +} diff --git a/_static/icon.png b/_static/icon.png new file mode 100644 index 000000000..a982496e9 Binary files /dev/null and b/_static/icon.png differ diff --git a/_static/icon.svg b/_static/icon.svg new file mode 100644 index 000000000..6ebfa62ee --- /dev/null +++ b/_static/icon.svg @@ -0,0 +1,319 @@ + + + + + + + image/svg+xml + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/_static/img/continuous_integration.svg b/_static/img/continuous_integration.svg new file mode 100644 index 000000000..7f41678b0 --- /dev/null +++ b/_static/img/continuous_integration.svg @@ -0,0 +1,3 @@ + + +
Common
(Reusable Workflow)
Common...
matrix
matrix
Job
Job
JavaScript
JavaScript
Bash
Bash
Python
Python
Legend:
Legend:
Uncoditioned
Uncoditioned
Conditioned
Conditioned
[Pull,] Build [and Test]
(heredoc python script)
[Pull,] Build [and Test]...
[conditionally] Pull
(pyHDLC pull ...)
[conditionally] Pull...
Build [and conditionally Test]
(pyHDLC build ... -d ...)
Build [and conditionally T...
build-test-release
(Composite Action)
build-test-release...
Setup
(./utils/setup.sh)
Setup...
[Pull,] Build [and Test]
(heredoc python script)
[Pull,] Build [and Test]...
[conditionally] Release
(pyTooling/Actions/with-post-step)
[conditionally] Release...
Setup
(./utils/setup.sh)
Setup...
generate
(pyHDLC jobs <key>)
generate...
actions/checkout
(JavaScript Action)
actions/checkout...
jobs
jobs
./utils/build-test-release
(Local Composite Action)
./utils/build-test-rele...
actions/checkout
(JavaScript Action)
actions/checkout...
pyHDLC
(Local Python Utilities)
pyHDLC...
__init__.py
__init__.py
cli.py
cli.py
run.py
run.py
config.yml
config.yml
Dispatch
(Dispatchable Workflow)
Dispatch...
hdl/containers/.github/workflows/common.yml
(Reusable Workflow)
hdl/containers/.github/workflows/common.yml...
Viewer does not support full SVG 1.1
\ No newline at end of file diff --git a/_static/img/dive.png b/_static/img/dive.png new file mode 100644 index 000000000..5d9aa4230 Binary files /dev/null and b/_static/img/dive.png differ diff --git a/_static/img/x11docker_klayout.gif b/_static/img/x11docker_klayout.gif new file mode 100644 index 000000000..b9701b86e Binary files /dev/null and b/_static/img/x11docker_klayout.gif differ diff --git a/_static/jquery-3.6.0.js b/_static/jquery-3.6.0.js new file mode 100644 index 000000000..fc6c299b7 --- /dev/null +++ b/_static/jquery-3.6.0.js @@ -0,0 +1,10881 @@ +/*! + * jQuery JavaScript Library v3.6.0 + * https://jquery.com/ + * + * Includes Sizzle.js + * https://sizzlejs.com/ + * + * Copyright OpenJS Foundation and other contributors + * Released under the MIT license + * https://jquery.org/license + * + * Date: 2021-03-02T17:08Z + */ +( function( global, factory ) { + + "use strict"; + + if ( typeof module === "object" && typeof module.exports === "object" ) { + + // For CommonJS and CommonJS-like environments where a proper `window` + // is present, execute the factory and get jQuery. + // For environments that do not have a `window` with a `document` + // (such as Node.js), expose a factory as module.exports. + // This accentuates the need for the creation of a real `window`. + // e.g. var jQuery = require("jquery")(window); + // See ticket #14549 for more info. + module.exports = global.document ? + factory( global, true ) : + function( w ) { + if ( !w.document ) { + throw new Error( "jQuery requires a window with a document" ); + } + return factory( w ); + }; + } else { + factory( global ); + } + +// Pass this if window is not defined yet +} )( typeof window !== "undefined" ? window : this, function( window, noGlobal ) { + +// Edge <= 12 - 13+, Firefox <=18 - 45+, IE 10 - 11, Safari 5.1 - 9+, iOS 6 - 9.1 +// throw exceptions when non-strict code (e.g., ASP.NET 4.5) accesses strict mode +// arguments.callee.caller (trac-13335). But as of jQuery 3.0 (2016), strict mode should be common +// enough that all such attempts are guarded in a try block. +"use strict"; + +var arr = []; + +var getProto = Object.getPrototypeOf; + +var slice = arr.slice; + +var flat = arr.flat ? function( array ) { + return arr.flat.call( array ); +} : function( array ) { + return arr.concat.apply( [], array ); +}; + + +var push = arr.push; + +var indexOf = arr.indexOf; + +var class2type = {}; + +var toString = class2type.toString; + +var hasOwn = class2type.hasOwnProperty; + +var fnToString = hasOwn.toString; + +var ObjectFunctionString = fnToString.call( Object ); + +var support = {}; + +var isFunction = function isFunction( obj ) { + + // Support: Chrome <=57, Firefox <=52 + // In some browsers, typeof returns "function" for HTML elements + // (i.e., `typeof document.createElement( "object" ) === "function"`). + // We don't want to classify *any* DOM node as a function. + // Support: QtWeb <=3.8.5, WebKit <=534.34, wkhtmltopdf tool <=0.12.5 + // Plus for old WebKit, typeof returns "function" for HTML collections + // (e.g., `typeof document.getElementsByTagName("div") === "function"`). (gh-4756) + return typeof obj === "function" && typeof obj.nodeType !== "number" && + typeof obj.item !== "function"; + }; + + +var isWindow = function isWindow( obj ) { + return obj != null && obj === obj.window; + }; + + +var document = window.document; + + + + var preservedScriptAttributes = { + type: true, + src: true, + nonce: true, + noModule: true + }; + + function DOMEval( code, node, doc ) { + doc = doc || document; + + var i, val, + script = doc.createElement( "script" ); + + script.text = code; + if ( node ) { + for ( i in preservedScriptAttributes ) { + + // Support: Firefox 64+, Edge 18+ + // Some browsers don't support the "nonce" property on scripts. + // On the other hand, just using `getAttribute` is not enough as + // the `nonce` attribute is reset to an empty string whenever it + // becomes browsing-context connected. + // See https://github.com/whatwg/html/issues/2369 + // See https://html.spec.whatwg.org/#nonce-attributes + // The `node.getAttribute` check was added for the sake of + // `jQuery.globalEval` so that it can fake a nonce-containing node + // via an object. + val = node[ i ] || node.getAttribute && node.getAttribute( i ); + if ( val ) { + script.setAttribute( i, val ); + } + } + } + doc.head.appendChild( script ).parentNode.removeChild( script ); + } + + +function toType( obj ) { + if ( obj == null ) { + return obj + ""; + } + + // Support: Android <=2.3 only (functionish RegExp) + return typeof obj === "object" || typeof obj === "function" ? + class2type[ toString.call( obj ) ] || "object" : + typeof obj; +} +/* global Symbol */ +// Defining this global in .eslintrc.json would create a danger of using the global +// unguarded in another place, it seems safer to define global only for this module + + + +var + version = "3.6.0", + + // Define a local copy of jQuery + jQuery = function( selector, context ) { + + // The jQuery object is actually just the init constructor 'enhanced' + // Need init if jQuery is called (just allow error to be thrown if not included) + return new jQuery.fn.init( selector, context ); + }; + +jQuery.fn = jQuery.prototype = { + + // The current version of jQuery being used + jquery: version, + + constructor: jQuery, + + // The default length of a jQuery object is 0 + length: 0, + + toArray: function() { + return slice.call( this ); + }, + + // Get the Nth element in the matched element set OR + // Get the whole matched element set as a clean array + get: function( num ) { + + // Return all the elements in a clean array + if ( num == null ) { + return slice.call( this ); + } + + // Return just the one element from the set + return num < 0 ? this[ num + this.length ] : this[ num ]; + }, + + // Take an array of elements and push it onto the stack + // (returning the new matched element set) + pushStack: function( elems ) { + + // Build a new jQuery matched element set + var ret = jQuery.merge( this.constructor(), elems ); + + // Add the old object onto the stack (as a reference) + ret.prevObject = this; + + // Return the newly-formed element set + return ret; + }, + + // Execute a callback for every element in the matched set. + each: function( callback ) { + return jQuery.each( this, callback ); + }, + + map: function( callback ) { + return this.pushStack( jQuery.map( this, function( elem, i ) { + return callback.call( elem, i, elem ); + } ) ); + }, + + slice: function() { + return this.pushStack( slice.apply( this, arguments ) ); + }, + + first: function() { + return this.eq( 0 ); + }, + + last: function() { + return this.eq( -1 ); + }, + + even: function() { + return this.pushStack( jQuery.grep( this, function( _elem, i ) { + return ( i + 1 ) % 2; + } ) ); + }, + + odd: function() { + return this.pushStack( jQuery.grep( this, function( _elem, i ) { + return i % 2; + } ) ); + }, + + eq: function( i ) { + var len = this.length, + j = +i + ( i < 0 ? len : 0 ); + return this.pushStack( j >= 0 && j < len ? [ this[ j ] ] : [] ); + }, + + end: function() { + return this.prevObject || this.constructor(); + }, + + // For internal use only. + // Behaves like an Array's method, not like a jQuery method. + push: push, + sort: arr.sort, + splice: arr.splice +}; + +jQuery.extend = jQuery.fn.extend = function() { + var options, name, src, copy, copyIsArray, clone, + target = arguments[ 0 ] || {}, + i = 1, + length = arguments.length, + deep = false; + + // Handle a deep copy situation + if ( typeof target === "boolean" ) { + deep = target; + + // Skip the boolean and the target + target = arguments[ i ] || {}; + i++; + } + + // Handle case when target is a string or something (possible in deep copy) + if ( typeof target !== "object" && !isFunction( target ) ) { + target = {}; + } + + // Extend jQuery itself if only one argument is passed + if ( i === length ) { + target = this; + i--; + } + + for ( ; i < length; i++ ) { + + // Only deal with non-null/undefined values + if ( ( options = arguments[ i ] ) != null ) { + + // Extend the base object + for ( name in options ) { + copy = options[ name ]; + + // Prevent Object.prototype pollution + // Prevent never-ending loop + if ( name === "__proto__" || target === copy ) { + continue; + } + + // Recurse if we're merging plain objects or arrays + if ( deep && copy && ( jQuery.isPlainObject( copy ) || + ( copyIsArray = Array.isArray( copy ) ) ) ) { + src = target[ name ]; + + // Ensure proper type for the source value + if ( copyIsArray && !Array.isArray( src ) ) { + clone = []; + } else if ( !copyIsArray && !jQuery.isPlainObject( src ) ) { + clone = {}; + } else { + clone = src; + } + copyIsArray = false; + + // Never move original objects, clone them + target[ name ] = jQuery.extend( deep, clone, copy ); + + // Don't bring in undefined values + } else if ( copy !== undefined ) { + target[ name ] = copy; + } + } + } + } + + // Return the modified object + return target; +}; + +jQuery.extend( { + + // Unique for each copy of jQuery on the page + expando: "jQuery" + ( version + Math.random() ).replace( /\D/g, "" ), + + // Assume jQuery is ready without the ready module + isReady: true, + + error: function( msg ) { + throw new Error( msg ); + }, + + noop: function() {}, + + isPlainObject: function( obj ) { + var proto, Ctor; + + // Detect obvious negatives + // Use toString instead of jQuery.type to catch host objects + if ( !obj || toString.call( obj ) !== "[object Object]" ) { + return false; + } + + proto = getProto( obj ); + + // Objects with no prototype (e.g., `Object.create( null )`) are plain + if ( !proto ) { + return true; + } + + // Objects with prototype are plain iff they were constructed by a global Object function + Ctor = hasOwn.call( proto, "constructor" ) && proto.constructor; + return typeof Ctor === "function" && fnToString.call( Ctor ) === ObjectFunctionString; + }, + + isEmptyObject: function( obj ) { + var name; + + for ( name in obj ) { + return false; + } + return true; + }, + + // Evaluates a script in a provided context; falls back to the global one + // if not specified. + globalEval: function( code, options, doc ) { + DOMEval( code, { nonce: options && options.nonce }, doc ); + }, + + each: function( obj, callback ) { + var length, i = 0; + + if ( isArrayLike( obj ) ) { + length = obj.length; + for ( ; i < length; i++ ) { + if ( callback.call( obj[ i ], i, obj[ i ] ) === false ) { + break; + } + } + } else { + for ( i in obj ) { + if ( callback.call( obj[ i ], i, obj[ i ] ) === false ) { + break; + } + } + } + + return obj; + }, + + // results is for internal usage only + makeArray: function( arr, results ) { + var ret = results || []; + + if ( arr != null ) { + if ( isArrayLike( Object( arr ) ) ) { + jQuery.merge( ret, + typeof arr === "string" ? + [ arr ] : arr + ); + } else { + push.call( ret, arr ); + } + } + + return ret; + }, + + inArray: function( elem, arr, i ) { + return arr == null ? -1 : indexOf.call( arr, elem, i ); + }, + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + merge: function( first, second ) { + var len = +second.length, + j = 0, + i = first.length; + + for ( ; j < len; j++ ) { + first[ i++ ] = second[ j ]; + } + + first.length = i; + + return first; + }, + + grep: function( elems, callback, invert ) { + var callbackInverse, + matches = [], + i = 0, + length = elems.length, + callbackExpect = !invert; + + // Go through the array, only saving the items + // that pass the validator function + for ( ; i < length; i++ ) { + callbackInverse = !callback( elems[ i ], i ); + if ( callbackInverse !== callbackExpect ) { + matches.push( elems[ i ] ); + } + } + + return matches; + }, + + // arg is for internal usage only + map: function( elems, callback, arg ) { + var length, value, + i = 0, + ret = []; + + // Go through the array, translating each of the items to their new values + if ( isArrayLike( elems ) ) { + length = elems.length; + for ( ; i < length; i++ ) { + value = callback( elems[ i ], i, arg ); + + if ( value != null ) { + ret.push( value ); + } + } + + // Go through every key on the object, + } else { + for ( i in elems ) { + value = callback( elems[ i ], i, arg ); + + if ( value != null ) { + ret.push( value ); + } + } + } + + // Flatten any nested arrays + return flat( ret ); + }, + + // A global GUID counter for objects + guid: 1, + + // jQuery.support is not used in Core but other projects attach their + // properties to it so it needs to exist. + support: support +} ); + +if ( typeof Symbol === "function" ) { + jQuery.fn[ Symbol.iterator ] = arr[ Symbol.iterator ]; +} + +// Populate the class2type map +jQuery.each( "Boolean Number String Function Array Date RegExp Object Error Symbol".split( " " ), + function( _i, name ) { + class2type[ "[object " + name + "]" ] = name.toLowerCase(); + } ); + +function isArrayLike( obj ) { + + // Support: real iOS 8.2 only (not reproducible in simulator) + // `in` check used to prevent JIT error (gh-2145) + // hasOwn isn't used here due to false negatives + // regarding Nodelist length in IE + var length = !!obj && "length" in obj && obj.length, + type = toType( obj ); + + if ( isFunction( obj ) || isWindow( obj ) ) { + return false; + } + + return type === "array" || length === 0 || + typeof length === "number" && length > 0 && ( length - 1 ) in obj; +} +var Sizzle = +/*! + * Sizzle CSS Selector Engine v2.3.6 + * https://sizzlejs.com/ + * + * Copyright JS Foundation and other contributors + * Released under the MIT license + * https://js.foundation/ + * + * Date: 2021-02-16 + */ +( function( window ) { +var i, + support, + Expr, + getText, + isXML, + tokenize, + compile, + select, + outermostContext, + sortInput, + hasDuplicate, + + // Local document vars + setDocument, + document, + docElem, + documentIsHTML, + rbuggyQSA, + rbuggyMatches, + matches, + contains, + + // Instance-specific data + expando = "sizzle" + 1 * new Date(), + preferredDoc = window.document, + dirruns = 0, + done = 0, + classCache = createCache(), + tokenCache = createCache(), + compilerCache = createCache(), + nonnativeSelectorCache = createCache(), + sortOrder = function( a, b ) { + if ( a === b ) { + hasDuplicate = true; + } + return 0; + }, + + // Instance methods + hasOwn = ( {} ).hasOwnProperty, + arr = [], + pop = arr.pop, + pushNative = arr.push, + push = arr.push, + slice = arr.slice, + + // Use a stripped-down indexOf as it's faster than native + // https://jsperf.com/thor-indexof-vs-for/5 + indexOf = function( list, elem ) { + var i = 0, + len = list.length; + for ( ; i < len; i++ ) { + if ( list[ i ] === elem ) { + return i; + } + } + return -1; + }, + + booleans = "checked|selected|async|autofocus|autoplay|controls|defer|disabled|hidden|" + + "ismap|loop|multiple|open|readonly|required|scoped", + + // Regular expressions + + // http://www.w3.org/TR/css3-selectors/#whitespace + whitespace = "[\\x20\\t\\r\\n\\f]", + + // https://www.w3.org/TR/css-syntax-3/#ident-token-diagram + identifier = "(?:\\\\[\\da-fA-F]{1,6}" + whitespace + + "?|\\\\[^\\r\\n\\f]|[\\w-]|[^\0-\\x7f])+", + + // Attribute selectors: http://www.w3.org/TR/selectors/#attribute-selectors + attributes = "\\[" + whitespace + "*(" + identifier + ")(?:" + whitespace + + + // Operator (capture 2) + "*([*^$|!~]?=)" + whitespace + + + // "Attribute values must be CSS identifiers [capture 5] + // or strings [capture 3 or capture 4]" + "*(?:'((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\"|(" + identifier + "))|)" + + whitespace + "*\\]", + + pseudos = ":(" + identifier + ")(?:\\((" + + + // To reduce the number of selectors needing tokenize in the preFilter, prefer arguments: + // 1. quoted (capture 3; capture 4 or capture 5) + "('((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\")|" + + + // 2. simple (capture 6) + "((?:\\\\.|[^\\\\()[\\]]|" + attributes + ")*)|" + + + // 3. anything else (capture 2) + ".*" + + ")\\)|)", + + // Leading and non-escaped trailing whitespace, capturing some non-whitespace characters preceding the latter + rwhitespace = new RegExp( whitespace + "+", "g" ), + rtrim = new RegExp( "^" + whitespace + "+|((?:^|[^\\\\])(?:\\\\.)*)" + + whitespace + "+$", "g" ), + + rcomma = new RegExp( "^" + whitespace + "*," + whitespace + "*" ), + rcombinators = new RegExp( "^" + whitespace + "*([>+~]|" + whitespace + ")" + whitespace + + "*" ), + rdescend = new RegExp( whitespace + "|>" ), + + rpseudo = new RegExp( pseudos ), + ridentifier = new RegExp( "^" + identifier + "$" ), + + matchExpr = { + "ID": new RegExp( "^#(" + identifier + ")" ), + "CLASS": new RegExp( "^\\.(" + identifier + ")" ), + "TAG": new RegExp( "^(" + identifier + "|[*])" ), + "ATTR": new RegExp( "^" + attributes ), + "PSEUDO": new RegExp( "^" + pseudos ), + "CHILD": new RegExp( "^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\(" + + whitespace + "*(even|odd|(([+-]|)(\\d*)n|)" + whitespace + "*(?:([+-]|)" + + whitespace + "*(\\d+)|))" + whitespace + "*\\)|)", "i" ), + "bool": new RegExp( "^(?:" + booleans + ")$", "i" ), + + // For use in libraries implementing .is() + // We use this for POS matching in `select` + "needsContext": new RegExp( "^" + whitespace + + "*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\(" + whitespace + + "*((?:-\\d)?\\d*)" + whitespace + "*\\)|)(?=[^-]|$)", "i" ) + }, + + rhtml = /HTML$/i, + rinputs = /^(?:input|select|textarea|button)$/i, + rheader = /^h\d$/i, + + rnative = /^[^{]+\{\s*\[native \w/, + + // Easily-parseable/retrievable ID or TAG or CLASS selectors + rquickExpr = /^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/, + + rsibling = /[+~]/, + + // CSS escapes + // http://www.w3.org/TR/CSS21/syndata.html#escaped-characters + runescape = new RegExp( "\\\\[\\da-fA-F]{1,6}" + whitespace + "?|\\\\([^\\r\\n\\f])", "g" ), + funescape = function( escape, nonHex ) { + var high = "0x" + escape.slice( 1 ) - 0x10000; + + return nonHex ? + + // Strip the backslash prefix from a non-hex escape sequence + nonHex : + + // Replace a hexadecimal escape sequence with the encoded Unicode code point + // Support: IE <=11+ + // For values outside the Basic Multilingual Plane (BMP), manually construct a + // surrogate pair + high < 0 ? + String.fromCharCode( high + 0x10000 ) : + String.fromCharCode( high >> 10 | 0xD800, high & 0x3FF | 0xDC00 ); + }, + + // CSS string/identifier serialization + // https://drafts.csswg.org/cssom/#common-serializing-idioms + rcssescape = /([\0-\x1f\x7f]|^-?\d)|^-$|[^\0-\x1f\x7f-\uFFFF\w-]/g, + fcssescape = function( ch, asCodePoint ) { + if ( asCodePoint ) { + + // U+0000 NULL becomes U+FFFD REPLACEMENT CHARACTER + if ( ch === "\0" ) { + return "\uFFFD"; + } + + // Control characters and (dependent upon position) numbers get escaped as code points + return ch.slice( 0, -1 ) + "\\" + + ch.charCodeAt( ch.length - 1 ).toString( 16 ) + " "; + } + + // Other potentially-special ASCII characters get backslash-escaped + return "\\" + ch; + }, + + // Used for iframes + // See setDocument() + // Removing the function wrapper causes a "Permission Denied" + // error in IE + unloadHandler = function() { + setDocument(); + }, + + inDisabledFieldset = addCombinator( + function( elem ) { + return elem.disabled === true && elem.nodeName.toLowerCase() === "fieldset"; + }, + { dir: "parentNode", next: "legend" } + ); + +// Optimize for push.apply( _, NodeList ) +try { + push.apply( + ( arr = slice.call( preferredDoc.childNodes ) ), + preferredDoc.childNodes + ); + + // Support: Android<4.0 + // Detect silently failing push.apply + // eslint-disable-next-line no-unused-expressions + arr[ preferredDoc.childNodes.length ].nodeType; +} catch ( e ) { + push = { apply: arr.length ? + + // Leverage slice if possible + function( target, els ) { + pushNative.apply( target, slice.call( els ) ); + } : + + // Support: IE<9 + // Otherwise append directly + function( target, els ) { + var j = target.length, + i = 0; + + // Can't trust NodeList.length + while ( ( target[ j++ ] = els[ i++ ] ) ) {} + target.length = j - 1; + } + }; +} + +function Sizzle( selector, context, results, seed ) { + var m, i, elem, nid, match, groups, newSelector, + newContext = context && context.ownerDocument, + + // nodeType defaults to 9, since context defaults to document + nodeType = context ? context.nodeType : 9; + + results = results || []; + + // Return early from calls with invalid selector or context + if ( typeof selector !== "string" || !selector || + nodeType !== 1 && nodeType !== 9 && nodeType !== 11 ) { + + return results; + } + + // Try to shortcut find operations (as opposed to filters) in HTML documents + if ( !seed ) { + setDocument( context ); + context = context || document; + + if ( documentIsHTML ) { + + // If the selector is sufficiently simple, try using a "get*By*" DOM method + // (excepting DocumentFragment context, where the methods don't exist) + if ( nodeType !== 11 && ( match = rquickExpr.exec( selector ) ) ) { + + // ID selector + if ( ( m = match[ 1 ] ) ) { + + // Document context + if ( nodeType === 9 ) { + if ( ( elem = context.getElementById( m ) ) ) { + + // Support: IE, Opera, Webkit + // TODO: identify versions + // getElementById can match elements by name instead of ID + if ( elem.id === m ) { + results.push( elem ); + return results; + } + } else { + return results; + } + + // Element context + } else { + + // Support: IE, Opera, Webkit + // TODO: identify versions + // getElementById can match elements by name instead of ID + if ( newContext && ( elem = newContext.getElementById( m ) ) && + contains( context, elem ) && + elem.id === m ) { + + results.push( elem ); + return results; + } + } + + // Type selector + } else if ( match[ 2 ] ) { + push.apply( results, context.getElementsByTagName( selector ) ); + return results; + + // Class selector + } else if ( ( m = match[ 3 ] ) && support.getElementsByClassName && + context.getElementsByClassName ) { + + push.apply( results, context.getElementsByClassName( m ) ); + return results; + } + } + + // Take advantage of querySelectorAll + if ( support.qsa && + !nonnativeSelectorCache[ selector + " " ] && + ( !rbuggyQSA || !rbuggyQSA.test( selector ) ) && + + // Support: IE 8 only + // Exclude object elements + ( nodeType !== 1 || context.nodeName.toLowerCase() !== "object" ) ) { + + newSelector = selector; + newContext = context; + + // qSA considers elements outside a scoping root when evaluating child or + // descendant combinators, which is not what we want. + // In such cases, we work around the behavior by prefixing every selector in the + // list with an ID selector referencing the scope context. + // The technique has to be used as well when a leading combinator is used + // as such selectors are not recognized by querySelectorAll. + // Thanks to Andrew Dupont for this technique. + if ( nodeType === 1 && + ( rdescend.test( selector ) || rcombinators.test( selector ) ) ) { + + // Expand context for sibling selectors + newContext = rsibling.test( selector ) && testContext( context.parentNode ) || + context; + + // We can use :scope instead of the ID hack if the browser + // supports it & if we're not changing the context. + if ( newContext !== context || !support.scope ) { + + // Capture the context ID, setting it first if necessary + if ( ( nid = context.getAttribute( "id" ) ) ) { + nid = nid.replace( rcssescape, fcssescape ); + } else { + context.setAttribute( "id", ( nid = expando ) ); + } + } + + // Prefix every selector in the list + groups = tokenize( selector ); + i = groups.length; + while ( i-- ) { + groups[ i ] = ( nid ? "#" + nid : ":scope" ) + " " + + toSelector( groups[ i ] ); + } + newSelector = groups.join( "," ); + } + + try { + push.apply( results, + newContext.querySelectorAll( newSelector ) + ); + return results; + } catch ( qsaError ) { + nonnativeSelectorCache( selector, true ); + } finally { + if ( nid === expando ) { + context.removeAttribute( "id" ); + } + } + } + } + } + + // All others + return select( selector.replace( rtrim, "$1" ), context, results, seed ); +} + +/** + * Create key-value caches of limited size + * @returns {function(string, object)} Returns the Object data after storing it on itself with + * property name the (space-suffixed) string and (if the cache is larger than Expr.cacheLength) + * deleting the oldest entry + */ +function createCache() { + var keys = []; + + function cache( key, value ) { + + // Use (key + " ") to avoid collision with native prototype properties (see Issue #157) + if ( keys.push( key + " " ) > Expr.cacheLength ) { + + // Only keep the most recent entries + delete cache[ keys.shift() ]; + } + return ( cache[ key + " " ] = value ); + } + return cache; +} + +/** + * Mark a function for special use by Sizzle + * @param {Function} fn The function to mark + */ +function markFunction( fn ) { + fn[ expando ] = true; + return fn; +} + +/** + * Support testing using an element + * @param {Function} fn Passed the created element and returns a boolean result + */ +function assert( fn ) { + var el = document.createElement( "fieldset" ); + + try { + return !!fn( el ); + } catch ( e ) { + return false; + } finally { + + // Remove from its parent by default + if ( el.parentNode ) { + el.parentNode.removeChild( el ); + } + + // release memory in IE + el = null; + } +} + +/** + * Adds the same handler for all of the specified attrs + * @param {String} attrs Pipe-separated list of attributes + * @param {Function} handler The method that will be applied + */ +function addHandle( attrs, handler ) { + var arr = attrs.split( "|" ), + i = arr.length; + + while ( i-- ) { + Expr.attrHandle[ arr[ i ] ] = handler; + } +} + +/** + * Checks document order of two siblings + * @param {Element} a + * @param {Element} b + * @returns {Number} Returns less than 0 if a precedes b, greater than 0 if a follows b + */ +function siblingCheck( a, b ) { + var cur = b && a, + diff = cur && a.nodeType === 1 && b.nodeType === 1 && + a.sourceIndex - b.sourceIndex; + + // Use IE sourceIndex if available on both nodes + if ( diff ) { + return diff; + } + + // Check if b follows a + if ( cur ) { + while ( ( cur = cur.nextSibling ) ) { + if ( cur === b ) { + return -1; + } + } + } + + return a ? 1 : -1; +} + +/** + * Returns a function to use in pseudos for input types + * @param {String} type + */ +function createInputPseudo( type ) { + return function( elem ) { + var name = elem.nodeName.toLowerCase(); + return name === "input" && elem.type === type; + }; +} + +/** + * Returns a function to use in pseudos for buttons + * @param {String} type + */ +function createButtonPseudo( type ) { + return function( elem ) { + var name = elem.nodeName.toLowerCase(); + return ( name === "input" || name === "button" ) && elem.type === type; + }; +} + +/** + * Returns a function to use in pseudos for :enabled/:disabled + * @param {Boolean} disabled true for :disabled; false for :enabled + */ +function createDisabledPseudo( disabled ) { + + // Known :disabled false positives: fieldset[disabled] > legend:nth-of-type(n+2) :can-disable + return function( elem ) { + + // Only certain elements can match :enabled or :disabled + // https://html.spec.whatwg.org/multipage/scripting.html#selector-enabled + // https://html.spec.whatwg.org/multipage/scripting.html#selector-disabled + if ( "form" in elem ) { + + // Check for inherited disabledness on relevant non-disabled elements: + // * listed form-associated elements in a disabled fieldset + // https://html.spec.whatwg.org/multipage/forms.html#category-listed + // https://html.spec.whatwg.org/multipage/forms.html#concept-fe-disabled + // * option elements in a disabled optgroup + // https://html.spec.whatwg.org/multipage/forms.html#concept-option-disabled + // All such elements have a "form" property. + if ( elem.parentNode && elem.disabled === false ) { + + // Option elements defer to a parent optgroup if present + if ( "label" in elem ) { + if ( "label" in elem.parentNode ) { + return elem.parentNode.disabled === disabled; + } else { + return elem.disabled === disabled; + } + } + + // Support: IE 6 - 11 + // Use the isDisabled shortcut property to check for disabled fieldset ancestors + return elem.isDisabled === disabled || + + // Where there is no isDisabled, check manually + /* jshint -W018 */ + elem.isDisabled !== !disabled && + inDisabledFieldset( elem ) === disabled; + } + + return elem.disabled === disabled; + + // Try to winnow out elements that can't be disabled before trusting the disabled property. + // Some victims get caught in our net (label, legend, menu, track), but it shouldn't + // even exist on them, let alone have a boolean value. + } else if ( "label" in elem ) { + return elem.disabled === disabled; + } + + // Remaining elements are neither :enabled nor :disabled + return false; + }; +} + +/** + * Returns a function to use in pseudos for positionals + * @param {Function} fn + */ +function createPositionalPseudo( fn ) { + return markFunction( function( argument ) { + argument = +argument; + return markFunction( function( seed, matches ) { + var j, + matchIndexes = fn( [], seed.length, argument ), + i = matchIndexes.length; + + // Match elements found at the specified indexes + while ( i-- ) { + if ( seed[ ( j = matchIndexes[ i ] ) ] ) { + seed[ j ] = !( matches[ j ] = seed[ j ] ); + } + } + } ); + } ); +} + +/** + * Checks a node for validity as a Sizzle context + * @param {Element|Object=} context + * @returns {Element|Object|Boolean} The input node if acceptable, otherwise a falsy value + */ +function testContext( context ) { + return context && typeof context.getElementsByTagName !== "undefined" && context; +} + +// Expose support vars for convenience +support = Sizzle.support = {}; + +/** + * Detects XML nodes + * @param {Element|Object} elem An element or a document + * @returns {Boolean} True iff elem is a non-HTML XML node + */ +isXML = Sizzle.isXML = function( elem ) { + var namespace = elem && elem.namespaceURI, + docElem = elem && ( elem.ownerDocument || elem ).documentElement; + + // Support: IE <=8 + // Assume HTML when documentElement doesn't yet exist, such as inside loading iframes + // https://bugs.jquery.com/ticket/4833 + return !rhtml.test( namespace || docElem && docElem.nodeName || "HTML" ); +}; + +/** + * Sets document-related variables once based on the current document + * @param {Element|Object} [doc] An element or document object to use to set the document + * @returns {Object} Returns the current document + */ +setDocument = Sizzle.setDocument = function( node ) { + var hasCompare, subWindow, + doc = node ? node.ownerDocument || node : preferredDoc; + + // Return early if doc is invalid or already selected + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( doc == document || doc.nodeType !== 9 || !doc.documentElement ) { + return document; + } + + // Update global variables + document = doc; + docElem = document.documentElement; + documentIsHTML = !isXML( document ); + + // Support: IE 9 - 11+, Edge 12 - 18+ + // Accessing iframe documents after unload throws "permission denied" errors (jQuery #13936) + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( preferredDoc != document && + ( subWindow = document.defaultView ) && subWindow.top !== subWindow ) { + + // Support: IE 11, Edge + if ( subWindow.addEventListener ) { + subWindow.addEventListener( "unload", unloadHandler, false ); + + // Support: IE 9 - 10 only + } else if ( subWindow.attachEvent ) { + subWindow.attachEvent( "onunload", unloadHandler ); + } + } + + // Support: IE 8 - 11+, Edge 12 - 18+, Chrome <=16 - 25 only, Firefox <=3.6 - 31 only, + // Safari 4 - 5 only, Opera <=11.6 - 12.x only + // IE/Edge & older browsers don't support the :scope pseudo-class. + // Support: Safari 6.0 only + // Safari 6.0 supports :scope but it's an alias of :root there. + support.scope = assert( function( el ) { + docElem.appendChild( el ).appendChild( document.createElement( "div" ) ); + return typeof el.querySelectorAll !== "undefined" && + !el.querySelectorAll( ":scope fieldset div" ).length; + } ); + + /* Attributes + ---------------------------------------------------------------------- */ + + // Support: IE<8 + // Verify that getAttribute really returns attributes and not properties + // (excepting IE8 booleans) + support.attributes = assert( function( el ) { + el.className = "i"; + return !el.getAttribute( "className" ); + } ); + + /* getElement(s)By* + ---------------------------------------------------------------------- */ + + // Check if getElementsByTagName("*") returns only elements + support.getElementsByTagName = assert( function( el ) { + el.appendChild( document.createComment( "" ) ); + return !el.getElementsByTagName( "*" ).length; + } ); + + // Support: IE<9 + support.getElementsByClassName = rnative.test( document.getElementsByClassName ); + + // Support: IE<10 + // Check if getElementById returns elements by name + // The broken getElementById methods don't pick up programmatically-set names, + // so use a roundabout getElementsByName test + support.getById = assert( function( el ) { + docElem.appendChild( el ).id = expando; + return !document.getElementsByName || !document.getElementsByName( expando ).length; + } ); + + // ID filter and find + if ( support.getById ) { + Expr.filter[ "ID" ] = function( id ) { + var attrId = id.replace( runescape, funescape ); + return function( elem ) { + return elem.getAttribute( "id" ) === attrId; + }; + }; + Expr.find[ "ID" ] = function( id, context ) { + if ( typeof context.getElementById !== "undefined" && documentIsHTML ) { + var elem = context.getElementById( id ); + return elem ? [ elem ] : []; + } + }; + } else { + Expr.filter[ "ID" ] = function( id ) { + var attrId = id.replace( runescape, funescape ); + return function( elem ) { + var node = typeof elem.getAttributeNode !== "undefined" && + elem.getAttributeNode( "id" ); + return node && node.value === attrId; + }; + }; + + // Support: IE 6 - 7 only + // getElementById is not reliable as a find shortcut + Expr.find[ "ID" ] = function( id, context ) { + if ( typeof context.getElementById !== "undefined" && documentIsHTML ) { + var node, i, elems, + elem = context.getElementById( id ); + + if ( elem ) { + + // Verify the id attribute + node = elem.getAttributeNode( "id" ); + if ( node && node.value === id ) { + return [ elem ]; + } + + // Fall back on getElementsByName + elems = context.getElementsByName( id ); + i = 0; + while ( ( elem = elems[ i++ ] ) ) { + node = elem.getAttributeNode( "id" ); + if ( node && node.value === id ) { + return [ elem ]; + } + } + } + + return []; + } + }; + } + + // Tag + Expr.find[ "TAG" ] = support.getElementsByTagName ? + function( tag, context ) { + if ( typeof context.getElementsByTagName !== "undefined" ) { + return context.getElementsByTagName( tag ); + + // DocumentFragment nodes don't have gEBTN + } else if ( support.qsa ) { + return context.querySelectorAll( tag ); + } + } : + + function( tag, context ) { + var elem, + tmp = [], + i = 0, + + // By happy coincidence, a (broken) gEBTN appears on DocumentFragment nodes too + results = context.getElementsByTagName( tag ); + + // Filter out possible comments + if ( tag === "*" ) { + while ( ( elem = results[ i++ ] ) ) { + if ( elem.nodeType === 1 ) { + tmp.push( elem ); + } + } + + return tmp; + } + return results; + }; + + // Class + Expr.find[ "CLASS" ] = support.getElementsByClassName && function( className, context ) { + if ( typeof context.getElementsByClassName !== "undefined" && documentIsHTML ) { + return context.getElementsByClassName( className ); + } + }; + + /* QSA/matchesSelector + ---------------------------------------------------------------------- */ + + // QSA and matchesSelector support + + // matchesSelector(:active) reports false when true (IE9/Opera 11.5) + rbuggyMatches = []; + + // qSa(:focus) reports false when true (Chrome 21) + // We allow this because of a bug in IE8/9 that throws an error + // whenever `document.activeElement` is accessed on an iframe + // So, we allow :focus to pass through QSA all the time to avoid the IE error + // See https://bugs.jquery.com/ticket/13378 + rbuggyQSA = []; + + if ( ( support.qsa = rnative.test( document.querySelectorAll ) ) ) { + + // Build QSA regex + // Regex strategy adopted from Diego Perini + assert( function( el ) { + + var input; + + // Select is set to empty string on purpose + // This is to test IE's treatment of not explicitly + // setting a boolean content attribute, + // since its presence should be enough + // https://bugs.jquery.com/ticket/12359 + docElem.appendChild( el ).innerHTML = "" + + ""; + + // Support: IE8, Opera 11-12.16 + // Nothing should be selected when empty strings follow ^= or $= or *= + // The test attribute must be unknown in Opera but "safe" for WinRT + // https://msdn.microsoft.com/en-us/library/ie/hh465388.aspx#attribute_section + if ( el.querySelectorAll( "[msallowcapture^='']" ).length ) { + rbuggyQSA.push( "[*^$]=" + whitespace + "*(?:''|\"\")" ); + } + + // Support: IE8 + // Boolean attributes and "value" are not treated correctly + if ( !el.querySelectorAll( "[selected]" ).length ) { + rbuggyQSA.push( "\\[" + whitespace + "*(?:value|" + booleans + ")" ); + } + + // Support: Chrome<29, Android<4.4, Safari<7.0+, iOS<7.0+, PhantomJS<1.9.8+ + if ( !el.querySelectorAll( "[id~=" + expando + "-]" ).length ) { + rbuggyQSA.push( "~=" ); + } + + // Support: IE 11+, Edge 15 - 18+ + // IE 11/Edge don't find elements on a `[name='']` query in some cases. + // Adding a temporary attribute to the document before the selection works + // around the issue. + // Interestingly, IE 10 & older don't seem to have the issue. + input = document.createElement( "input" ); + input.setAttribute( "name", "" ); + el.appendChild( input ); + if ( !el.querySelectorAll( "[name='']" ).length ) { + rbuggyQSA.push( "\\[" + whitespace + "*name" + whitespace + "*=" + + whitespace + "*(?:''|\"\")" ); + } + + // Webkit/Opera - :checked should return selected option elements + // http://www.w3.org/TR/2011/REC-css3-selectors-20110929/#checked + // IE8 throws error here and will not see later tests + if ( !el.querySelectorAll( ":checked" ).length ) { + rbuggyQSA.push( ":checked" ); + } + + // Support: Safari 8+, iOS 8+ + // https://bugs.webkit.org/show_bug.cgi?id=136851 + // In-page `selector#id sibling-combinator selector` fails + if ( !el.querySelectorAll( "a#" + expando + "+*" ).length ) { + rbuggyQSA.push( ".#.+[+~]" ); + } + + // Support: Firefox <=3.6 - 5 only + // Old Firefox doesn't throw on a badly-escaped identifier. + el.querySelectorAll( "\\\f" ); + rbuggyQSA.push( "[\\r\\n\\f]" ); + } ); + + assert( function( el ) { + el.innerHTML = "" + + ""; + + // Support: Windows 8 Native Apps + // The type and name attributes are restricted during .innerHTML assignment + var input = document.createElement( "input" ); + input.setAttribute( "type", "hidden" ); + el.appendChild( input ).setAttribute( "name", "D" ); + + // Support: IE8 + // Enforce case-sensitivity of name attribute + if ( el.querySelectorAll( "[name=d]" ).length ) { + rbuggyQSA.push( "name" + whitespace + "*[*^$|!~]?=" ); + } + + // FF 3.5 - :enabled/:disabled and hidden elements (hidden elements are still enabled) + // IE8 throws error here and will not see later tests + if ( el.querySelectorAll( ":enabled" ).length !== 2 ) { + rbuggyQSA.push( ":enabled", ":disabled" ); + } + + // Support: IE9-11+ + // IE's :disabled selector does not pick up the children of disabled fieldsets + docElem.appendChild( el ).disabled = true; + if ( el.querySelectorAll( ":disabled" ).length !== 2 ) { + rbuggyQSA.push( ":enabled", ":disabled" ); + } + + // Support: Opera 10 - 11 only + // Opera 10-11 does not throw on post-comma invalid pseudos + el.querySelectorAll( "*,:x" ); + rbuggyQSA.push( ",.*:" ); + } ); + } + + if ( ( support.matchesSelector = rnative.test( ( matches = docElem.matches || + docElem.webkitMatchesSelector || + docElem.mozMatchesSelector || + docElem.oMatchesSelector || + docElem.msMatchesSelector ) ) ) ) { + + assert( function( el ) { + + // Check to see if it's possible to do matchesSelector + // on a disconnected node (IE 9) + support.disconnectedMatch = matches.call( el, "*" ); + + // This should fail with an exception + // Gecko does not error, returns false instead + matches.call( el, "[s!='']:x" ); + rbuggyMatches.push( "!=", pseudos ); + } ); + } + + rbuggyQSA = rbuggyQSA.length && new RegExp( rbuggyQSA.join( "|" ) ); + rbuggyMatches = rbuggyMatches.length && new RegExp( rbuggyMatches.join( "|" ) ); + + /* Contains + ---------------------------------------------------------------------- */ + hasCompare = rnative.test( docElem.compareDocumentPosition ); + + // Element contains another + // Purposefully self-exclusive + // As in, an element does not contain itself + contains = hasCompare || rnative.test( docElem.contains ) ? + function( a, b ) { + var adown = a.nodeType === 9 ? a.documentElement : a, + bup = b && b.parentNode; + return a === bup || !!( bup && bup.nodeType === 1 && ( + adown.contains ? + adown.contains( bup ) : + a.compareDocumentPosition && a.compareDocumentPosition( bup ) & 16 + ) ); + } : + function( a, b ) { + if ( b ) { + while ( ( b = b.parentNode ) ) { + if ( b === a ) { + return true; + } + } + } + return false; + }; + + /* Sorting + ---------------------------------------------------------------------- */ + + // Document order sorting + sortOrder = hasCompare ? + function( a, b ) { + + // Flag for duplicate removal + if ( a === b ) { + hasDuplicate = true; + return 0; + } + + // Sort on method existence if only one input has compareDocumentPosition + var compare = !a.compareDocumentPosition - !b.compareDocumentPosition; + if ( compare ) { + return compare; + } + + // Calculate position if both inputs belong to the same document + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + compare = ( a.ownerDocument || a ) == ( b.ownerDocument || b ) ? + a.compareDocumentPosition( b ) : + + // Otherwise we know they are disconnected + 1; + + // Disconnected nodes + if ( compare & 1 || + ( !support.sortDetached && b.compareDocumentPosition( a ) === compare ) ) { + + // Choose the first element that is related to our preferred document + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( a == document || a.ownerDocument == preferredDoc && + contains( preferredDoc, a ) ) { + return -1; + } + + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( b == document || b.ownerDocument == preferredDoc && + contains( preferredDoc, b ) ) { + return 1; + } + + // Maintain original order + return sortInput ? + ( indexOf( sortInput, a ) - indexOf( sortInput, b ) ) : + 0; + } + + return compare & 4 ? -1 : 1; + } : + function( a, b ) { + + // Exit early if the nodes are identical + if ( a === b ) { + hasDuplicate = true; + return 0; + } + + var cur, + i = 0, + aup = a.parentNode, + bup = b.parentNode, + ap = [ a ], + bp = [ b ]; + + // Parentless nodes are either documents or disconnected + if ( !aup || !bup ) { + + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + /* eslint-disable eqeqeq */ + return a == document ? -1 : + b == document ? 1 : + /* eslint-enable eqeqeq */ + aup ? -1 : + bup ? 1 : + sortInput ? + ( indexOf( sortInput, a ) - indexOf( sortInput, b ) ) : + 0; + + // If the nodes are siblings, we can do a quick check + } else if ( aup === bup ) { + return siblingCheck( a, b ); + } + + // Otherwise we need full lists of their ancestors for comparison + cur = a; + while ( ( cur = cur.parentNode ) ) { + ap.unshift( cur ); + } + cur = b; + while ( ( cur = cur.parentNode ) ) { + bp.unshift( cur ); + } + + // Walk down the tree looking for a discrepancy + while ( ap[ i ] === bp[ i ] ) { + i++; + } + + return i ? + + // Do a sibling check if the nodes have a common ancestor + siblingCheck( ap[ i ], bp[ i ] ) : + + // Otherwise nodes in our document sort first + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + /* eslint-disable eqeqeq */ + ap[ i ] == preferredDoc ? -1 : + bp[ i ] == preferredDoc ? 1 : + /* eslint-enable eqeqeq */ + 0; + }; + + return document; +}; + +Sizzle.matches = function( expr, elements ) { + return Sizzle( expr, null, null, elements ); +}; + +Sizzle.matchesSelector = function( elem, expr ) { + setDocument( elem ); + + if ( support.matchesSelector && documentIsHTML && + !nonnativeSelectorCache[ expr + " " ] && + ( !rbuggyMatches || !rbuggyMatches.test( expr ) ) && + ( !rbuggyQSA || !rbuggyQSA.test( expr ) ) ) { + + try { + var ret = matches.call( elem, expr ); + + // IE 9's matchesSelector returns false on disconnected nodes + if ( ret || support.disconnectedMatch || + + // As well, disconnected nodes are said to be in a document + // fragment in IE 9 + elem.document && elem.document.nodeType !== 11 ) { + return ret; + } + } catch ( e ) { + nonnativeSelectorCache( expr, true ); + } + } + + return Sizzle( expr, document, null, [ elem ] ).length > 0; +}; + +Sizzle.contains = function( context, elem ) { + + // Set document vars if needed + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( ( context.ownerDocument || context ) != document ) { + setDocument( context ); + } + return contains( context, elem ); +}; + +Sizzle.attr = function( elem, name ) { + + // Set document vars if needed + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( ( elem.ownerDocument || elem ) != document ) { + setDocument( elem ); + } + + var fn = Expr.attrHandle[ name.toLowerCase() ], + + // Don't get fooled by Object.prototype properties (jQuery #13807) + val = fn && hasOwn.call( Expr.attrHandle, name.toLowerCase() ) ? + fn( elem, name, !documentIsHTML ) : + undefined; + + return val !== undefined ? + val : + support.attributes || !documentIsHTML ? + elem.getAttribute( name ) : + ( val = elem.getAttributeNode( name ) ) && val.specified ? + val.value : + null; +}; + +Sizzle.escape = function( sel ) { + return ( sel + "" ).replace( rcssescape, fcssescape ); +}; + +Sizzle.error = function( msg ) { + throw new Error( "Syntax error, unrecognized expression: " + msg ); +}; + +/** + * Document sorting and removing duplicates + * @param {ArrayLike} results + */ +Sizzle.uniqueSort = function( results ) { + var elem, + duplicates = [], + j = 0, + i = 0; + + // Unless we *know* we can detect duplicates, assume their presence + hasDuplicate = !support.detectDuplicates; + sortInput = !support.sortStable && results.slice( 0 ); + results.sort( sortOrder ); + + if ( hasDuplicate ) { + while ( ( elem = results[ i++ ] ) ) { + if ( elem === results[ i ] ) { + j = duplicates.push( i ); + } + } + while ( j-- ) { + results.splice( duplicates[ j ], 1 ); + } + } + + // Clear input after sorting to release objects + // See https://github.com/jquery/sizzle/pull/225 + sortInput = null; + + return results; +}; + +/** + * Utility function for retrieving the text value of an array of DOM nodes + * @param {Array|Element} elem + */ +getText = Sizzle.getText = function( elem ) { + var node, + ret = "", + i = 0, + nodeType = elem.nodeType; + + if ( !nodeType ) { + + // If no nodeType, this is expected to be an array + while ( ( node = elem[ i++ ] ) ) { + + // Do not traverse comment nodes + ret += getText( node ); + } + } else if ( nodeType === 1 || nodeType === 9 || nodeType === 11 ) { + + // Use textContent for elements + // innerText usage removed for consistency of new lines (jQuery #11153) + if ( typeof elem.textContent === "string" ) { + return elem.textContent; + } else { + + // Traverse its children + for ( elem = elem.firstChild; elem; elem = elem.nextSibling ) { + ret += getText( elem ); + } + } + } else if ( nodeType === 3 || nodeType === 4 ) { + return elem.nodeValue; + } + + // Do not include comment or processing instruction nodes + + return ret; +}; + +Expr = Sizzle.selectors = { + + // Can be adjusted by the user + cacheLength: 50, + + createPseudo: markFunction, + + match: matchExpr, + + attrHandle: {}, + + find: {}, + + relative: { + ">": { dir: "parentNode", first: true }, + " ": { dir: "parentNode" }, + "+": { dir: "previousSibling", first: true }, + "~": { dir: "previousSibling" } + }, + + preFilter: { + "ATTR": function( match ) { + match[ 1 ] = match[ 1 ].replace( runescape, funescape ); + + // Move the given value to match[3] whether quoted or unquoted + match[ 3 ] = ( match[ 3 ] || match[ 4 ] || + match[ 5 ] || "" ).replace( runescape, funescape ); + + if ( match[ 2 ] === "~=" ) { + match[ 3 ] = " " + match[ 3 ] + " "; + } + + return match.slice( 0, 4 ); + }, + + "CHILD": function( match ) { + + /* matches from matchExpr["CHILD"] + 1 type (only|nth|...) + 2 what (child|of-type) + 3 argument (even|odd|\d*|\d*n([+-]\d+)?|...) + 4 xn-component of xn+y argument ([+-]?\d*n|) + 5 sign of xn-component + 6 x of xn-component + 7 sign of y-component + 8 y of y-component + */ + match[ 1 ] = match[ 1 ].toLowerCase(); + + if ( match[ 1 ].slice( 0, 3 ) === "nth" ) { + + // nth-* requires argument + if ( !match[ 3 ] ) { + Sizzle.error( match[ 0 ] ); + } + + // numeric x and y parameters for Expr.filter.CHILD + // remember that false/true cast respectively to 0/1 + match[ 4 ] = +( match[ 4 ] ? + match[ 5 ] + ( match[ 6 ] || 1 ) : + 2 * ( match[ 3 ] === "even" || match[ 3 ] === "odd" ) ); + match[ 5 ] = +( ( match[ 7 ] + match[ 8 ] ) || match[ 3 ] === "odd" ); + + // other types prohibit arguments + } else if ( match[ 3 ] ) { + Sizzle.error( match[ 0 ] ); + } + + return match; + }, + + "PSEUDO": function( match ) { + var excess, + unquoted = !match[ 6 ] && match[ 2 ]; + + if ( matchExpr[ "CHILD" ].test( match[ 0 ] ) ) { + return null; + } + + // Accept quoted arguments as-is + if ( match[ 3 ] ) { + match[ 2 ] = match[ 4 ] || match[ 5 ] || ""; + + // Strip excess characters from unquoted arguments + } else if ( unquoted && rpseudo.test( unquoted ) && + + // Get excess from tokenize (recursively) + ( excess = tokenize( unquoted, true ) ) && + + // advance to the next closing parenthesis + ( excess = unquoted.indexOf( ")", unquoted.length - excess ) - unquoted.length ) ) { + + // excess is a negative index + match[ 0 ] = match[ 0 ].slice( 0, excess ); + match[ 2 ] = unquoted.slice( 0, excess ); + } + + // Return only captures needed by the pseudo filter method (type and argument) + return match.slice( 0, 3 ); + } + }, + + filter: { + + "TAG": function( nodeNameSelector ) { + var nodeName = nodeNameSelector.replace( runescape, funescape ).toLowerCase(); + return nodeNameSelector === "*" ? + function() { + return true; + } : + function( elem ) { + return elem.nodeName && elem.nodeName.toLowerCase() === nodeName; + }; + }, + + "CLASS": function( className ) { + var pattern = classCache[ className + " " ]; + + return pattern || + ( pattern = new RegExp( "(^|" + whitespace + + ")" + className + "(" + whitespace + "|$)" ) ) && classCache( + className, function( elem ) { + return pattern.test( + typeof elem.className === "string" && elem.className || + typeof elem.getAttribute !== "undefined" && + elem.getAttribute( "class" ) || + "" + ); + } ); + }, + + "ATTR": function( name, operator, check ) { + return function( elem ) { + var result = Sizzle.attr( elem, name ); + + if ( result == null ) { + return operator === "!="; + } + if ( !operator ) { + return true; + } + + result += ""; + + /* eslint-disable max-len */ + + return operator === "=" ? result === check : + operator === "!=" ? result !== check : + operator === "^=" ? check && result.indexOf( check ) === 0 : + operator === "*=" ? check && result.indexOf( check ) > -1 : + operator === "$=" ? check && result.slice( -check.length ) === check : + operator === "~=" ? ( " " + result.replace( rwhitespace, " " ) + " " ).indexOf( check ) > -1 : + operator === "|=" ? result === check || result.slice( 0, check.length + 1 ) === check + "-" : + false; + /* eslint-enable max-len */ + + }; + }, + + "CHILD": function( type, what, _argument, first, last ) { + var simple = type.slice( 0, 3 ) !== "nth", + forward = type.slice( -4 ) !== "last", + ofType = what === "of-type"; + + return first === 1 && last === 0 ? + + // Shortcut for :nth-*(n) + function( elem ) { + return !!elem.parentNode; + } : + + function( elem, _context, xml ) { + var cache, uniqueCache, outerCache, node, nodeIndex, start, + dir = simple !== forward ? "nextSibling" : "previousSibling", + parent = elem.parentNode, + name = ofType && elem.nodeName.toLowerCase(), + useCache = !xml && !ofType, + diff = false; + + if ( parent ) { + + // :(first|last|only)-(child|of-type) + if ( simple ) { + while ( dir ) { + node = elem; + while ( ( node = node[ dir ] ) ) { + if ( ofType ? + node.nodeName.toLowerCase() === name : + node.nodeType === 1 ) { + + return false; + } + } + + // Reverse direction for :only-* (if we haven't yet done so) + start = dir = type === "only" && !start && "nextSibling"; + } + return true; + } + + start = [ forward ? parent.firstChild : parent.lastChild ]; + + // non-xml :nth-child(...) stores cache data on `parent` + if ( forward && useCache ) { + + // Seek `elem` from a previously-cached index + + // ...in a gzip-friendly way + node = parent; + outerCache = node[ expando ] || ( node[ expando ] = {} ); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ node.uniqueID ] || + ( outerCache[ node.uniqueID ] = {} ); + + cache = uniqueCache[ type ] || []; + nodeIndex = cache[ 0 ] === dirruns && cache[ 1 ]; + diff = nodeIndex && cache[ 2 ]; + node = nodeIndex && parent.childNodes[ nodeIndex ]; + + while ( ( node = ++nodeIndex && node && node[ dir ] || + + // Fallback to seeking `elem` from the start + ( diff = nodeIndex = 0 ) || start.pop() ) ) { + + // When found, cache indexes on `parent` and break + if ( node.nodeType === 1 && ++diff && node === elem ) { + uniqueCache[ type ] = [ dirruns, nodeIndex, diff ]; + break; + } + } + + } else { + + // Use previously-cached element index if available + if ( useCache ) { + + // ...in a gzip-friendly way + node = elem; + outerCache = node[ expando ] || ( node[ expando ] = {} ); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ node.uniqueID ] || + ( outerCache[ node.uniqueID ] = {} ); + + cache = uniqueCache[ type ] || []; + nodeIndex = cache[ 0 ] === dirruns && cache[ 1 ]; + diff = nodeIndex; + } + + // xml :nth-child(...) + // or :nth-last-child(...) or :nth(-last)?-of-type(...) + if ( diff === false ) { + + // Use the same loop as above to seek `elem` from the start + while ( ( node = ++nodeIndex && node && node[ dir ] || + ( diff = nodeIndex = 0 ) || start.pop() ) ) { + + if ( ( ofType ? + node.nodeName.toLowerCase() === name : + node.nodeType === 1 ) && + ++diff ) { + + // Cache the index of each encountered element + if ( useCache ) { + outerCache = node[ expando ] || + ( node[ expando ] = {} ); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ node.uniqueID ] || + ( outerCache[ node.uniqueID ] = {} ); + + uniqueCache[ type ] = [ dirruns, diff ]; + } + + if ( node === elem ) { + break; + } + } + } + } + } + + // Incorporate the offset, then check against cycle size + diff -= last; + return diff === first || ( diff % first === 0 && diff / first >= 0 ); + } + }; + }, + + "PSEUDO": function( pseudo, argument ) { + + // pseudo-class names are case-insensitive + // http://www.w3.org/TR/selectors/#pseudo-classes + // Prioritize by case sensitivity in case custom pseudos are added with uppercase letters + // Remember that setFilters inherits from pseudos + var args, + fn = Expr.pseudos[ pseudo ] || Expr.setFilters[ pseudo.toLowerCase() ] || + Sizzle.error( "unsupported pseudo: " + pseudo ); + + // The user may use createPseudo to indicate that + // arguments are needed to create the filter function + // just as Sizzle does + if ( fn[ expando ] ) { + return fn( argument ); + } + + // But maintain support for old signatures + if ( fn.length > 1 ) { + args = [ pseudo, pseudo, "", argument ]; + return Expr.setFilters.hasOwnProperty( pseudo.toLowerCase() ) ? + markFunction( function( seed, matches ) { + var idx, + matched = fn( seed, argument ), + i = matched.length; + while ( i-- ) { + idx = indexOf( seed, matched[ i ] ); + seed[ idx ] = !( matches[ idx ] = matched[ i ] ); + } + } ) : + function( elem ) { + return fn( elem, 0, args ); + }; + } + + return fn; + } + }, + + pseudos: { + + // Potentially complex pseudos + "not": markFunction( function( selector ) { + + // Trim the selector passed to compile + // to avoid treating leading and trailing + // spaces as combinators + var input = [], + results = [], + matcher = compile( selector.replace( rtrim, "$1" ) ); + + return matcher[ expando ] ? + markFunction( function( seed, matches, _context, xml ) { + var elem, + unmatched = matcher( seed, null, xml, [] ), + i = seed.length; + + // Match elements unmatched by `matcher` + while ( i-- ) { + if ( ( elem = unmatched[ i ] ) ) { + seed[ i ] = !( matches[ i ] = elem ); + } + } + } ) : + function( elem, _context, xml ) { + input[ 0 ] = elem; + matcher( input, null, xml, results ); + + // Don't keep the element (issue #299) + input[ 0 ] = null; + return !results.pop(); + }; + } ), + + "has": markFunction( function( selector ) { + return function( elem ) { + return Sizzle( selector, elem ).length > 0; + }; + } ), + + "contains": markFunction( function( text ) { + text = text.replace( runescape, funescape ); + return function( elem ) { + return ( elem.textContent || getText( elem ) ).indexOf( text ) > -1; + }; + } ), + + // "Whether an element is represented by a :lang() selector + // is based solely on the element's language value + // being equal to the identifier C, + // or beginning with the identifier C immediately followed by "-". + // The matching of C against the element's language value is performed case-insensitively. + // The identifier C does not have to be a valid language name." + // http://www.w3.org/TR/selectors/#lang-pseudo + "lang": markFunction( function( lang ) { + + // lang value must be a valid identifier + if ( !ridentifier.test( lang || "" ) ) { + Sizzle.error( "unsupported lang: " + lang ); + } + lang = lang.replace( runescape, funescape ).toLowerCase(); + return function( elem ) { + var elemLang; + do { + if ( ( elemLang = documentIsHTML ? + elem.lang : + elem.getAttribute( "xml:lang" ) || elem.getAttribute( "lang" ) ) ) { + + elemLang = elemLang.toLowerCase(); + return elemLang === lang || elemLang.indexOf( lang + "-" ) === 0; + } + } while ( ( elem = elem.parentNode ) && elem.nodeType === 1 ); + return false; + }; + } ), + + // Miscellaneous + "target": function( elem ) { + var hash = window.location && window.location.hash; + return hash && hash.slice( 1 ) === elem.id; + }, + + "root": function( elem ) { + return elem === docElem; + }, + + "focus": function( elem ) { + return elem === document.activeElement && + ( !document.hasFocus || document.hasFocus() ) && + !!( elem.type || elem.href || ~elem.tabIndex ); + }, + + // Boolean properties + "enabled": createDisabledPseudo( false ), + "disabled": createDisabledPseudo( true ), + + "checked": function( elem ) { + + // In CSS3, :checked should return both checked and selected elements + // http://www.w3.org/TR/2011/REC-css3-selectors-20110929/#checked + var nodeName = elem.nodeName.toLowerCase(); + return ( nodeName === "input" && !!elem.checked ) || + ( nodeName === "option" && !!elem.selected ); + }, + + "selected": function( elem ) { + + // Accessing this property makes selected-by-default + // options in Safari work properly + if ( elem.parentNode ) { + // eslint-disable-next-line no-unused-expressions + elem.parentNode.selectedIndex; + } + + return elem.selected === true; + }, + + // Contents + "empty": function( elem ) { + + // http://www.w3.org/TR/selectors/#empty-pseudo + // :empty is negated by element (1) or content nodes (text: 3; cdata: 4; entity ref: 5), + // but not by others (comment: 8; processing instruction: 7; etc.) + // nodeType < 6 works because attributes (2) do not appear as children + for ( elem = elem.firstChild; elem; elem = elem.nextSibling ) { + if ( elem.nodeType < 6 ) { + return false; + } + } + return true; + }, + + "parent": function( elem ) { + return !Expr.pseudos[ "empty" ]( elem ); + }, + + // Element/input types + "header": function( elem ) { + return rheader.test( elem.nodeName ); + }, + + "input": function( elem ) { + return rinputs.test( elem.nodeName ); + }, + + "button": function( elem ) { + var name = elem.nodeName.toLowerCase(); + return name === "input" && elem.type === "button" || name === "button"; + }, + + "text": function( elem ) { + var attr; + return elem.nodeName.toLowerCase() === "input" && + elem.type === "text" && + + // Support: IE<8 + // New HTML5 attribute values (e.g., "search") appear with elem.type === "text" + ( ( attr = elem.getAttribute( "type" ) ) == null || + attr.toLowerCase() === "text" ); + }, + + // Position-in-collection + "first": createPositionalPseudo( function() { + return [ 0 ]; + } ), + + "last": createPositionalPseudo( function( _matchIndexes, length ) { + return [ length - 1 ]; + } ), + + "eq": createPositionalPseudo( function( _matchIndexes, length, argument ) { + return [ argument < 0 ? argument + length : argument ]; + } ), + + "even": createPositionalPseudo( function( matchIndexes, length ) { + var i = 0; + for ( ; i < length; i += 2 ) { + matchIndexes.push( i ); + } + return matchIndexes; + } ), + + "odd": createPositionalPseudo( function( matchIndexes, length ) { + var i = 1; + for ( ; i < length; i += 2 ) { + matchIndexes.push( i ); + } + return matchIndexes; + } ), + + "lt": createPositionalPseudo( function( matchIndexes, length, argument ) { + var i = argument < 0 ? + argument + length : + argument > length ? + length : + argument; + for ( ; --i >= 0; ) { + matchIndexes.push( i ); + } + return matchIndexes; + } ), + + "gt": createPositionalPseudo( function( matchIndexes, length, argument ) { + var i = argument < 0 ? argument + length : argument; + for ( ; ++i < length; ) { + matchIndexes.push( i ); + } + return matchIndexes; + } ) + } +}; + +Expr.pseudos[ "nth" ] = Expr.pseudos[ "eq" ]; + +// Add button/input type pseudos +for ( i in { radio: true, checkbox: true, file: true, password: true, image: true } ) { + Expr.pseudos[ i ] = createInputPseudo( i ); +} +for ( i in { submit: true, reset: true } ) { + Expr.pseudos[ i ] = createButtonPseudo( i ); +} + +// Easy API for creating new setFilters +function setFilters() {} +setFilters.prototype = Expr.filters = Expr.pseudos; +Expr.setFilters = new setFilters(); + +tokenize = Sizzle.tokenize = function( selector, parseOnly ) { + var matched, match, tokens, type, + soFar, groups, preFilters, + cached = tokenCache[ selector + " " ]; + + if ( cached ) { + return parseOnly ? 0 : cached.slice( 0 ); + } + + soFar = selector; + groups = []; + preFilters = Expr.preFilter; + + while ( soFar ) { + + // Comma and first run + if ( !matched || ( match = rcomma.exec( soFar ) ) ) { + if ( match ) { + + // Don't consume trailing commas as valid + soFar = soFar.slice( match[ 0 ].length ) || soFar; + } + groups.push( ( tokens = [] ) ); + } + + matched = false; + + // Combinators + if ( ( match = rcombinators.exec( soFar ) ) ) { + matched = match.shift(); + tokens.push( { + value: matched, + + // Cast descendant combinators to space + type: match[ 0 ].replace( rtrim, " " ) + } ); + soFar = soFar.slice( matched.length ); + } + + // Filters + for ( type in Expr.filter ) { + if ( ( match = matchExpr[ type ].exec( soFar ) ) && ( !preFilters[ type ] || + ( match = preFilters[ type ]( match ) ) ) ) { + matched = match.shift(); + tokens.push( { + value: matched, + type: type, + matches: match + } ); + soFar = soFar.slice( matched.length ); + } + } + + if ( !matched ) { + break; + } + } + + // Return the length of the invalid excess + // if we're just parsing + // Otherwise, throw an error or return tokens + return parseOnly ? + soFar.length : + soFar ? + Sizzle.error( selector ) : + + // Cache the tokens + tokenCache( selector, groups ).slice( 0 ); +}; + +function toSelector( tokens ) { + var i = 0, + len = tokens.length, + selector = ""; + for ( ; i < len; i++ ) { + selector += tokens[ i ].value; + } + return selector; +} + +function addCombinator( matcher, combinator, base ) { + var dir = combinator.dir, + skip = combinator.next, + key = skip || dir, + checkNonElements = base && key === "parentNode", + doneName = done++; + + return combinator.first ? + + // Check against closest ancestor/preceding element + function( elem, context, xml ) { + while ( ( elem = elem[ dir ] ) ) { + if ( elem.nodeType === 1 || checkNonElements ) { + return matcher( elem, context, xml ); + } + } + return false; + } : + + // Check against all ancestor/preceding elements + function( elem, context, xml ) { + var oldCache, uniqueCache, outerCache, + newCache = [ dirruns, doneName ]; + + // We can't set arbitrary data on XML nodes, so they don't benefit from combinator caching + if ( xml ) { + while ( ( elem = elem[ dir ] ) ) { + if ( elem.nodeType === 1 || checkNonElements ) { + if ( matcher( elem, context, xml ) ) { + return true; + } + } + } + } else { + while ( ( elem = elem[ dir ] ) ) { + if ( elem.nodeType === 1 || checkNonElements ) { + outerCache = elem[ expando ] || ( elem[ expando ] = {} ); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ elem.uniqueID ] || + ( outerCache[ elem.uniqueID ] = {} ); + + if ( skip && skip === elem.nodeName.toLowerCase() ) { + elem = elem[ dir ] || elem; + } else if ( ( oldCache = uniqueCache[ key ] ) && + oldCache[ 0 ] === dirruns && oldCache[ 1 ] === doneName ) { + + // Assign to newCache so results back-propagate to previous elements + return ( newCache[ 2 ] = oldCache[ 2 ] ); + } else { + + // Reuse newcache so results back-propagate to previous elements + uniqueCache[ key ] = newCache; + + // A match means we're done; a fail means we have to keep checking + if ( ( newCache[ 2 ] = matcher( elem, context, xml ) ) ) { + return true; + } + } + } + } + } + return false; + }; +} + +function elementMatcher( matchers ) { + return matchers.length > 1 ? + function( elem, context, xml ) { + var i = matchers.length; + while ( i-- ) { + if ( !matchers[ i ]( elem, context, xml ) ) { + return false; + } + } + return true; + } : + matchers[ 0 ]; +} + +function multipleContexts( selector, contexts, results ) { + var i = 0, + len = contexts.length; + for ( ; i < len; i++ ) { + Sizzle( selector, contexts[ i ], results ); + } + return results; +} + +function condense( unmatched, map, filter, context, xml ) { + var elem, + newUnmatched = [], + i = 0, + len = unmatched.length, + mapped = map != null; + + for ( ; i < len; i++ ) { + if ( ( elem = unmatched[ i ] ) ) { + if ( !filter || filter( elem, context, xml ) ) { + newUnmatched.push( elem ); + if ( mapped ) { + map.push( i ); + } + } + } + } + + return newUnmatched; +} + +function setMatcher( preFilter, selector, matcher, postFilter, postFinder, postSelector ) { + if ( postFilter && !postFilter[ expando ] ) { + postFilter = setMatcher( postFilter ); + } + if ( postFinder && !postFinder[ expando ] ) { + postFinder = setMatcher( postFinder, postSelector ); + } + return markFunction( function( seed, results, context, xml ) { + var temp, i, elem, + preMap = [], + postMap = [], + preexisting = results.length, + + // Get initial elements from seed or context + elems = seed || multipleContexts( + selector || "*", + context.nodeType ? [ context ] : context, + [] + ), + + // Prefilter to get matcher input, preserving a map for seed-results synchronization + matcherIn = preFilter && ( seed || !selector ) ? + condense( elems, preMap, preFilter, context, xml ) : + elems, + + matcherOut = matcher ? + + // If we have a postFinder, or filtered seed, or non-seed postFilter or preexisting results, + postFinder || ( seed ? preFilter : preexisting || postFilter ) ? + + // ...intermediate processing is necessary + [] : + + // ...otherwise use results directly + results : + matcherIn; + + // Find primary matches + if ( matcher ) { + matcher( matcherIn, matcherOut, context, xml ); + } + + // Apply postFilter + if ( postFilter ) { + temp = condense( matcherOut, postMap ); + postFilter( temp, [], context, xml ); + + // Un-match failing elements by moving them back to matcherIn + i = temp.length; + while ( i-- ) { + if ( ( elem = temp[ i ] ) ) { + matcherOut[ postMap[ i ] ] = !( matcherIn[ postMap[ i ] ] = elem ); + } + } + } + + if ( seed ) { + if ( postFinder || preFilter ) { + if ( postFinder ) { + + // Get the final matcherOut by condensing this intermediate into postFinder contexts + temp = []; + i = matcherOut.length; + while ( i-- ) { + if ( ( elem = matcherOut[ i ] ) ) { + + // Restore matcherIn since elem is not yet a final match + temp.push( ( matcherIn[ i ] = elem ) ); + } + } + postFinder( null, ( matcherOut = [] ), temp, xml ); + } + + // Move matched elements from seed to results to keep them synchronized + i = matcherOut.length; + while ( i-- ) { + if ( ( elem = matcherOut[ i ] ) && + ( temp = postFinder ? indexOf( seed, elem ) : preMap[ i ] ) > -1 ) { + + seed[ temp ] = !( results[ temp ] = elem ); + } + } + } + + // Add elements to results, through postFinder if defined + } else { + matcherOut = condense( + matcherOut === results ? + matcherOut.splice( preexisting, matcherOut.length ) : + matcherOut + ); + if ( postFinder ) { + postFinder( null, results, matcherOut, xml ); + } else { + push.apply( results, matcherOut ); + } + } + } ); +} + +function matcherFromTokens( tokens ) { + var checkContext, matcher, j, + len = tokens.length, + leadingRelative = Expr.relative[ tokens[ 0 ].type ], + implicitRelative = leadingRelative || Expr.relative[ " " ], + i = leadingRelative ? 1 : 0, + + // The foundational matcher ensures that elements are reachable from top-level context(s) + matchContext = addCombinator( function( elem ) { + return elem === checkContext; + }, implicitRelative, true ), + matchAnyContext = addCombinator( function( elem ) { + return indexOf( checkContext, elem ) > -1; + }, implicitRelative, true ), + matchers = [ function( elem, context, xml ) { + var ret = ( !leadingRelative && ( xml || context !== outermostContext ) ) || ( + ( checkContext = context ).nodeType ? + matchContext( elem, context, xml ) : + matchAnyContext( elem, context, xml ) ); + + // Avoid hanging onto element (issue #299) + checkContext = null; + return ret; + } ]; + + for ( ; i < len; i++ ) { + if ( ( matcher = Expr.relative[ tokens[ i ].type ] ) ) { + matchers = [ addCombinator( elementMatcher( matchers ), matcher ) ]; + } else { + matcher = Expr.filter[ tokens[ i ].type ].apply( null, tokens[ i ].matches ); + + // Return special upon seeing a positional matcher + if ( matcher[ expando ] ) { + + // Find the next relative operator (if any) for proper handling + j = ++i; + for ( ; j < len; j++ ) { + if ( Expr.relative[ tokens[ j ].type ] ) { + break; + } + } + return setMatcher( + i > 1 && elementMatcher( matchers ), + i > 1 && toSelector( + + // If the preceding token was a descendant combinator, insert an implicit any-element `*` + tokens + .slice( 0, i - 1 ) + .concat( { value: tokens[ i - 2 ].type === " " ? "*" : "" } ) + ).replace( rtrim, "$1" ), + matcher, + i < j && matcherFromTokens( tokens.slice( i, j ) ), + j < len && matcherFromTokens( ( tokens = tokens.slice( j ) ) ), + j < len && toSelector( tokens ) + ); + } + matchers.push( matcher ); + } + } + + return elementMatcher( matchers ); +} + +function matcherFromGroupMatchers( elementMatchers, setMatchers ) { + var bySet = setMatchers.length > 0, + byElement = elementMatchers.length > 0, + superMatcher = function( seed, context, xml, results, outermost ) { + var elem, j, matcher, + matchedCount = 0, + i = "0", + unmatched = seed && [], + setMatched = [], + contextBackup = outermostContext, + + // We must always have either seed elements or outermost context + elems = seed || byElement && Expr.find[ "TAG" ]( "*", outermost ), + + // Use integer dirruns iff this is the outermost matcher + dirrunsUnique = ( dirruns += contextBackup == null ? 1 : Math.random() || 0.1 ), + len = elems.length; + + if ( outermost ) { + + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + outermostContext = context == document || context || outermost; + } + + // Add elements passing elementMatchers directly to results + // Support: IE<9, Safari + // Tolerate NodeList properties (IE: "length"; Safari: ) matching elements by id + for ( ; i !== len && ( elem = elems[ i ] ) != null; i++ ) { + if ( byElement && elem ) { + j = 0; + + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( !context && elem.ownerDocument != document ) { + setDocument( elem ); + xml = !documentIsHTML; + } + while ( ( matcher = elementMatchers[ j++ ] ) ) { + if ( matcher( elem, context || document, xml ) ) { + results.push( elem ); + break; + } + } + if ( outermost ) { + dirruns = dirrunsUnique; + } + } + + // Track unmatched elements for set filters + if ( bySet ) { + + // They will have gone through all possible matchers + if ( ( elem = !matcher && elem ) ) { + matchedCount--; + } + + // Lengthen the array for every element, matched or not + if ( seed ) { + unmatched.push( elem ); + } + } + } + + // `i` is now the count of elements visited above, and adding it to `matchedCount` + // makes the latter nonnegative. + matchedCount += i; + + // Apply set filters to unmatched elements + // NOTE: This can be skipped if there are no unmatched elements (i.e., `matchedCount` + // equals `i`), unless we didn't visit _any_ elements in the above loop because we have + // no element matchers and no seed. + // Incrementing an initially-string "0" `i` allows `i` to remain a string only in that + // case, which will result in a "00" `matchedCount` that differs from `i` but is also + // numerically zero. + if ( bySet && i !== matchedCount ) { + j = 0; + while ( ( matcher = setMatchers[ j++ ] ) ) { + matcher( unmatched, setMatched, context, xml ); + } + + if ( seed ) { + + // Reintegrate element matches to eliminate the need for sorting + if ( matchedCount > 0 ) { + while ( i-- ) { + if ( !( unmatched[ i ] || setMatched[ i ] ) ) { + setMatched[ i ] = pop.call( results ); + } + } + } + + // Discard index placeholder values to get only actual matches + setMatched = condense( setMatched ); + } + + // Add matches to results + push.apply( results, setMatched ); + + // Seedless set matches succeeding multiple successful matchers stipulate sorting + if ( outermost && !seed && setMatched.length > 0 && + ( matchedCount + setMatchers.length ) > 1 ) { + + Sizzle.uniqueSort( results ); + } + } + + // Override manipulation of globals by nested matchers + if ( outermost ) { + dirruns = dirrunsUnique; + outermostContext = contextBackup; + } + + return unmatched; + }; + + return bySet ? + markFunction( superMatcher ) : + superMatcher; +} + +compile = Sizzle.compile = function( selector, match /* Internal Use Only */ ) { + var i, + setMatchers = [], + elementMatchers = [], + cached = compilerCache[ selector + " " ]; + + if ( !cached ) { + + // Generate a function of recursive functions that can be used to check each element + if ( !match ) { + match = tokenize( selector ); + } + i = match.length; + while ( i-- ) { + cached = matcherFromTokens( match[ i ] ); + if ( cached[ expando ] ) { + setMatchers.push( cached ); + } else { + elementMatchers.push( cached ); + } + } + + // Cache the compiled function + cached = compilerCache( + selector, + matcherFromGroupMatchers( elementMatchers, setMatchers ) + ); + + // Save selector and tokenization + cached.selector = selector; + } + return cached; +}; + +/** + * A low-level selection function that works with Sizzle's compiled + * selector functions + * @param {String|Function} selector A selector or a pre-compiled + * selector function built with Sizzle.compile + * @param {Element} context + * @param {Array} [results] + * @param {Array} [seed] A set of elements to match against + */ +select = Sizzle.select = function( selector, context, results, seed ) { + var i, tokens, token, type, find, + compiled = typeof selector === "function" && selector, + match = !seed && tokenize( ( selector = compiled.selector || selector ) ); + + results = results || []; + + // Try to minimize operations if there is only one selector in the list and no seed + // (the latter of which guarantees us context) + if ( match.length === 1 ) { + + // Reduce context if the leading compound selector is an ID + tokens = match[ 0 ] = match[ 0 ].slice( 0 ); + if ( tokens.length > 2 && ( token = tokens[ 0 ] ).type === "ID" && + context.nodeType === 9 && documentIsHTML && Expr.relative[ tokens[ 1 ].type ] ) { + + context = ( Expr.find[ "ID" ]( token.matches[ 0 ] + .replace( runescape, funescape ), context ) || [] )[ 0 ]; + if ( !context ) { + return results; + + // Precompiled matchers will still verify ancestry, so step up a level + } else if ( compiled ) { + context = context.parentNode; + } + + selector = selector.slice( tokens.shift().value.length ); + } + + // Fetch a seed set for right-to-left matching + i = matchExpr[ "needsContext" ].test( selector ) ? 0 : tokens.length; + while ( i-- ) { + token = tokens[ i ]; + + // Abort if we hit a combinator + if ( Expr.relative[ ( type = token.type ) ] ) { + break; + } + if ( ( find = Expr.find[ type ] ) ) { + + // Search, expanding context for leading sibling combinators + if ( ( seed = find( + token.matches[ 0 ].replace( runescape, funescape ), + rsibling.test( tokens[ 0 ].type ) && testContext( context.parentNode ) || + context + ) ) ) { + + // If seed is empty or no tokens remain, we can return early + tokens.splice( i, 1 ); + selector = seed.length && toSelector( tokens ); + if ( !selector ) { + push.apply( results, seed ); + return results; + } + + break; + } + } + } + } + + // Compile and execute a filtering function if one is not provided + // Provide `match` to avoid retokenization if we modified the selector above + ( compiled || compile( selector, match ) )( + seed, + context, + !documentIsHTML, + results, + !context || rsibling.test( selector ) && testContext( context.parentNode ) || context + ); + return results; +}; + +// One-time assignments + +// Sort stability +support.sortStable = expando.split( "" ).sort( sortOrder ).join( "" ) === expando; + +// Support: Chrome 14-35+ +// Always assume duplicates if they aren't passed to the comparison function +support.detectDuplicates = !!hasDuplicate; + +// Initialize against the default document +setDocument(); + +// Support: Webkit<537.32 - Safari 6.0.3/Chrome 25 (fixed in Chrome 27) +// Detached nodes confoundingly follow *each other* +support.sortDetached = assert( function( el ) { + + // Should return 1, but returns 4 (following) + return el.compareDocumentPosition( document.createElement( "fieldset" ) ) & 1; +} ); + +// Support: IE<8 +// Prevent attribute/property "interpolation" +// https://msdn.microsoft.com/en-us/library/ms536429%28VS.85%29.aspx +if ( !assert( function( el ) { + el.innerHTML = ""; + return el.firstChild.getAttribute( "href" ) === "#"; +} ) ) { + addHandle( "type|href|height|width", function( elem, name, isXML ) { + if ( !isXML ) { + return elem.getAttribute( name, name.toLowerCase() === "type" ? 1 : 2 ); + } + } ); +} + +// Support: IE<9 +// Use defaultValue in place of getAttribute("value") +if ( !support.attributes || !assert( function( el ) { + el.innerHTML = ""; + el.firstChild.setAttribute( "value", "" ); + return el.firstChild.getAttribute( "value" ) === ""; +} ) ) { + addHandle( "value", function( elem, _name, isXML ) { + if ( !isXML && elem.nodeName.toLowerCase() === "input" ) { + return elem.defaultValue; + } + } ); +} + +// Support: IE<9 +// Use getAttributeNode to fetch booleans when getAttribute lies +if ( !assert( function( el ) { + return el.getAttribute( "disabled" ) == null; +} ) ) { + addHandle( booleans, function( elem, name, isXML ) { + var val; + if ( !isXML ) { + return elem[ name ] === true ? name.toLowerCase() : + ( val = elem.getAttributeNode( name ) ) && val.specified ? + val.value : + null; + } + } ); +} + +return Sizzle; + +} )( window ); + + + +jQuery.find = Sizzle; +jQuery.expr = Sizzle.selectors; + +// Deprecated +jQuery.expr[ ":" ] = jQuery.expr.pseudos; +jQuery.uniqueSort = jQuery.unique = Sizzle.uniqueSort; +jQuery.text = Sizzle.getText; +jQuery.isXMLDoc = Sizzle.isXML; +jQuery.contains = Sizzle.contains; +jQuery.escapeSelector = Sizzle.escape; + + + + +var dir = function( elem, dir, until ) { + var matched = [], + truncate = until !== undefined; + + while ( ( elem = elem[ dir ] ) && elem.nodeType !== 9 ) { + if ( elem.nodeType === 1 ) { + if ( truncate && jQuery( elem ).is( until ) ) { + break; + } + matched.push( elem ); + } + } + return matched; +}; + + +var siblings = function( n, elem ) { + var matched = []; + + for ( ; n; n = n.nextSibling ) { + if ( n.nodeType === 1 && n !== elem ) { + matched.push( n ); + } + } + + return matched; +}; + + +var rneedsContext = jQuery.expr.match.needsContext; + + + +function nodeName( elem, name ) { + + return elem.nodeName && elem.nodeName.toLowerCase() === name.toLowerCase(); + +} +var rsingleTag = ( /^<([a-z][^\/\0>:\x20\t\r\n\f]*)[\x20\t\r\n\f]*\/?>(?:<\/\1>|)$/i ); + + + +// Implement the identical functionality for filter and not +function winnow( elements, qualifier, not ) { + if ( isFunction( qualifier ) ) { + return jQuery.grep( elements, function( elem, i ) { + return !!qualifier.call( elem, i, elem ) !== not; + } ); + } + + // Single element + if ( qualifier.nodeType ) { + return jQuery.grep( elements, function( elem ) { + return ( elem === qualifier ) !== not; + } ); + } + + // Arraylike of elements (jQuery, arguments, Array) + if ( typeof qualifier !== "string" ) { + return jQuery.grep( elements, function( elem ) { + return ( indexOf.call( qualifier, elem ) > -1 ) !== not; + } ); + } + + // Filtered directly for both simple and complex selectors + return jQuery.filter( qualifier, elements, not ); +} + +jQuery.filter = function( expr, elems, not ) { + var elem = elems[ 0 ]; + + if ( not ) { + expr = ":not(" + expr + ")"; + } + + if ( elems.length === 1 && elem.nodeType === 1 ) { + return jQuery.find.matchesSelector( elem, expr ) ? [ elem ] : []; + } + + return jQuery.find.matches( expr, jQuery.grep( elems, function( elem ) { + return elem.nodeType === 1; + } ) ); +}; + +jQuery.fn.extend( { + find: function( selector ) { + var i, ret, + len = this.length, + self = this; + + if ( typeof selector !== "string" ) { + return this.pushStack( jQuery( selector ).filter( function() { + for ( i = 0; i < len; i++ ) { + if ( jQuery.contains( self[ i ], this ) ) { + return true; + } + } + } ) ); + } + + ret = this.pushStack( [] ); + + for ( i = 0; i < len; i++ ) { + jQuery.find( selector, self[ i ], ret ); + } + + return len > 1 ? jQuery.uniqueSort( ret ) : ret; + }, + filter: function( selector ) { + return this.pushStack( winnow( this, selector || [], false ) ); + }, + not: function( selector ) { + return this.pushStack( winnow( this, selector || [], true ) ); + }, + is: function( selector ) { + return !!winnow( + this, + + // If this is a positional/relative selector, check membership in the returned set + // so $("p:first").is("p:last") won't return true for a doc with two "p". + typeof selector === "string" && rneedsContext.test( selector ) ? + jQuery( selector ) : + selector || [], + false + ).length; + } +} ); + + +// Initialize a jQuery object + + +// A central reference to the root jQuery(document) +var rootjQuery, + + // A simple way to check for HTML strings + // Prioritize #id over to avoid XSS via location.hash (#9521) + // Strict HTML recognition (#11290: must start with <) + // Shortcut simple #id case for speed + rquickExpr = /^(?:\s*(<[\w\W]+>)[^>]*|#([\w-]+))$/, + + init = jQuery.fn.init = function( selector, context, root ) { + var match, elem; + + // HANDLE: $(""), $(null), $(undefined), $(false) + if ( !selector ) { + return this; + } + + // Method init() accepts an alternate rootjQuery + // so migrate can support jQuery.sub (gh-2101) + root = root || rootjQuery; + + // Handle HTML strings + if ( typeof selector === "string" ) { + if ( selector[ 0 ] === "<" && + selector[ selector.length - 1 ] === ">" && + selector.length >= 3 ) { + + // Assume that strings that start and end with <> are HTML and skip the regex check + match = [ null, selector, null ]; + + } else { + match = rquickExpr.exec( selector ); + } + + // Match html or make sure no context is specified for #id + if ( match && ( match[ 1 ] || !context ) ) { + + // HANDLE: $(html) -> $(array) + if ( match[ 1 ] ) { + context = context instanceof jQuery ? context[ 0 ] : context; + + // Option to run scripts is true for back-compat + // Intentionally let the error be thrown if parseHTML is not present + jQuery.merge( this, jQuery.parseHTML( + match[ 1 ], + context && context.nodeType ? context.ownerDocument || context : document, + true + ) ); + + // HANDLE: $(html, props) + if ( rsingleTag.test( match[ 1 ] ) && jQuery.isPlainObject( context ) ) { + for ( match in context ) { + + // Properties of context are called as methods if possible + if ( isFunction( this[ match ] ) ) { + this[ match ]( context[ match ] ); + + // ...and otherwise set as attributes + } else { + this.attr( match, context[ match ] ); + } + } + } + + return this; + + // HANDLE: $(#id) + } else { + elem = document.getElementById( match[ 2 ] ); + + if ( elem ) { + + // Inject the element directly into the jQuery object + this[ 0 ] = elem; + this.length = 1; + } + return this; + } + + // HANDLE: $(expr, $(...)) + } else if ( !context || context.jquery ) { + return ( context || root ).find( selector ); + + // HANDLE: $(expr, context) + // (which is just equivalent to: $(context).find(expr) + } else { + return this.constructor( context ).find( selector ); + } + + // HANDLE: $(DOMElement) + } else if ( selector.nodeType ) { + this[ 0 ] = selector; + this.length = 1; + return this; + + // HANDLE: $(function) + // Shortcut for document ready + } else if ( isFunction( selector ) ) { + return root.ready !== undefined ? + root.ready( selector ) : + + // Execute immediately if ready is not present + selector( jQuery ); + } + + return jQuery.makeArray( selector, this ); + }; + +// Give the init function the jQuery prototype for later instantiation +init.prototype = jQuery.fn; + +// Initialize central reference +rootjQuery = jQuery( document ); + + +var rparentsprev = /^(?:parents|prev(?:Until|All))/, + + // Methods guaranteed to produce a unique set when starting from a unique set + guaranteedUnique = { + children: true, + contents: true, + next: true, + prev: true + }; + +jQuery.fn.extend( { + has: function( target ) { + var targets = jQuery( target, this ), + l = targets.length; + + return this.filter( function() { + var i = 0; + for ( ; i < l; i++ ) { + if ( jQuery.contains( this, targets[ i ] ) ) { + return true; + } + } + } ); + }, + + closest: function( selectors, context ) { + var cur, + i = 0, + l = this.length, + matched = [], + targets = typeof selectors !== "string" && jQuery( selectors ); + + // Positional selectors never match, since there's no _selection_ context + if ( !rneedsContext.test( selectors ) ) { + for ( ; i < l; i++ ) { + for ( cur = this[ i ]; cur && cur !== context; cur = cur.parentNode ) { + + // Always skip document fragments + if ( cur.nodeType < 11 && ( targets ? + targets.index( cur ) > -1 : + + // Don't pass non-elements to Sizzle + cur.nodeType === 1 && + jQuery.find.matchesSelector( cur, selectors ) ) ) { + + matched.push( cur ); + break; + } + } + } + } + + return this.pushStack( matched.length > 1 ? jQuery.uniqueSort( matched ) : matched ); + }, + + // Determine the position of an element within the set + index: function( elem ) { + + // No argument, return index in parent + if ( !elem ) { + return ( this[ 0 ] && this[ 0 ].parentNode ) ? this.first().prevAll().length : -1; + } + + // Index in selector + if ( typeof elem === "string" ) { + return indexOf.call( jQuery( elem ), this[ 0 ] ); + } + + // Locate the position of the desired element + return indexOf.call( this, + + // If it receives a jQuery object, the first element is used + elem.jquery ? elem[ 0 ] : elem + ); + }, + + add: function( selector, context ) { + return this.pushStack( + jQuery.uniqueSort( + jQuery.merge( this.get(), jQuery( selector, context ) ) + ) + ); + }, + + addBack: function( selector ) { + return this.add( selector == null ? + this.prevObject : this.prevObject.filter( selector ) + ); + } +} ); + +function sibling( cur, dir ) { + while ( ( cur = cur[ dir ] ) && cur.nodeType !== 1 ) {} + return cur; +} + +jQuery.each( { + parent: function( elem ) { + var parent = elem.parentNode; + return parent && parent.nodeType !== 11 ? parent : null; + }, + parents: function( elem ) { + return dir( elem, "parentNode" ); + }, + parentsUntil: function( elem, _i, until ) { + return dir( elem, "parentNode", until ); + }, + next: function( elem ) { + return sibling( elem, "nextSibling" ); + }, + prev: function( elem ) { + return sibling( elem, "previousSibling" ); + }, + nextAll: function( elem ) { + return dir( elem, "nextSibling" ); + }, + prevAll: function( elem ) { + return dir( elem, "previousSibling" ); + }, + nextUntil: function( elem, _i, until ) { + return dir( elem, "nextSibling", until ); + }, + prevUntil: function( elem, _i, until ) { + return dir( elem, "previousSibling", until ); + }, + siblings: function( elem ) { + return siblings( ( elem.parentNode || {} ).firstChild, elem ); + }, + children: function( elem ) { + return siblings( elem.firstChild ); + }, + contents: function( elem ) { + if ( elem.contentDocument != null && + + // Support: IE 11+ + // elements with no `data` attribute has an object + // `contentDocument` with a `null` prototype. + getProto( elem.contentDocument ) ) { + + return elem.contentDocument; + } + + // Support: IE 9 - 11 only, iOS 7 only, Android Browser <=4.3 only + // Treat the template element as a regular one in browsers that + // don't support it. + if ( nodeName( elem, "template" ) ) { + elem = elem.content || elem; + } + + return jQuery.merge( [], elem.childNodes ); + } +}, function( name, fn ) { + jQuery.fn[ name ] = function( until, selector ) { + var matched = jQuery.map( this, fn, until ); + + if ( name.slice( -5 ) !== "Until" ) { + selector = until; + } + + if ( selector && typeof selector === "string" ) { + matched = jQuery.filter( selector, matched ); + } + + if ( this.length > 1 ) { + + // Remove duplicates + if ( !guaranteedUnique[ name ] ) { + jQuery.uniqueSort( matched ); + } + + // Reverse order for parents* and prev-derivatives + if ( rparentsprev.test( name ) ) { + matched.reverse(); + } + } + + return this.pushStack( matched ); + }; +} ); +var rnothtmlwhite = ( /[^\x20\t\r\n\f]+/g ); + + + +// Convert String-formatted options into Object-formatted ones +function createOptions( options ) { + var object = {}; + jQuery.each( options.match( rnothtmlwhite ) || [], function( _, flag ) { + object[ flag ] = true; + } ); + return object; +} + +/* + * Create a callback list using the following parameters: + * + * options: an optional list of space-separated options that will change how + * the callback list behaves or a more traditional option object + * + * By default a callback list will act like an event callback list and can be + * "fired" multiple times. + * + * Possible options: + * + * once: will ensure the callback list can only be fired once (like a Deferred) + * + * memory: will keep track of previous values and will call any callback added + * after the list has been fired right away with the latest "memorized" + * values (like a Deferred) + * + * unique: will ensure a callback can only be added once (no duplicate in the list) + * + * stopOnFalse: interrupt callings when a callback returns false + * + */ +jQuery.Callbacks = function( options ) { + + // Convert options from String-formatted to Object-formatted if needed + // (we check in cache first) + options = typeof options === "string" ? + createOptions( options ) : + jQuery.extend( {}, options ); + + var // Flag to know if list is currently firing + firing, + + // Last fire value for non-forgettable lists + memory, + + // Flag to know if list was already fired + fired, + + // Flag to prevent firing + locked, + + // Actual callback list + list = [], + + // Queue of execution data for repeatable lists + queue = [], + + // Index of currently firing callback (modified by add/remove as needed) + firingIndex = -1, + + // Fire callbacks + fire = function() { + + // Enforce single-firing + locked = locked || options.once; + + // Execute callbacks for all pending executions, + // respecting firingIndex overrides and runtime changes + fired = firing = true; + for ( ; queue.length; firingIndex = -1 ) { + memory = queue.shift(); + while ( ++firingIndex < list.length ) { + + // Run callback and check for early termination + if ( list[ firingIndex ].apply( memory[ 0 ], memory[ 1 ] ) === false && + options.stopOnFalse ) { + + // Jump to end and forget the data so .add doesn't re-fire + firingIndex = list.length; + memory = false; + } + } + } + + // Forget the data if we're done with it + if ( !options.memory ) { + memory = false; + } + + firing = false; + + // Clean up if we're done firing for good + if ( locked ) { + + // Keep an empty list if we have data for future add calls + if ( memory ) { + list = []; + + // Otherwise, this object is spent + } else { + list = ""; + } + } + }, + + // Actual Callbacks object + self = { + + // Add a callback or a collection of callbacks to the list + add: function() { + if ( list ) { + + // If we have memory from a past run, we should fire after adding + if ( memory && !firing ) { + firingIndex = list.length - 1; + queue.push( memory ); + } + + ( function add( args ) { + jQuery.each( args, function( _, arg ) { + if ( isFunction( arg ) ) { + if ( !options.unique || !self.has( arg ) ) { + list.push( arg ); + } + } else if ( arg && arg.length && toType( arg ) !== "string" ) { + + // Inspect recursively + add( arg ); + } + } ); + } )( arguments ); + + if ( memory && !firing ) { + fire(); + } + } + return this; + }, + + // Remove a callback from the list + remove: function() { + jQuery.each( arguments, function( _, arg ) { + var index; + while ( ( index = jQuery.inArray( arg, list, index ) ) > -1 ) { + list.splice( index, 1 ); + + // Handle firing indexes + if ( index <= firingIndex ) { + firingIndex--; + } + } + } ); + return this; + }, + + // Check if a given callback is in the list. + // If no argument is given, return whether or not list has callbacks attached. + has: function( fn ) { + return fn ? + jQuery.inArray( fn, list ) > -1 : + list.length > 0; + }, + + // Remove all callbacks from the list + empty: function() { + if ( list ) { + list = []; + } + return this; + }, + + // Disable .fire and .add + // Abort any current/pending executions + // Clear all callbacks and values + disable: function() { + locked = queue = []; + list = memory = ""; + return this; + }, + disabled: function() { + return !list; + }, + + // Disable .fire + // Also disable .add unless we have memory (since it would have no effect) + // Abort any pending executions + lock: function() { + locked = queue = []; + if ( !memory && !firing ) { + list = memory = ""; + } + return this; + }, + locked: function() { + return !!locked; + }, + + // Call all callbacks with the given context and arguments + fireWith: function( context, args ) { + if ( !locked ) { + args = args || []; + args = [ context, args.slice ? args.slice() : args ]; + queue.push( args ); + if ( !firing ) { + fire(); + } + } + return this; + }, + + // Call all the callbacks with the given arguments + fire: function() { + self.fireWith( this, arguments ); + return this; + }, + + // To know if the callbacks have already been called at least once + fired: function() { + return !!fired; + } + }; + + return self; +}; + + +function Identity( v ) { + return v; +} +function Thrower( ex ) { + throw ex; +} + +function adoptValue( value, resolve, reject, noValue ) { + var method; + + try { + + // Check for promise aspect first to privilege synchronous behavior + if ( value && isFunction( ( method = value.promise ) ) ) { + method.call( value ).done( resolve ).fail( reject ); + + // Other thenables + } else if ( value && isFunction( ( method = value.then ) ) ) { + method.call( value, resolve, reject ); + + // Other non-thenables + } else { + + // Control `resolve` arguments by letting Array#slice cast boolean `noValue` to integer: + // * false: [ value ].slice( 0 ) => resolve( value ) + // * true: [ value ].slice( 1 ) => resolve() + resolve.apply( undefined, [ value ].slice( noValue ) ); + } + + // For Promises/A+, convert exceptions into rejections + // Since jQuery.when doesn't unwrap thenables, we can skip the extra checks appearing in + // Deferred#then to conditionally suppress rejection. + } catch ( value ) { + + // Support: Android 4.0 only + // Strict mode functions invoked without .call/.apply get global-object context + reject.apply( undefined, [ value ] ); + } +} + +jQuery.extend( { + + Deferred: function( func ) { + var tuples = [ + + // action, add listener, callbacks, + // ... .then handlers, argument index, [final state] + [ "notify", "progress", jQuery.Callbacks( "memory" ), + jQuery.Callbacks( "memory" ), 2 ], + [ "resolve", "done", jQuery.Callbacks( "once memory" ), + jQuery.Callbacks( "once memory" ), 0, "resolved" ], + [ "reject", "fail", jQuery.Callbacks( "once memory" ), + jQuery.Callbacks( "once memory" ), 1, "rejected" ] + ], + state = "pending", + promise = { + state: function() { + return state; + }, + always: function() { + deferred.done( arguments ).fail( arguments ); + return this; + }, + "catch": function( fn ) { + return promise.then( null, fn ); + }, + + // Keep pipe for back-compat + pipe: function( /* fnDone, fnFail, fnProgress */ ) { + var fns = arguments; + + return jQuery.Deferred( function( newDefer ) { + jQuery.each( tuples, function( _i, tuple ) { + + // Map tuples (progress, done, fail) to arguments (done, fail, progress) + var fn = isFunction( fns[ tuple[ 4 ] ] ) && fns[ tuple[ 4 ] ]; + + // deferred.progress(function() { bind to newDefer or newDefer.notify }) + // deferred.done(function() { bind to newDefer or newDefer.resolve }) + // deferred.fail(function() { bind to newDefer or newDefer.reject }) + deferred[ tuple[ 1 ] ]( function() { + var returned = fn && fn.apply( this, arguments ); + if ( returned && isFunction( returned.promise ) ) { + returned.promise() + .progress( newDefer.notify ) + .done( newDefer.resolve ) + .fail( newDefer.reject ); + } else { + newDefer[ tuple[ 0 ] + "With" ]( + this, + fn ? [ returned ] : arguments + ); + } + } ); + } ); + fns = null; + } ).promise(); + }, + then: function( onFulfilled, onRejected, onProgress ) { + var maxDepth = 0; + function resolve( depth, deferred, handler, special ) { + return function() { + var that = this, + args = arguments, + mightThrow = function() { + var returned, then; + + // Support: Promises/A+ section 2.3.3.3.3 + // https://promisesaplus.com/#point-59 + // Ignore double-resolution attempts + if ( depth < maxDepth ) { + return; + } + + returned = handler.apply( that, args ); + + // Support: Promises/A+ section 2.3.1 + // https://promisesaplus.com/#point-48 + if ( returned === deferred.promise() ) { + throw new TypeError( "Thenable self-resolution" ); + } + + // Support: Promises/A+ sections 2.3.3.1, 3.5 + // https://promisesaplus.com/#point-54 + // https://promisesaplus.com/#point-75 + // Retrieve `then` only once + then = returned && + + // Support: Promises/A+ section 2.3.4 + // https://promisesaplus.com/#point-64 + // Only check objects and functions for thenability + ( typeof returned === "object" || + typeof returned === "function" ) && + returned.then; + + // Handle a returned thenable + if ( isFunction( then ) ) { + + // Special processors (notify) just wait for resolution + if ( special ) { + then.call( + returned, + resolve( maxDepth, deferred, Identity, special ), + resolve( maxDepth, deferred, Thrower, special ) + ); + + // Normal processors (resolve) also hook into progress + } else { + + // ...and disregard older resolution values + maxDepth++; + + then.call( + returned, + resolve( maxDepth, deferred, Identity, special ), + resolve( maxDepth, deferred, Thrower, special ), + resolve( maxDepth, deferred, Identity, + deferred.notifyWith ) + ); + } + + // Handle all other returned values + } else { + + // Only substitute handlers pass on context + // and multiple values (non-spec behavior) + if ( handler !== Identity ) { + that = undefined; + args = [ returned ]; + } + + // Process the value(s) + // Default process is resolve + ( special || deferred.resolveWith )( that, args ); + } + }, + + // Only normal processors (resolve) catch and reject exceptions + process = special ? + mightThrow : + function() { + try { + mightThrow(); + } catch ( e ) { + + if ( jQuery.Deferred.exceptionHook ) { + jQuery.Deferred.exceptionHook( e, + process.stackTrace ); + } + + // Support: Promises/A+ section 2.3.3.3.4.1 + // https://promisesaplus.com/#point-61 + // Ignore post-resolution exceptions + if ( depth + 1 >= maxDepth ) { + + // Only substitute handlers pass on context + // and multiple values (non-spec behavior) + if ( handler !== Thrower ) { + that = undefined; + args = [ e ]; + } + + deferred.rejectWith( that, args ); + } + } + }; + + // Support: Promises/A+ section 2.3.3.3.1 + // https://promisesaplus.com/#point-57 + // Re-resolve promises immediately to dodge false rejection from + // subsequent errors + if ( depth ) { + process(); + } else { + + // Call an optional hook to record the stack, in case of exception + // since it's otherwise lost when execution goes async + if ( jQuery.Deferred.getStackHook ) { + process.stackTrace = jQuery.Deferred.getStackHook(); + } + window.setTimeout( process ); + } + }; + } + + return jQuery.Deferred( function( newDefer ) { + + // progress_handlers.add( ... ) + tuples[ 0 ][ 3 ].add( + resolve( + 0, + newDefer, + isFunction( onProgress ) ? + onProgress : + Identity, + newDefer.notifyWith + ) + ); + + // fulfilled_handlers.add( ... ) + tuples[ 1 ][ 3 ].add( + resolve( + 0, + newDefer, + isFunction( onFulfilled ) ? + onFulfilled : + Identity + ) + ); + + // rejected_handlers.add( ... ) + tuples[ 2 ][ 3 ].add( + resolve( + 0, + newDefer, + isFunction( onRejected ) ? + onRejected : + Thrower + ) + ); + } ).promise(); + }, + + // Get a promise for this deferred + // If obj is provided, the promise aspect is added to the object + promise: function( obj ) { + return obj != null ? jQuery.extend( obj, promise ) : promise; + } + }, + deferred = {}; + + // Add list-specific methods + jQuery.each( tuples, function( i, tuple ) { + var list = tuple[ 2 ], + stateString = tuple[ 5 ]; + + // promise.progress = list.add + // promise.done = list.add + // promise.fail = list.add + promise[ tuple[ 1 ] ] = list.add; + + // Handle state + if ( stateString ) { + list.add( + function() { + + // state = "resolved" (i.e., fulfilled) + // state = "rejected" + state = stateString; + }, + + // rejected_callbacks.disable + // fulfilled_callbacks.disable + tuples[ 3 - i ][ 2 ].disable, + + // rejected_handlers.disable + // fulfilled_handlers.disable + tuples[ 3 - i ][ 3 ].disable, + + // progress_callbacks.lock + tuples[ 0 ][ 2 ].lock, + + // progress_handlers.lock + tuples[ 0 ][ 3 ].lock + ); + } + + // progress_handlers.fire + // fulfilled_handlers.fire + // rejected_handlers.fire + list.add( tuple[ 3 ].fire ); + + // deferred.notify = function() { deferred.notifyWith(...) } + // deferred.resolve = function() { deferred.resolveWith(...) } + // deferred.reject = function() { deferred.rejectWith(...) } + deferred[ tuple[ 0 ] ] = function() { + deferred[ tuple[ 0 ] + "With" ]( this === deferred ? undefined : this, arguments ); + return this; + }; + + // deferred.notifyWith = list.fireWith + // deferred.resolveWith = list.fireWith + // deferred.rejectWith = list.fireWith + deferred[ tuple[ 0 ] + "With" ] = list.fireWith; + } ); + + // Make the deferred a promise + promise.promise( deferred ); + + // Call given func if any + if ( func ) { + func.call( deferred, deferred ); + } + + // All done! + return deferred; + }, + + // Deferred helper + when: function( singleValue ) { + var + + // count of uncompleted subordinates + remaining = arguments.length, + + // count of unprocessed arguments + i = remaining, + + // subordinate fulfillment data + resolveContexts = Array( i ), + resolveValues = slice.call( arguments ), + + // the primary Deferred + primary = jQuery.Deferred(), + + // subordinate callback factory + updateFunc = function( i ) { + return function( value ) { + resolveContexts[ i ] = this; + resolveValues[ i ] = arguments.length > 1 ? slice.call( arguments ) : value; + if ( !( --remaining ) ) { + primary.resolveWith( resolveContexts, resolveValues ); + } + }; + }; + + // Single- and empty arguments are adopted like Promise.resolve + if ( remaining <= 1 ) { + adoptValue( singleValue, primary.done( updateFunc( i ) ).resolve, primary.reject, + !remaining ); + + // Use .then() to unwrap secondary thenables (cf. gh-3000) + if ( primary.state() === "pending" || + isFunction( resolveValues[ i ] && resolveValues[ i ].then ) ) { + + return primary.then(); + } + } + + // Multiple arguments are aggregated like Promise.all array elements + while ( i-- ) { + adoptValue( resolveValues[ i ], updateFunc( i ), primary.reject ); + } + + return primary.promise(); + } +} ); + + +// These usually indicate a programmer mistake during development, +// warn about them ASAP rather than swallowing them by default. +var rerrorNames = /^(Eval|Internal|Range|Reference|Syntax|Type|URI)Error$/; + +jQuery.Deferred.exceptionHook = function( error, stack ) { + + // Support: IE 8 - 9 only + // Console exists when dev tools are open, which can happen at any time + if ( window.console && window.console.warn && error && rerrorNames.test( error.name ) ) { + window.console.warn( "jQuery.Deferred exception: " + error.message, error.stack, stack ); + } +}; + + + + +jQuery.readyException = function( error ) { + window.setTimeout( function() { + throw error; + } ); +}; + + + + +// The deferred used on DOM ready +var readyList = jQuery.Deferred(); + +jQuery.fn.ready = function( fn ) { + + readyList + .then( fn ) + + // Wrap jQuery.readyException in a function so that the lookup + // happens at the time of error handling instead of callback + // registration. + .catch( function( error ) { + jQuery.readyException( error ); + } ); + + return this; +}; + +jQuery.extend( { + + // Is the DOM ready to be used? Set to true once it occurs. + isReady: false, + + // A counter to track how many items to wait for before + // the ready event fires. See #6781 + readyWait: 1, + + // Handle when the DOM is ready + ready: function( wait ) { + + // Abort if there are pending holds or we're already ready + if ( wait === true ? --jQuery.readyWait : jQuery.isReady ) { + return; + } + + // Remember that the DOM is ready + jQuery.isReady = true; + + // If a normal DOM Ready event fired, decrement, and wait if need be + if ( wait !== true && --jQuery.readyWait > 0 ) { + return; + } + + // If there are functions bound, to execute + readyList.resolveWith( document, [ jQuery ] ); + } +} ); + +jQuery.ready.then = readyList.then; + +// The ready event handler and self cleanup method +function completed() { + document.removeEventListener( "DOMContentLoaded", completed ); + window.removeEventListener( "load", completed ); + jQuery.ready(); +} + +// Catch cases where $(document).ready() is called +// after the browser event has already occurred. +// Support: IE <=9 - 10 only +// Older IE sometimes signals "interactive" too soon +if ( document.readyState === "complete" || + ( document.readyState !== "loading" && !document.documentElement.doScroll ) ) { + + // Handle it asynchronously to allow scripts the opportunity to delay ready + window.setTimeout( jQuery.ready ); + +} else { + + // Use the handy event callback + document.addEventListener( "DOMContentLoaded", completed ); + + // A fallback to window.onload, that will always work + window.addEventListener( "load", completed ); +} + + + + +// Multifunctional method to get and set values of a collection +// The value/s can optionally be executed if it's a function +var access = function( elems, fn, key, value, chainable, emptyGet, raw ) { + var i = 0, + len = elems.length, + bulk = key == null; + + // Sets many values + if ( toType( key ) === "object" ) { + chainable = true; + for ( i in key ) { + access( elems, fn, i, key[ i ], true, emptyGet, raw ); + } + + // Sets one value + } else if ( value !== undefined ) { + chainable = true; + + if ( !isFunction( value ) ) { + raw = true; + } + + if ( bulk ) { + + // Bulk operations run against the entire set + if ( raw ) { + fn.call( elems, value ); + fn = null; + + // ...except when executing function values + } else { + bulk = fn; + fn = function( elem, _key, value ) { + return bulk.call( jQuery( elem ), value ); + }; + } + } + + if ( fn ) { + for ( ; i < len; i++ ) { + fn( + elems[ i ], key, raw ? + value : + value.call( elems[ i ], i, fn( elems[ i ], key ) ) + ); + } + } + } + + if ( chainable ) { + return elems; + } + + // Gets + if ( bulk ) { + return fn.call( elems ); + } + + return len ? fn( elems[ 0 ], key ) : emptyGet; +}; + + +// Matches dashed string for camelizing +var rmsPrefix = /^-ms-/, + rdashAlpha = /-([a-z])/g; + +// Used by camelCase as callback to replace() +function fcamelCase( _all, letter ) { + return letter.toUpperCase(); +} + +// Convert dashed to camelCase; used by the css and data modules +// Support: IE <=9 - 11, Edge 12 - 15 +// Microsoft forgot to hump their vendor prefix (#9572) +function camelCase( string ) { + return string.replace( rmsPrefix, "ms-" ).replace( rdashAlpha, fcamelCase ); +} +var acceptData = function( owner ) { + + // Accepts only: + // - Node + // - Node.ELEMENT_NODE + // - Node.DOCUMENT_NODE + // - Object + // - Any + return owner.nodeType === 1 || owner.nodeType === 9 || !( +owner.nodeType ); +}; + + + + +function Data() { + this.expando = jQuery.expando + Data.uid++; +} + +Data.uid = 1; + +Data.prototype = { + + cache: function( owner ) { + + // Check if the owner object already has a cache + var value = owner[ this.expando ]; + + // If not, create one + if ( !value ) { + value = {}; + + // We can accept data for non-element nodes in modern browsers, + // but we should not, see #8335. + // Always return an empty object. + if ( acceptData( owner ) ) { + + // If it is a node unlikely to be stringify-ed or looped over + // use plain assignment + if ( owner.nodeType ) { + owner[ this.expando ] = value; + + // Otherwise secure it in a non-enumerable property + // configurable must be true to allow the property to be + // deleted when data is removed + } else { + Object.defineProperty( owner, this.expando, { + value: value, + configurable: true + } ); + } + } + } + + return value; + }, + set: function( owner, data, value ) { + var prop, + cache = this.cache( owner ); + + // Handle: [ owner, key, value ] args + // Always use camelCase key (gh-2257) + if ( typeof data === "string" ) { + cache[ camelCase( data ) ] = value; + + // Handle: [ owner, { properties } ] args + } else { + + // Copy the properties one-by-one to the cache object + for ( prop in data ) { + cache[ camelCase( prop ) ] = data[ prop ]; + } + } + return cache; + }, + get: function( owner, key ) { + return key === undefined ? + this.cache( owner ) : + + // Always use camelCase key (gh-2257) + owner[ this.expando ] && owner[ this.expando ][ camelCase( key ) ]; + }, + access: function( owner, key, value ) { + + // In cases where either: + // + // 1. No key was specified + // 2. A string key was specified, but no value provided + // + // Take the "read" path and allow the get method to determine + // which value to return, respectively either: + // + // 1. The entire cache object + // 2. The data stored at the key + // + if ( key === undefined || + ( ( key && typeof key === "string" ) && value === undefined ) ) { + + return this.get( owner, key ); + } + + // When the key is not a string, or both a key and value + // are specified, set or extend (existing objects) with either: + // + // 1. An object of properties + // 2. A key and value + // + this.set( owner, key, value ); + + // Since the "set" path can have two possible entry points + // return the expected data based on which path was taken[*] + return value !== undefined ? value : key; + }, + remove: function( owner, key ) { + var i, + cache = owner[ this.expando ]; + + if ( cache === undefined ) { + return; + } + + if ( key !== undefined ) { + + // Support array or space separated string of keys + if ( Array.isArray( key ) ) { + + // If key is an array of keys... + // We always set camelCase keys, so remove that. + key = key.map( camelCase ); + } else { + key = camelCase( key ); + + // If a key with the spaces exists, use it. + // Otherwise, create an array by matching non-whitespace + key = key in cache ? + [ key ] : + ( key.match( rnothtmlwhite ) || [] ); + } + + i = key.length; + + while ( i-- ) { + delete cache[ key[ i ] ]; + } + } + + // Remove the expando if there's no more data + if ( key === undefined || jQuery.isEmptyObject( cache ) ) { + + // Support: Chrome <=35 - 45 + // Webkit & Blink performance suffers when deleting properties + // from DOM nodes, so set to undefined instead + // https://bugs.chromium.org/p/chromium/issues/detail?id=378607 (bug restricted) + if ( owner.nodeType ) { + owner[ this.expando ] = undefined; + } else { + delete owner[ this.expando ]; + } + } + }, + hasData: function( owner ) { + var cache = owner[ this.expando ]; + return cache !== undefined && !jQuery.isEmptyObject( cache ); + } +}; +var dataPriv = new Data(); + +var dataUser = new Data(); + + + +// Implementation Summary +// +// 1. Enforce API surface and semantic compatibility with 1.9.x branch +// 2. Improve the module's maintainability by reducing the storage +// paths to a single mechanism. +// 3. Use the same single mechanism to support "private" and "user" data. +// 4. _Never_ expose "private" data to user code (TODO: Drop _data, _removeData) +// 5. Avoid exposing implementation details on user objects (eg. expando properties) +// 6. Provide a clear path for implementation upgrade to WeakMap in 2014 + +var rbrace = /^(?:\{[\w\W]*\}|\[[\w\W]*\])$/, + rmultiDash = /[A-Z]/g; + +function getData( data ) { + if ( data === "true" ) { + return true; + } + + if ( data === "false" ) { + return false; + } + + if ( data === "null" ) { + return null; + } + + // Only convert to a number if it doesn't change the string + if ( data === +data + "" ) { + return +data; + } + + if ( rbrace.test( data ) ) { + return JSON.parse( data ); + } + + return data; +} + +function dataAttr( elem, key, data ) { + var name; + + // If nothing was found internally, try to fetch any + // data from the HTML5 data-* attribute + if ( data === undefined && elem.nodeType === 1 ) { + name = "data-" + key.replace( rmultiDash, "-$&" ).toLowerCase(); + data = elem.getAttribute( name ); + + if ( typeof data === "string" ) { + try { + data = getData( data ); + } catch ( e ) {} + + // Make sure we set the data so it isn't changed later + dataUser.set( elem, key, data ); + } else { + data = undefined; + } + } + return data; +} + +jQuery.extend( { + hasData: function( elem ) { + return dataUser.hasData( elem ) || dataPriv.hasData( elem ); + }, + + data: function( elem, name, data ) { + return dataUser.access( elem, name, data ); + }, + + removeData: function( elem, name ) { + dataUser.remove( elem, name ); + }, + + // TODO: Now that all calls to _data and _removeData have been replaced + // with direct calls to dataPriv methods, these can be deprecated. + _data: function( elem, name, data ) { + return dataPriv.access( elem, name, data ); + }, + + _removeData: function( elem, name ) { + dataPriv.remove( elem, name ); + } +} ); + +jQuery.fn.extend( { + data: function( key, value ) { + var i, name, data, + elem = this[ 0 ], + attrs = elem && elem.attributes; + + // Gets all values + if ( key === undefined ) { + if ( this.length ) { + data = dataUser.get( elem ); + + if ( elem.nodeType === 1 && !dataPriv.get( elem, "hasDataAttrs" ) ) { + i = attrs.length; + while ( i-- ) { + + // Support: IE 11 only + // The attrs elements can be null (#14894) + if ( attrs[ i ] ) { + name = attrs[ i ].name; + if ( name.indexOf( "data-" ) === 0 ) { + name = camelCase( name.slice( 5 ) ); + dataAttr( elem, name, data[ name ] ); + } + } + } + dataPriv.set( elem, "hasDataAttrs", true ); + } + } + + return data; + } + + // Sets multiple values + if ( typeof key === "object" ) { + return this.each( function() { + dataUser.set( this, key ); + } ); + } + + return access( this, function( value ) { + var data; + + // The calling jQuery object (element matches) is not empty + // (and therefore has an element appears at this[ 0 ]) and the + // `value` parameter was not undefined. An empty jQuery object + // will result in `undefined` for elem = this[ 0 ] which will + // throw an exception if an attempt to read a data cache is made. + if ( elem && value === undefined ) { + + // Attempt to get data from the cache + // The key will always be camelCased in Data + data = dataUser.get( elem, key ); + if ( data !== undefined ) { + return data; + } + + // Attempt to "discover" the data in + // HTML5 custom data-* attrs + data = dataAttr( elem, key ); + if ( data !== undefined ) { + return data; + } + + // We tried really hard, but the data doesn't exist. + return; + } + + // Set the data... + this.each( function() { + + // We always store the camelCased key + dataUser.set( this, key, value ); + } ); + }, null, value, arguments.length > 1, null, true ); + }, + + removeData: function( key ) { + return this.each( function() { + dataUser.remove( this, key ); + } ); + } +} ); + + +jQuery.extend( { + queue: function( elem, type, data ) { + var queue; + + if ( elem ) { + type = ( type || "fx" ) + "queue"; + queue = dataPriv.get( elem, type ); + + // Speed up dequeue by getting out quickly if this is just a lookup + if ( data ) { + if ( !queue || Array.isArray( data ) ) { + queue = dataPriv.access( elem, type, jQuery.makeArray( data ) ); + } else { + queue.push( data ); + } + } + return queue || []; + } + }, + + dequeue: function( elem, type ) { + type = type || "fx"; + + var queue = jQuery.queue( elem, type ), + startLength = queue.length, + fn = queue.shift(), + hooks = jQuery._queueHooks( elem, type ), + next = function() { + jQuery.dequeue( elem, type ); + }; + + // If the fx queue is dequeued, always remove the progress sentinel + if ( fn === "inprogress" ) { + fn = queue.shift(); + startLength--; + } + + if ( fn ) { + + // Add a progress sentinel to prevent the fx queue from being + // automatically dequeued + if ( type === "fx" ) { + queue.unshift( "inprogress" ); + } + + // Clear up the last queue stop function + delete hooks.stop; + fn.call( elem, next, hooks ); + } + + if ( !startLength && hooks ) { + hooks.empty.fire(); + } + }, + + // Not public - generate a queueHooks object, or return the current one + _queueHooks: function( elem, type ) { + var key = type + "queueHooks"; + return dataPriv.get( elem, key ) || dataPriv.access( elem, key, { + empty: jQuery.Callbacks( "once memory" ).add( function() { + dataPriv.remove( elem, [ type + "queue", key ] ); + } ) + } ); + } +} ); + +jQuery.fn.extend( { + queue: function( type, data ) { + var setter = 2; + + if ( typeof type !== "string" ) { + data = type; + type = "fx"; + setter--; + } + + if ( arguments.length < setter ) { + return jQuery.queue( this[ 0 ], type ); + } + + return data === undefined ? + this : + this.each( function() { + var queue = jQuery.queue( this, type, data ); + + // Ensure a hooks for this queue + jQuery._queueHooks( this, type ); + + if ( type === "fx" && queue[ 0 ] !== "inprogress" ) { + jQuery.dequeue( this, type ); + } + } ); + }, + dequeue: function( type ) { + return this.each( function() { + jQuery.dequeue( this, type ); + } ); + }, + clearQueue: function( type ) { + return this.queue( type || "fx", [] ); + }, + + // Get a promise resolved when queues of a certain type + // are emptied (fx is the type by default) + promise: function( type, obj ) { + var tmp, + count = 1, + defer = jQuery.Deferred(), + elements = this, + i = this.length, + resolve = function() { + if ( !( --count ) ) { + defer.resolveWith( elements, [ elements ] ); + } + }; + + if ( typeof type !== "string" ) { + obj = type; + type = undefined; + } + type = type || "fx"; + + while ( i-- ) { + tmp = dataPriv.get( elements[ i ], type + "queueHooks" ); + if ( tmp && tmp.empty ) { + count++; + tmp.empty.add( resolve ); + } + } + resolve(); + return defer.promise( obj ); + } +} ); +var pnum = ( /[+-]?(?:\d*\.|)\d+(?:[eE][+-]?\d+|)/ ).source; + +var rcssNum = new RegExp( "^(?:([+-])=|)(" + pnum + ")([a-z%]*)$", "i" ); + + +var cssExpand = [ "Top", "Right", "Bottom", "Left" ]; + +var documentElement = document.documentElement; + + + + var isAttached = function( elem ) { + return jQuery.contains( elem.ownerDocument, elem ); + }, + composed = { composed: true }; + + // Support: IE 9 - 11+, Edge 12 - 18+, iOS 10.0 - 10.2 only + // Check attachment across shadow DOM boundaries when possible (gh-3504) + // Support: iOS 10.0-10.2 only + // Early iOS 10 versions support `attachShadow` but not `getRootNode`, + // leading to errors. We need to check for `getRootNode`. + if ( documentElement.getRootNode ) { + isAttached = function( elem ) { + return jQuery.contains( elem.ownerDocument, elem ) || + elem.getRootNode( composed ) === elem.ownerDocument; + }; + } +var isHiddenWithinTree = function( elem, el ) { + + // isHiddenWithinTree might be called from jQuery#filter function; + // in that case, element will be second argument + elem = el || elem; + + // Inline style trumps all + return elem.style.display === "none" || + elem.style.display === "" && + + // Otherwise, check computed style + // Support: Firefox <=43 - 45 + // Disconnected elements can have computed display: none, so first confirm that elem is + // in the document. + isAttached( elem ) && + + jQuery.css( elem, "display" ) === "none"; + }; + + + +function adjustCSS( elem, prop, valueParts, tween ) { + var adjusted, scale, + maxIterations = 20, + currentValue = tween ? + function() { + return tween.cur(); + } : + function() { + return jQuery.css( elem, prop, "" ); + }, + initial = currentValue(), + unit = valueParts && valueParts[ 3 ] || ( jQuery.cssNumber[ prop ] ? "" : "px" ), + + // Starting value computation is required for potential unit mismatches + initialInUnit = elem.nodeType && + ( jQuery.cssNumber[ prop ] || unit !== "px" && +initial ) && + rcssNum.exec( jQuery.css( elem, prop ) ); + + if ( initialInUnit && initialInUnit[ 3 ] !== unit ) { + + // Support: Firefox <=54 + // Halve the iteration target value to prevent interference from CSS upper bounds (gh-2144) + initial = initial / 2; + + // Trust units reported by jQuery.css + unit = unit || initialInUnit[ 3 ]; + + // Iteratively approximate from a nonzero starting point + initialInUnit = +initial || 1; + + while ( maxIterations-- ) { + + // Evaluate and update our best guess (doubling guesses that zero out). + // Finish if the scale equals or crosses 1 (making the old*new product non-positive). + jQuery.style( elem, prop, initialInUnit + unit ); + if ( ( 1 - scale ) * ( 1 - ( scale = currentValue() / initial || 0.5 ) ) <= 0 ) { + maxIterations = 0; + } + initialInUnit = initialInUnit / scale; + + } + + initialInUnit = initialInUnit * 2; + jQuery.style( elem, prop, initialInUnit + unit ); + + // Make sure we update the tween properties later on + valueParts = valueParts || []; + } + + if ( valueParts ) { + initialInUnit = +initialInUnit || +initial || 0; + + // Apply relative offset (+=/-=) if specified + adjusted = valueParts[ 1 ] ? + initialInUnit + ( valueParts[ 1 ] + 1 ) * valueParts[ 2 ] : + +valueParts[ 2 ]; + if ( tween ) { + tween.unit = unit; + tween.start = initialInUnit; + tween.end = adjusted; + } + } + return adjusted; +} + + +var defaultDisplayMap = {}; + +function getDefaultDisplay( elem ) { + var temp, + doc = elem.ownerDocument, + nodeName = elem.nodeName, + display = defaultDisplayMap[ nodeName ]; + + if ( display ) { + return display; + } + + temp = doc.body.appendChild( doc.createElement( nodeName ) ); + display = jQuery.css( temp, "display" ); + + temp.parentNode.removeChild( temp ); + + if ( display === "none" ) { + display = "block"; + } + defaultDisplayMap[ nodeName ] = display; + + return display; +} + +function showHide( elements, show ) { + var display, elem, + values = [], + index = 0, + length = elements.length; + + // Determine new display value for elements that need to change + for ( ; index < length; index++ ) { + elem = elements[ index ]; + if ( !elem.style ) { + continue; + } + + display = elem.style.display; + if ( show ) { + + // Since we force visibility upon cascade-hidden elements, an immediate (and slow) + // check is required in this first loop unless we have a nonempty display value (either + // inline or about-to-be-restored) + if ( display === "none" ) { + values[ index ] = dataPriv.get( elem, "display" ) || null; + if ( !values[ index ] ) { + elem.style.display = ""; + } + } + if ( elem.style.display === "" && isHiddenWithinTree( elem ) ) { + values[ index ] = getDefaultDisplay( elem ); + } + } else { + if ( display !== "none" ) { + values[ index ] = "none"; + + // Remember what we're overwriting + dataPriv.set( elem, "display", display ); + } + } + } + + // Set the display of the elements in a second loop to avoid constant reflow + for ( index = 0; index < length; index++ ) { + if ( values[ index ] != null ) { + elements[ index ].style.display = values[ index ]; + } + } + + return elements; +} + +jQuery.fn.extend( { + show: function() { + return showHide( this, true ); + }, + hide: function() { + return showHide( this ); + }, + toggle: function( state ) { + if ( typeof state === "boolean" ) { + return state ? this.show() : this.hide(); + } + + return this.each( function() { + if ( isHiddenWithinTree( this ) ) { + jQuery( this ).show(); + } else { + jQuery( this ).hide(); + } + } ); + } +} ); +var rcheckableType = ( /^(?:checkbox|radio)$/i ); + +var rtagName = ( /<([a-z][^\/\0>\x20\t\r\n\f]*)/i ); + +var rscriptType = ( /^$|^module$|\/(?:java|ecma)script/i ); + + + +( function() { + var fragment = document.createDocumentFragment(), + div = fragment.appendChild( document.createElement( "div" ) ), + input = document.createElement( "input" ); + + // Support: Android 4.0 - 4.3 only + // Check state lost if the name is set (#11217) + // Support: Windows Web Apps (WWA) + // `name` and `type` must use .setAttribute for WWA (#14901) + input.setAttribute( "type", "radio" ); + input.setAttribute( "checked", "checked" ); + input.setAttribute( "name", "t" ); + + div.appendChild( input ); + + // Support: Android <=4.1 only + // Older WebKit doesn't clone checked state correctly in fragments + support.checkClone = div.cloneNode( true ).cloneNode( true ).lastChild.checked; + + // Support: IE <=11 only + // Make sure textarea (and checkbox) defaultValue is properly cloned + div.innerHTML = ""; + support.noCloneChecked = !!div.cloneNode( true ).lastChild.defaultValue; + + // Support: IE <=9 only + // IE <=9 replaces "; + support.option = !!div.lastChild; +} )(); + + +// We have to close these tags to support XHTML (#13200) +var wrapMap = { + + // XHTML parsers do not magically insert elements in the + // same way that tag soup parsers do. So we cannot shorten + // this by omitting or other required elements. + thead: [ 1, "", "
" ], + col: [ 2, "", "
" ], + tr: [ 2, "", "
" ], + td: [ 3, "", "
" ], + + _default: [ 0, "", "" ] +}; + +wrapMap.tbody = wrapMap.tfoot = wrapMap.colgroup = wrapMap.caption = wrapMap.thead; +wrapMap.th = wrapMap.td; + +// Support: IE <=9 only +if ( !support.option ) { + wrapMap.optgroup = wrapMap.option = [ 1, "" ]; +} + + +function getAll( context, tag ) { + + // Support: IE <=9 - 11 only + // Use typeof to avoid zero-argument method invocation on host objects (#15151) + var ret; + + if ( typeof context.getElementsByTagName !== "undefined" ) { + ret = context.getElementsByTagName( tag || "*" ); + + } else if ( typeof context.querySelectorAll !== "undefined" ) { + ret = context.querySelectorAll( tag || "*" ); + + } else { + ret = []; + } + + if ( tag === undefined || tag && nodeName( context, tag ) ) { + return jQuery.merge( [ context ], ret ); + } + + return ret; +} + + +// Mark scripts as having already been evaluated +function setGlobalEval( elems, refElements ) { + var i = 0, + l = elems.length; + + for ( ; i < l; i++ ) { + dataPriv.set( + elems[ i ], + "globalEval", + !refElements || dataPriv.get( refElements[ i ], "globalEval" ) + ); + } +} + + +var rhtml = /<|&#?\w+;/; + +function buildFragment( elems, context, scripts, selection, ignored ) { + var elem, tmp, tag, wrap, attached, j, + fragment = context.createDocumentFragment(), + nodes = [], + i = 0, + l = elems.length; + + for ( ; i < l; i++ ) { + elem = elems[ i ]; + + if ( elem || elem === 0 ) { + + // Add nodes directly + if ( toType( elem ) === "object" ) { + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + jQuery.merge( nodes, elem.nodeType ? [ elem ] : elem ); + + // Convert non-html into a text node + } else if ( !rhtml.test( elem ) ) { + nodes.push( context.createTextNode( elem ) ); + + // Convert html into DOM nodes + } else { + tmp = tmp || fragment.appendChild( context.createElement( "div" ) ); + + // Deserialize a standard representation + tag = ( rtagName.exec( elem ) || [ "", "" ] )[ 1 ].toLowerCase(); + wrap = wrapMap[ tag ] || wrapMap._default; + tmp.innerHTML = wrap[ 1 ] + jQuery.htmlPrefilter( elem ) + wrap[ 2 ]; + + // Descend through wrappers to the right content + j = wrap[ 0 ]; + while ( j-- ) { + tmp = tmp.lastChild; + } + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + jQuery.merge( nodes, tmp.childNodes ); + + // Remember the top-level container + tmp = fragment.firstChild; + + // Ensure the created nodes are orphaned (#12392) + tmp.textContent = ""; + } + } + } + + // Remove wrapper from fragment + fragment.textContent = ""; + + i = 0; + while ( ( elem = nodes[ i++ ] ) ) { + + // Skip elements already in the context collection (trac-4087) + if ( selection && jQuery.inArray( elem, selection ) > -1 ) { + if ( ignored ) { + ignored.push( elem ); + } + continue; + } + + attached = isAttached( elem ); + + // Append to fragment + tmp = getAll( fragment.appendChild( elem ), "script" ); + + // Preserve script evaluation history + if ( attached ) { + setGlobalEval( tmp ); + } + + // Capture executables + if ( scripts ) { + j = 0; + while ( ( elem = tmp[ j++ ] ) ) { + if ( rscriptType.test( elem.type || "" ) ) { + scripts.push( elem ); + } + } + } + } + + return fragment; +} + + +var rtypenamespace = /^([^.]*)(?:\.(.+)|)/; + +function returnTrue() { + return true; +} + +function returnFalse() { + return false; +} + +// Support: IE <=9 - 11+ +// focus() and blur() are asynchronous, except when they are no-op. +// So expect focus to be synchronous when the element is already active, +// and blur to be synchronous when the element is not already active. +// (focus and blur are always synchronous in other supported browsers, +// this just defines when we can count on it). +function expectSync( elem, type ) { + return ( elem === safeActiveElement() ) === ( type === "focus" ); +} + +// Support: IE <=9 only +// Accessing document.activeElement can throw unexpectedly +// https://bugs.jquery.com/ticket/13393 +function safeActiveElement() { + try { + return document.activeElement; + } catch ( err ) { } +} + +function on( elem, types, selector, data, fn, one ) { + var origFn, type; + + // Types can be a map of types/handlers + if ( typeof types === "object" ) { + + // ( types-Object, selector, data ) + if ( typeof selector !== "string" ) { + + // ( types-Object, data ) + data = data || selector; + selector = undefined; + } + for ( type in types ) { + on( elem, type, selector, data, types[ type ], one ); + } + return elem; + } + + if ( data == null && fn == null ) { + + // ( types, fn ) + fn = selector; + data = selector = undefined; + } else if ( fn == null ) { + if ( typeof selector === "string" ) { + + // ( types, selector, fn ) + fn = data; + data = undefined; + } else { + + // ( types, data, fn ) + fn = data; + data = selector; + selector = undefined; + } + } + if ( fn === false ) { + fn = returnFalse; + } else if ( !fn ) { + return elem; + } + + if ( one === 1 ) { + origFn = fn; + fn = function( event ) { + + // Can use an empty set, since event contains the info + jQuery().off( event ); + return origFn.apply( this, arguments ); + }; + + // Use same guid so caller can remove using origFn + fn.guid = origFn.guid || ( origFn.guid = jQuery.guid++ ); + } + return elem.each( function() { + jQuery.event.add( this, types, fn, data, selector ); + } ); +} + +/* + * Helper functions for managing events -- not part of the public interface. + * Props to Dean Edwards' addEvent library for many of the ideas. + */ +jQuery.event = { + + global: {}, + + add: function( elem, types, handler, data, selector ) { + + var handleObjIn, eventHandle, tmp, + events, t, handleObj, + special, handlers, type, namespaces, origType, + elemData = dataPriv.get( elem ); + + // Only attach events to objects that accept data + if ( !acceptData( elem ) ) { + return; + } + + // Caller can pass in an object of custom data in lieu of the handler + if ( handler.handler ) { + handleObjIn = handler; + handler = handleObjIn.handler; + selector = handleObjIn.selector; + } + + // Ensure that invalid selectors throw exceptions at attach time + // Evaluate against documentElement in case elem is a non-element node (e.g., document) + if ( selector ) { + jQuery.find.matchesSelector( documentElement, selector ); + } + + // Make sure that the handler has a unique ID, used to find/remove it later + if ( !handler.guid ) { + handler.guid = jQuery.guid++; + } + + // Init the element's event structure and main handler, if this is the first + if ( !( events = elemData.events ) ) { + events = elemData.events = Object.create( null ); + } + if ( !( eventHandle = elemData.handle ) ) { + eventHandle = elemData.handle = function( e ) { + + // Discard the second event of a jQuery.event.trigger() and + // when an event is called after a page has unloaded + return typeof jQuery !== "undefined" && jQuery.event.triggered !== e.type ? + jQuery.event.dispatch.apply( elem, arguments ) : undefined; + }; + } + + // Handle multiple events separated by a space + types = ( types || "" ).match( rnothtmlwhite ) || [ "" ]; + t = types.length; + while ( t-- ) { + tmp = rtypenamespace.exec( types[ t ] ) || []; + type = origType = tmp[ 1 ]; + namespaces = ( tmp[ 2 ] || "" ).split( "." ).sort(); + + // There *must* be a type, no attaching namespace-only handlers + if ( !type ) { + continue; + } + + // If event changes its type, use the special event handlers for the changed type + special = jQuery.event.special[ type ] || {}; + + // If selector defined, determine special event api type, otherwise given type + type = ( selector ? special.delegateType : special.bindType ) || type; + + // Update special based on newly reset type + special = jQuery.event.special[ type ] || {}; + + // handleObj is passed to all event handlers + handleObj = jQuery.extend( { + type: type, + origType: origType, + data: data, + handler: handler, + guid: handler.guid, + selector: selector, + needsContext: selector && jQuery.expr.match.needsContext.test( selector ), + namespace: namespaces.join( "." ) + }, handleObjIn ); + + // Init the event handler queue if we're the first + if ( !( handlers = events[ type ] ) ) { + handlers = events[ type ] = []; + handlers.delegateCount = 0; + + // Only use addEventListener if the special events handler returns false + if ( !special.setup || + special.setup.call( elem, data, namespaces, eventHandle ) === false ) { + + if ( elem.addEventListener ) { + elem.addEventListener( type, eventHandle ); + } + } + } + + if ( special.add ) { + special.add.call( elem, handleObj ); + + if ( !handleObj.handler.guid ) { + handleObj.handler.guid = handler.guid; + } + } + + // Add to the element's handler list, delegates in front + if ( selector ) { + handlers.splice( handlers.delegateCount++, 0, handleObj ); + } else { + handlers.push( handleObj ); + } + + // Keep track of which events have ever been used, for event optimization + jQuery.event.global[ type ] = true; + } + + }, + + // Detach an event or set of events from an element + remove: function( elem, types, handler, selector, mappedTypes ) { + + var j, origCount, tmp, + events, t, handleObj, + special, handlers, type, namespaces, origType, + elemData = dataPriv.hasData( elem ) && dataPriv.get( elem ); + + if ( !elemData || !( events = elemData.events ) ) { + return; + } + + // Once for each type.namespace in types; type may be omitted + types = ( types || "" ).match( rnothtmlwhite ) || [ "" ]; + t = types.length; + while ( t-- ) { + tmp = rtypenamespace.exec( types[ t ] ) || []; + type = origType = tmp[ 1 ]; + namespaces = ( tmp[ 2 ] || "" ).split( "." ).sort(); + + // Unbind all events (on this namespace, if provided) for the element + if ( !type ) { + for ( type in events ) { + jQuery.event.remove( elem, type + types[ t ], handler, selector, true ); + } + continue; + } + + special = jQuery.event.special[ type ] || {}; + type = ( selector ? special.delegateType : special.bindType ) || type; + handlers = events[ type ] || []; + tmp = tmp[ 2 ] && + new RegExp( "(^|\\.)" + namespaces.join( "\\.(?:.*\\.|)" ) + "(\\.|$)" ); + + // Remove matching events + origCount = j = handlers.length; + while ( j-- ) { + handleObj = handlers[ j ]; + + if ( ( mappedTypes || origType === handleObj.origType ) && + ( !handler || handler.guid === handleObj.guid ) && + ( !tmp || tmp.test( handleObj.namespace ) ) && + ( !selector || selector === handleObj.selector || + selector === "**" && handleObj.selector ) ) { + handlers.splice( j, 1 ); + + if ( handleObj.selector ) { + handlers.delegateCount--; + } + if ( special.remove ) { + special.remove.call( elem, handleObj ); + } + } + } + + // Remove generic event handler if we removed something and no more handlers exist + // (avoids potential for endless recursion during removal of special event handlers) + if ( origCount && !handlers.length ) { + if ( !special.teardown || + special.teardown.call( elem, namespaces, elemData.handle ) === false ) { + + jQuery.removeEvent( elem, type, elemData.handle ); + } + + delete events[ type ]; + } + } + + // Remove data and the expando if it's no longer used + if ( jQuery.isEmptyObject( events ) ) { + dataPriv.remove( elem, "handle events" ); + } + }, + + dispatch: function( nativeEvent ) { + + var i, j, ret, matched, handleObj, handlerQueue, + args = new Array( arguments.length ), + + // Make a writable jQuery.Event from the native event object + event = jQuery.event.fix( nativeEvent ), + + handlers = ( + dataPriv.get( this, "events" ) || Object.create( null ) + )[ event.type ] || [], + special = jQuery.event.special[ event.type ] || {}; + + // Use the fix-ed jQuery.Event rather than the (read-only) native event + args[ 0 ] = event; + + for ( i = 1; i < arguments.length; i++ ) { + args[ i ] = arguments[ i ]; + } + + event.delegateTarget = this; + + // Call the preDispatch hook for the mapped type, and let it bail if desired + if ( special.preDispatch && special.preDispatch.call( this, event ) === false ) { + return; + } + + // Determine handlers + handlerQueue = jQuery.event.handlers.call( this, event, handlers ); + + // Run delegates first; they may want to stop propagation beneath us + i = 0; + while ( ( matched = handlerQueue[ i++ ] ) && !event.isPropagationStopped() ) { + event.currentTarget = matched.elem; + + j = 0; + while ( ( handleObj = matched.handlers[ j++ ] ) && + !event.isImmediatePropagationStopped() ) { + + // If the event is namespaced, then each handler is only invoked if it is + // specially universal or its namespaces are a superset of the event's. + if ( !event.rnamespace || handleObj.namespace === false || + event.rnamespace.test( handleObj.namespace ) ) { + + event.handleObj = handleObj; + event.data = handleObj.data; + + ret = ( ( jQuery.event.special[ handleObj.origType ] || {} ).handle || + handleObj.handler ).apply( matched.elem, args ); + + if ( ret !== undefined ) { + if ( ( event.result = ret ) === false ) { + event.preventDefault(); + event.stopPropagation(); + } + } + } + } + } + + // Call the postDispatch hook for the mapped type + if ( special.postDispatch ) { + special.postDispatch.call( this, event ); + } + + return event.result; + }, + + handlers: function( event, handlers ) { + var i, handleObj, sel, matchedHandlers, matchedSelectors, + handlerQueue = [], + delegateCount = handlers.delegateCount, + cur = event.target; + + // Find delegate handlers + if ( delegateCount && + + // Support: IE <=9 + // Black-hole SVG instance trees (trac-13180) + cur.nodeType && + + // Support: Firefox <=42 + // Suppress spec-violating clicks indicating a non-primary pointer button (trac-3861) + // https://www.w3.org/TR/DOM-Level-3-Events/#event-type-click + // Support: IE 11 only + // ...but not arrow key "clicks" of radio inputs, which can have `button` -1 (gh-2343) + !( event.type === "click" && event.button >= 1 ) ) { + + for ( ; cur !== this; cur = cur.parentNode || this ) { + + // Don't check non-elements (#13208) + // Don't process clicks on disabled elements (#6911, #8165, #11382, #11764) + if ( cur.nodeType === 1 && !( event.type === "click" && cur.disabled === true ) ) { + matchedHandlers = []; + matchedSelectors = {}; + for ( i = 0; i < delegateCount; i++ ) { + handleObj = handlers[ i ]; + + // Don't conflict with Object.prototype properties (#13203) + sel = handleObj.selector + " "; + + if ( matchedSelectors[ sel ] === undefined ) { + matchedSelectors[ sel ] = handleObj.needsContext ? + jQuery( sel, this ).index( cur ) > -1 : + jQuery.find( sel, this, null, [ cur ] ).length; + } + if ( matchedSelectors[ sel ] ) { + matchedHandlers.push( handleObj ); + } + } + if ( matchedHandlers.length ) { + handlerQueue.push( { elem: cur, handlers: matchedHandlers } ); + } + } + } + } + + // Add the remaining (directly-bound) handlers + cur = this; + if ( delegateCount < handlers.length ) { + handlerQueue.push( { elem: cur, handlers: handlers.slice( delegateCount ) } ); + } + + return handlerQueue; + }, + + addProp: function( name, hook ) { + Object.defineProperty( jQuery.Event.prototype, name, { + enumerable: true, + configurable: true, + + get: isFunction( hook ) ? + function() { + if ( this.originalEvent ) { + return hook( this.originalEvent ); + } + } : + function() { + if ( this.originalEvent ) { + return this.originalEvent[ name ]; + } + }, + + set: function( value ) { + Object.defineProperty( this, name, { + enumerable: true, + configurable: true, + writable: true, + value: value + } ); + } + } ); + }, + + fix: function( originalEvent ) { + return originalEvent[ jQuery.expando ] ? + originalEvent : + new jQuery.Event( originalEvent ); + }, + + special: { + load: { + + // Prevent triggered image.load events from bubbling to window.load + noBubble: true + }, + click: { + + // Utilize native event to ensure correct state for checkable inputs + setup: function( data ) { + + // For mutual compressibility with _default, replace `this` access with a local var. + // `|| data` is dead code meant only to preserve the variable through minification. + var el = this || data; + + // Claim the first handler + if ( rcheckableType.test( el.type ) && + el.click && nodeName( el, "input" ) ) { + + // dataPriv.set( el, "click", ... ) + leverageNative( el, "click", returnTrue ); + } + + // Return false to allow normal processing in the caller + return false; + }, + trigger: function( data ) { + + // For mutual compressibility with _default, replace `this` access with a local var. + // `|| data` is dead code meant only to preserve the variable through minification. + var el = this || data; + + // Force setup before triggering a click + if ( rcheckableType.test( el.type ) && + el.click && nodeName( el, "input" ) ) { + + leverageNative( el, "click" ); + } + + // Return non-false to allow normal event-path propagation + return true; + }, + + // For cross-browser consistency, suppress native .click() on links + // Also prevent it if we're currently inside a leveraged native-event stack + _default: function( event ) { + var target = event.target; + return rcheckableType.test( target.type ) && + target.click && nodeName( target, "input" ) && + dataPriv.get( target, "click" ) || + nodeName( target, "a" ); + } + }, + + beforeunload: { + postDispatch: function( event ) { + + // Support: Firefox 20+ + // Firefox doesn't alert if the returnValue field is not set. + if ( event.result !== undefined && event.originalEvent ) { + event.originalEvent.returnValue = event.result; + } + } + } + } +}; + +// Ensure the presence of an event listener that handles manually-triggered +// synthetic events by interrupting progress until reinvoked in response to +// *native* events that it fires directly, ensuring that state changes have +// already occurred before other listeners are invoked. +function leverageNative( el, type, expectSync ) { + + // Missing expectSync indicates a trigger call, which must force setup through jQuery.event.add + if ( !expectSync ) { + if ( dataPriv.get( el, type ) === undefined ) { + jQuery.event.add( el, type, returnTrue ); + } + return; + } + + // Register the controller as a special universal handler for all event namespaces + dataPriv.set( el, type, false ); + jQuery.event.add( el, type, { + namespace: false, + handler: function( event ) { + var notAsync, result, + saved = dataPriv.get( this, type ); + + if ( ( event.isTrigger & 1 ) && this[ type ] ) { + + // Interrupt processing of the outer synthetic .trigger()ed event + // Saved data should be false in such cases, but might be a leftover capture object + // from an async native handler (gh-4350) + if ( !saved.length ) { + + // Store arguments for use when handling the inner native event + // There will always be at least one argument (an event object), so this array + // will not be confused with a leftover capture object. + saved = slice.call( arguments ); + dataPriv.set( this, type, saved ); + + // Trigger the native event and capture its result + // Support: IE <=9 - 11+ + // focus() and blur() are asynchronous + notAsync = expectSync( this, type ); + this[ type ](); + result = dataPriv.get( this, type ); + if ( saved !== result || notAsync ) { + dataPriv.set( this, type, false ); + } else { + result = {}; + } + if ( saved !== result ) { + + // Cancel the outer synthetic event + event.stopImmediatePropagation(); + event.preventDefault(); + + // Support: Chrome 86+ + // In Chrome, if an element having a focusout handler is blurred by + // clicking outside of it, it invokes the handler synchronously. If + // that handler calls `.remove()` on the element, the data is cleared, + // leaving `result` undefined. We need to guard against this. + return result && result.value; + } + + // If this is an inner synthetic event for an event with a bubbling surrogate + // (focus or blur), assume that the surrogate already propagated from triggering the + // native event and prevent that from happening again here. + // This technically gets the ordering wrong w.r.t. to `.trigger()` (in which the + // bubbling surrogate propagates *after* the non-bubbling base), but that seems + // less bad than duplication. + } else if ( ( jQuery.event.special[ type ] || {} ).delegateType ) { + event.stopPropagation(); + } + + // If this is a native event triggered above, everything is now in order + // Fire an inner synthetic event with the original arguments + } else if ( saved.length ) { + + // ...and capture the result + dataPriv.set( this, type, { + value: jQuery.event.trigger( + + // Support: IE <=9 - 11+ + // Extend with the prototype to reset the above stopImmediatePropagation() + jQuery.extend( saved[ 0 ], jQuery.Event.prototype ), + saved.slice( 1 ), + this + ) + } ); + + // Abort handling of the native event + event.stopImmediatePropagation(); + } + } + } ); +} + +jQuery.removeEvent = function( elem, type, handle ) { + + // This "if" is needed for plain objects + if ( elem.removeEventListener ) { + elem.removeEventListener( type, handle ); + } +}; + +jQuery.Event = function( src, props ) { + + // Allow instantiation without the 'new' keyword + if ( !( this instanceof jQuery.Event ) ) { + return new jQuery.Event( src, props ); + } + + // Event object + if ( src && src.type ) { + this.originalEvent = src; + this.type = src.type; + + // Events bubbling up the document may have been marked as prevented + // by a handler lower down the tree; reflect the correct value. + this.isDefaultPrevented = src.defaultPrevented || + src.defaultPrevented === undefined && + + // Support: Android <=2.3 only + src.returnValue === false ? + returnTrue : + returnFalse; + + // Create target properties + // Support: Safari <=6 - 7 only + // Target should not be a text node (#504, #13143) + this.target = ( src.target && src.target.nodeType === 3 ) ? + src.target.parentNode : + src.target; + + this.currentTarget = src.currentTarget; + this.relatedTarget = src.relatedTarget; + + // Event type + } else { + this.type = src; + } + + // Put explicitly provided properties onto the event object + if ( props ) { + jQuery.extend( this, props ); + } + + // Create a timestamp if incoming event doesn't have one + this.timeStamp = src && src.timeStamp || Date.now(); + + // Mark it as fixed + this[ jQuery.expando ] = true; +}; + +// jQuery.Event is based on DOM3 Events as specified by the ECMAScript Language Binding +// https://www.w3.org/TR/2003/WD-DOM-Level-3-Events-20030331/ecma-script-binding.html +jQuery.Event.prototype = { + constructor: jQuery.Event, + isDefaultPrevented: returnFalse, + isPropagationStopped: returnFalse, + isImmediatePropagationStopped: returnFalse, + isSimulated: false, + + preventDefault: function() { + var e = this.originalEvent; + + this.isDefaultPrevented = returnTrue; + + if ( e && !this.isSimulated ) { + e.preventDefault(); + } + }, + stopPropagation: function() { + var e = this.originalEvent; + + this.isPropagationStopped = returnTrue; + + if ( e && !this.isSimulated ) { + e.stopPropagation(); + } + }, + stopImmediatePropagation: function() { + var e = this.originalEvent; + + this.isImmediatePropagationStopped = returnTrue; + + if ( e && !this.isSimulated ) { + e.stopImmediatePropagation(); + } + + this.stopPropagation(); + } +}; + +// Includes all common event props including KeyEvent and MouseEvent specific props +jQuery.each( { + altKey: true, + bubbles: true, + cancelable: true, + changedTouches: true, + ctrlKey: true, + detail: true, + eventPhase: true, + metaKey: true, + pageX: true, + pageY: true, + shiftKey: true, + view: true, + "char": true, + code: true, + charCode: true, + key: true, + keyCode: true, + button: true, + buttons: true, + clientX: true, + clientY: true, + offsetX: true, + offsetY: true, + pointerId: true, + pointerType: true, + screenX: true, + screenY: true, + targetTouches: true, + toElement: true, + touches: true, + which: true +}, jQuery.event.addProp ); + +jQuery.each( { focus: "focusin", blur: "focusout" }, function( type, delegateType ) { + jQuery.event.special[ type ] = { + + // Utilize native event if possible so blur/focus sequence is correct + setup: function() { + + // Claim the first handler + // dataPriv.set( this, "focus", ... ) + // dataPriv.set( this, "blur", ... ) + leverageNative( this, type, expectSync ); + + // Return false to allow normal processing in the caller + return false; + }, + trigger: function() { + + // Force setup before trigger + leverageNative( this, type ); + + // Return non-false to allow normal event-path propagation + return true; + }, + + // Suppress native focus or blur as it's already being fired + // in leverageNative. + _default: function() { + return true; + }, + + delegateType: delegateType + }; +} ); + +// Create mouseenter/leave events using mouseover/out and event-time checks +// so that event delegation works in jQuery. +// Do the same for pointerenter/pointerleave and pointerover/pointerout +// +// Support: Safari 7 only +// Safari sends mouseenter too often; see: +// https://bugs.chromium.org/p/chromium/issues/detail?id=470258 +// for the description of the bug (it existed in older Chrome versions as well). +jQuery.each( { + mouseenter: "mouseover", + mouseleave: "mouseout", + pointerenter: "pointerover", + pointerleave: "pointerout" +}, function( orig, fix ) { + jQuery.event.special[ orig ] = { + delegateType: fix, + bindType: fix, + + handle: function( event ) { + var ret, + target = this, + related = event.relatedTarget, + handleObj = event.handleObj; + + // For mouseenter/leave call the handler if related is outside the target. + // NB: No relatedTarget if the mouse left/entered the browser window + if ( !related || ( related !== target && !jQuery.contains( target, related ) ) ) { + event.type = handleObj.origType; + ret = handleObj.handler.apply( this, arguments ); + event.type = fix; + } + return ret; + } + }; +} ); + +jQuery.fn.extend( { + + on: function( types, selector, data, fn ) { + return on( this, types, selector, data, fn ); + }, + one: function( types, selector, data, fn ) { + return on( this, types, selector, data, fn, 1 ); + }, + off: function( types, selector, fn ) { + var handleObj, type; + if ( types && types.preventDefault && types.handleObj ) { + + // ( event ) dispatched jQuery.Event + handleObj = types.handleObj; + jQuery( types.delegateTarget ).off( + handleObj.namespace ? + handleObj.origType + "." + handleObj.namespace : + handleObj.origType, + handleObj.selector, + handleObj.handler + ); + return this; + } + if ( typeof types === "object" ) { + + // ( types-object [, selector] ) + for ( type in types ) { + this.off( type, selector, types[ type ] ); + } + return this; + } + if ( selector === false || typeof selector === "function" ) { + + // ( types [, fn] ) + fn = selector; + selector = undefined; + } + if ( fn === false ) { + fn = returnFalse; + } + return this.each( function() { + jQuery.event.remove( this, types, fn, selector ); + } ); + } +} ); + + +var + + // Support: IE <=10 - 11, Edge 12 - 13 only + // In IE/Edge using regex groups here causes severe slowdowns. + // See https://connect.microsoft.com/IE/feedback/details/1736512/ + rnoInnerhtml = /\s*$/g; + +// Prefer a tbody over its parent table for containing new rows +function manipulationTarget( elem, content ) { + if ( nodeName( elem, "table" ) && + nodeName( content.nodeType !== 11 ? content : content.firstChild, "tr" ) ) { + + return jQuery( elem ).children( "tbody" )[ 0 ] || elem; + } + + return elem; +} + +// Replace/restore the type attribute of script elements for safe DOM manipulation +function disableScript( elem ) { + elem.type = ( elem.getAttribute( "type" ) !== null ) + "/" + elem.type; + return elem; +} +function restoreScript( elem ) { + if ( ( elem.type || "" ).slice( 0, 5 ) === "true/" ) { + elem.type = elem.type.slice( 5 ); + } else { + elem.removeAttribute( "type" ); + } + + return elem; +} + +function cloneCopyEvent( src, dest ) { + var i, l, type, pdataOld, udataOld, udataCur, events; + + if ( dest.nodeType !== 1 ) { + return; + } + + // 1. Copy private data: events, handlers, etc. + if ( dataPriv.hasData( src ) ) { + pdataOld = dataPriv.get( src ); + events = pdataOld.events; + + if ( events ) { + dataPriv.remove( dest, "handle events" ); + + for ( type in events ) { + for ( i = 0, l = events[ type ].length; i < l; i++ ) { + jQuery.event.add( dest, type, events[ type ][ i ] ); + } + } + } + } + + // 2. Copy user data + if ( dataUser.hasData( src ) ) { + udataOld = dataUser.access( src ); + udataCur = jQuery.extend( {}, udataOld ); + + dataUser.set( dest, udataCur ); + } +} + +// Fix IE bugs, see support tests +function fixInput( src, dest ) { + var nodeName = dest.nodeName.toLowerCase(); + + // Fails to persist the checked state of a cloned checkbox or radio button. + if ( nodeName === "input" && rcheckableType.test( src.type ) ) { + dest.checked = src.checked; + + // Fails to return the selected option to the default selected state when cloning options + } else if ( nodeName === "input" || nodeName === "textarea" ) { + dest.defaultValue = src.defaultValue; + } +} + +function domManip( collection, args, callback, ignored ) { + + // Flatten any nested arrays + args = flat( args ); + + var fragment, first, scripts, hasScripts, node, doc, + i = 0, + l = collection.length, + iNoClone = l - 1, + value = args[ 0 ], + valueIsFunction = isFunction( value ); + + // We can't cloneNode fragments that contain checked, in WebKit + if ( valueIsFunction || + ( l > 1 && typeof value === "string" && + !support.checkClone && rchecked.test( value ) ) ) { + return collection.each( function( index ) { + var self = collection.eq( index ); + if ( valueIsFunction ) { + args[ 0 ] = value.call( this, index, self.html() ); + } + domManip( self, args, callback, ignored ); + } ); + } + + if ( l ) { + fragment = buildFragment( args, collection[ 0 ].ownerDocument, false, collection, ignored ); + first = fragment.firstChild; + + if ( fragment.childNodes.length === 1 ) { + fragment = first; + } + + // Require either new content or an interest in ignored elements to invoke the callback + if ( first || ignored ) { + scripts = jQuery.map( getAll( fragment, "script" ), disableScript ); + hasScripts = scripts.length; + + // Use the original fragment for the last item + // instead of the first because it can end up + // being emptied incorrectly in certain situations (#8070). + for ( ; i < l; i++ ) { + node = fragment; + + if ( i !== iNoClone ) { + node = jQuery.clone( node, true, true ); + + // Keep references to cloned scripts for later restoration + if ( hasScripts ) { + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + jQuery.merge( scripts, getAll( node, "script" ) ); + } + } + + callback.call( collection[ i ], node, i ); + } + + if ( hasScripts ) { + doc = scripts[ scripts.length - 1 ].ownerDocument; + + // Reenable scripts + jQuery.map( scripts, restoreScript ); + + // Evaluate executable scripts on first document insertion + for ( i = 0; i < hasScripts; i++ ) { + node = scripts[ i ]; + if ( rscriptType.test( node.type || "" ) && + !dataPriv.access( node, "globalEval" ) && + jQuery.contains( doc, node ) ) { + + if ( node.src && ( node.type || "" ).toLowerCase() !== "module" ) { + + // Optional AJAX dependency, but won't run scripts if not present + if ( jQuery._evalUrl && !node.noModule ) { + jQuery._evalUrl( node.src, { + nonce: node.nonce || node.getAttribute( "nonce" ) + }, doc ); + } + } else { + DOMEval( node.textContent.replace( rcleanScript, "" ), node, doc ); + } + } + } + } + } + } + + return collection; +} + +function remove( elem, selector, keepData ) { + var node, + nodes = selector ? jQuery.filter( selector, elem ) : elem, + i = 0; + + for ( ; ( node = nodes[ i ] ) != null; i++ ) { + if ( !keepData && node.nodeType === 1 ) { + jQuery.cleanData( getAll( node ) ); + } + + if ( node.parentNode ) { + if ( keepData && isAttached( node ) ) { + setGlobalEval( getAll( node, "script" ) ); + } + node.parentNode.removeChild( node ); + } + } + + return elem; +} + +jQuery.extend( { + htmlPrefilter: function( html ) { + return html; + }, + + clone: function( elem, dataAndEvents, deepDataAndEvents ) { + var i, l, srcElements, destElements, + clone = elem.cloneNode( true ), + inPage = isAttached( elem ); + + // Fix IE cloning issues + if ( !support.noCloneChecked && ( elem.nodeType === 1 || elem.nodeType === 11 ) && + !jQuery.isXMLDoc( elem ) ) { + + // We eschew Sizzle here for performance reasons: https://jsperf.com/getall-vs-sizzle/2 + destElements = getAll( clone ); + srcElements = getAll( elem ); + + for ( i = 0, l = srcElements.length; i < l; i++ ) { + fixInput( srcElements[ i ], destElements[ i ] ); + } + } + + // Copy the events from the original to the clone + if ( dataAndEvents ) { + if ( deepDataAndEvents ) { + srcElements = srcElements || getAll( elem ); + destElements = destElements || getAll( clone ); + + for ( i = 0, l = srcElements.length; i < l; i++ ) { + cloneCopyEvent( srcElements[ i ], destElements[ i ] ); + } + } else { + cloneCopyEvent( elem, clone ); + } + } + + // Preserve script evaluation history + destElements = getAll( clone, "script" ); + if ( destElements.length > 0 ) { + setGlobalEval( destElements, !inPage && getAll( elem, "script" ) ); + } + + // Return the cloned set + return clone; + }, + + cleanData: function( elems ) { + var data, elem, type, + special = jQuery.event.special, + i = 0; + + for ( ; ( elem = elems[ i ] ) !== undefined; i++ ) { + if ( acceptData( elem ) ) { + if ( ( data = elem[ dataPriv.expando ] ) ) { + if ( data.events ) { + for ( type in data.events ) { + if ( special[ type ] ) { + jQuery.event.remove( elem, type ); + + // This is a shortcut to avoid jQuery.event.remove's overhead + } else { + jQuery.removeEvent( elem, type, data.handle ); + } + } + } + + // Support: Chrome <=35 - 45+ + // Assign undefined instead of using delete, see Data#remove + elem[ dataPriv.expando ] = undefined; + } + if ( elem[ dataUser.expando ] ) { + + // Support: Chrome <=35 - 45+ + // Assign undefined instead of using delete, see Data#remove + elem[ dataUser.expando ] = undefined; + } + } + } + } +} ); + +jQuery.fn.extend( { + detach: function( selector ) { + return remove( this, selector, true ); + }, + + remove: function( selector ) { + return remove( this, selector ); + }, + + text: function( value ) { + return access( this, function( value ) { + return value === undefined ? + jQuery.text( this ) : + this.empty().each( function() { + if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { + this.textContent = value; + } + } ); + }, null, value, arguments.length ); + }, + + append: function() { + return domManip( this, arguments, function( elem ) { + if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { + var target = manipulationTarget( this, elem ); + target.appendChild( elem ); + } + } ); + }, + + prepend: function() { + return domManip( this, arguments, function( elem ) { + if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { + var target = manipulationTarget( this, elem ); + target.insertBefore( elem, target.firstChild ); + } + } ); + }, + + before: function() { + return domManip( this, arguments, function( elem ) { + if ( this.parentNode ) { + this.parentNode.insertBefore( elem, this ); + } + } ); + }, + + after: function() { + return domManip( this, arguments, function( elem ) { + if ( this.parentNode ) { + this.parentNode.insertBefore( elem, this.nextSibling ); + } + } ); + }, + + empty: function() { + var elem, + i = 0; + + for ( ; ( elem = this[ i ] ) != null; i++ ) { + if ( elem.nodeType === 1 ) { + + // Prevent memory leaks + jQuery.cleanData( getAll( elem, false ) ); + + // Remove any remaining nodes + elem.textContent = ""; + } + } + + return this; + }, + + clone: function( dataAndEvents, deepDataAndEvents ) { + dataAndEvents = dataAndEvents == null ? false : dataAndEvents; + deepDataAndEvents = deepDataAndEvents == null ? dataAndEvents : deepDataAndEvents; + + return this.map( function() { + return jQuery.clone( this, dataAndEvents, deepDataAndEvents ); + } ); + }, + + html: function( value ) { + return access( this, function( value ) { + var elem = this[ 0 ] || {}, + i = 0, + l = this.length; + + if ( value === undefined && elem.nodeType === 1 ) { + return elem.innerHTML; + } + + // See if we can take a shortcut and just use innerHTML + if ( typeof value === "string" && !rnoInnerhtml.test( value ) && + !wrapMap[ ( rtagName.exec( value ) || [ "", "" ] )[ 1 ].toLowerCase() ] ) { + + value = jQuery.htmlPrefilter( value ); + + try { + for ( ; i < l; i++ ) { + elem = this[ i ] || {}; + + // Remove element nodes and prevent memory leaks + if ( elem.nodeType === 1 ) { + jQuery.cleanData( getAll( elem, false ) ); + elem.innerHTML = value; + } + } + + elem = 0; + + // If using innerHTML throws an exception, use the fallback method + } catch ( e ) {} + } + + if ( elem ) { + this.empty().append( value ); + } + }, null, value, arguments.length ); + }, + + replaceWith: function() { + var ignored = []; + + // Make the changes, replacing each non-ignored context element with the new content + return domManip( this, arguments, function( elem ) { + var parent = this.parentNode; + + if ( jQuery.inArray( this, ignored ) < 0 ) { + jQuery.cleanData( getAll( this ) ); + if ( parent ) { + parent.replaceChild( elem, this ); + } + } + + // Force callback invocation + }, ignored ); + } +} ); + +jQuery.each( { + appendTo: "append", + prependTo: "prepend", + insertBefore: "before", + insertAfter: "after", + replaceAll: "replaceWith" +}, function( name, original ) { + jQuery.fn[ name ] = function( selector ) { + var elems, + ret = [], + insert = jQuery( selector ), + last = insert.length - 1, + i = 0; + + for ( ; i <= last; i++ ) { + elems = i === last ? this : this.clone( true ); + jQuery( insert[ i ] )[ original ]( elems ); + + // Support: Android <=4.0 only, PhantomJS 1 only + // .get() because push.apply(_, arraylike) throws on ancient WebKit + push.apply( ret, elems.get() ); + } + + return this.pushStack( ret ); + }; +} ); +var rnumnonpx = new RegExp( "^(" + pnum + ")(?!px)[a-z%]+$", "i" ); + +var getStyles = function( elem ) { + + // Support: IE <=11 only, Firefox <=30 (#15098, #14150) + // IE throws on elements created in popups + // FF meanwhile throws on frame elements through "defaultView.getComputedStyle" + var view = elem.ownerDocument.defaultView; + + if ( !view || !view.opener ) { + view = window; + } + + return view.getComputedStyle( elem ); + }; + +var swap = function( elem, options, callback ) { + var ret, name, + old = {}; + + // Remember the old values, and insert the new ones + for ( name in options ) { + old[ name ] = elem.style[ name ]; + elem.style[ name ] = options[ name ]; + } + + ret = callback.call( elem ); + + // Revert the old values + for ( name in options ) { + elem.style[ name ] = old[ name ]; + } + + return ret; +}; + + +var rboxStyle = new RegExp( cssExpand.join( "|" ), "i" ); + + + +( function() { + + // Executing both pixelPosition & boxSizingReliable tests require only one layout + // so they're executed at the same time to save the second computation. + function computeStyleTests() { + + // This is a singleton, we need to execute it only once + if ( !div ) { + return; + } + + container.style.cssText = "position:absolute;left:-11111px;width:60px;" + + "margin-top:1px;padding:0;border:0"; + div.style.cssText = + "position:relative;display:block;box-sizing:border-box;overflow:scroll;" + + "margin:auto;border:1px;padding:1px;" + + "width:60%;top:1%"; + documentElement.appendChild( container ).appendChild( div ); + + var divStyle = window.getComputedStyle( div ); + pixelPositionVal = divStyle.top !== "1%"; + + // Support: Android 4.0 - 4.3 only, Firefox <=3 - 44 + reliableMarginLeftVal = roundPixelMeasures( divStyle.marginLeft ) === 12; + + // Support: Android 4.0 - 4.3 only, Safari <=9.1 - 10.1, iOS <=7.0 - 9.3 + // Some styles come back with percentage values, even though they shouldn't + div.style.right = "60%"; + pixelBoxStylesVal = roundPixelMeasures( divStyle.right ) === 36; + + // Support: IE 9 - 11 only + // Detect misreporting of content dimensions for box-sizing:border-box elements + boxSizingReliableVal = roundPixelMeasures( divStyle.width ) === 36; + + // Support: IE 9 only + // Detect overflow:scroll screwiness (gh-3699) + // Support: Chrome <=64 + // Don't get tricked when zoom affects offsetWidth (gh-4029) + div.style.position = "absolute"; + scrollboxSizeVal = roundPixelMeasures( div.offsetWidth / 3 ) === 12; + + documentElement.removeChild( container ); + + // Nullify the div so it wouldn't be stored in the memory and + // it will also be a sign that checks already performed + div = null; + } + + function roundPixelMeasures( measure ) { + return Math.round( parseFloat( measure ) ); + } + + var pixelPositionVal, boxSizingReliableVal, scrollboxSizeVal, pixelBoxStylesVal, + reliableTrDimensionsVal, reliableMarginLeftVal, + container = document.createElement( "div" ), + div = document.createElement( "div" ); + + // Finish early in limited (non-browser) environments + if ( !div.style ) { + return; + } + + // Support: IE <=9 - 11 only + // Style of cloned element affects source element cloned (#8908) + div.style.backgroundClip = "content-box"; + div.cloneNode( true ).style.backgroundClip = ""; + support.clearCloneStyle = div.style.backgroundClip === "content-box"; + + jQuery.extend( support, { + boxSizingReliable: function() { + computeStyleTests(); + return boxSizingReliableVal; + }, + pixelBoxStyles: function() { + computeStyleTests(); + return pixelBoxStylesVal; + }, + pixelPosition: function() { + computeStyleTests(); + return pixelPositionVal; + }, + reliableMarginLeft: function() { + computeStyleTests(); + return reliableMarginLeftVal; + }, + scrollboxSize: function() { + computeStyleTests(); + return scrollboxSizeVal; + }, + + // Support: IE 9 - 11+, Edge 15 - 18+ + // IE/Edge misreport `getComputedStyle` of table rows with width/height + // set in CSS while `offset*` properties report correct values. + // Behavior in IE 9 is more subtle than in newer versions & it passes + // some versions of this test; make sure not to make it pass there! + // + // Support: Firefox 70+ + // Only Firefox includes border widths + // in computed dimensions. (gh-4529) + reliableTrDimensions: function() { + var table, tr, trChild, trStyle; + if ( reliableTrDimensionsVal == null ) { + table = document.createElement( "table" ); + tr = document.createElement( "tr" ); + trChild = document.createElement( "div" ); + + table.style.cssText = "position:absolute;left:-11111px;border-collapse:separate"; + tr.style.cssText = "border:1px solid"; + + // Support: Chrome 86+ + // Height set through cssText does not get applied. + // Computed height then comes back as 0. + tr.style.height = "1px"; + trChild.style.height = "9px"; + + // Support: Android 8 Chrome 86+ + // In our bodyBackground.html iframe, + // display for all div elements is set to "inline", + // which causes a problem only in Android 8 Chrome 86. + // Ensuring the div is display: block + // gets around this issue. + trChild.style.display = "block"; + + documentElement + .appendChild( table ) + .appendChild( tr ) + .appendChild( trChild ); + + trStyle = window.getComputedStyle( tr ); + reliableTrDimensionsVal = ( parseInt( trStyle.height, 10 ) + + parseInt( trStyle.borderTopWidth, 10 ) + + parseInt( trStyle.borderBottomWidth, 10 ) ) === tr.offsetHeight; + + documentElement.removeChild( table ); + } + return reliableTrDimensionsVal; + } + } ); +} )(); + + +function curCSS( elem, name, computed ) { + var width, minWidth, maxWidth, ret, + + // Support: Firefox 51+ + // Retrieving style before computed somehow + // fixes an issue with getting wrong values + // on detached elements + style = elem.style; + + computed = computed || getStyles( elem ); + + // getPropertyValue is needed for: + // .css('filter') (IE 9 only, #12537) + // .css('--customProperty) (#3144) + if ( computed ) { + ret = computed.getPropertyValue( name ) || computed[ name ]; + + if ( ret === "" && !isAttached( elem ) ) { + ret = jQuery.style( elem, name ); + } + + // A tribute to the "awesome hack by Dean Edwards" + // Android Browser returns percentage for some values, + // but width seems to be reliably pixels. + // This is against the CSSOM draft spec: + // https://drafts.csswg.org/cssom/#resolved-values + if ( !support.pixelBoxStyles() && rnumnonpx.test( ret ) && rboxStyle.test( name ) ) { + + // Remember the original values + width = style.width; + minWidth = style.minWidth; + maxWidth = style.maxWidth; + + // Put in the new values to get a computed value out + style.minWidth = style.maxWidth = style.width = ret; + ret = computed.width; + + // Revert the changed values + style.width = width; + style.minWidth = minWidth; + style.maxWidth = maxWidth; + } + } + + return ret !== undefined ? + + // Support: IE <=9 - 11 only + // IE returns zIndex value as an integer. + ret + "" : + ret; +} + + +function addGetHookIf( conditionFn, hookFn ) { + + // Define the hook, we'll check on the first run if it's really needed. + return { + get: function() { + if ( conditionFn() ) { + + // Hook not needed (or it's not possible to use it due + // to missing dependency), remove it. + delete this.get; + return; + } + + // Hook needed; redefine it so that the support test is not executed again. + return ( this.get = hookFn ).apply( this, arguments ); + } + }; +} + + +var cssPrefixes = [ "Webkit", "Moz", "ms" ], + emptyStyle = document.createElement( "div" ).style, + vendorProps = {}; + +// Return a vendor-prefixed property or undefined +function vendorPropName( name ) { + + // Check for vendor prefixed names + var capName = name[ 0 ].toUpperCase() + name.slice( 1 ), + i = cssPrefixes.length; + + while ( i-- ) { + name = cssPrefixes[ i ] + capName; + if ( name in emptyStyle ) { + return name; + } + } +} + +// Return a potentially-mapped jQuery.cssProps or vendor prefixed property +function finalPropName( name ) { + var final = jQuery.cssProps[ name ] || vendorProps[ name ]; + + if ( final ) { + return final; + } + if ( name in emptyStyle ) { + return name; + } + return vendorProps[ name ] = vendorPropName( name ) || name; +} + + +var + + // Swappable if display is none or starts with table + // except "table", "table-cell", or "table-caption" + // See here for display values: https://developer.mozilla.org/en-US/docs/CSS/display + rdisplayswap = /^(none|table(?!-c[ea]).+)/, + rcustomProp = /^--/, + cssShow = { position: "absolute", visibility: "hidden", display: "block" }, + cssNormalTransform = { + letterSpacing: "0", + fontWeight: "400" + }; + +function setPositiveNumber( _elem, value, subtract ) { + + // Any relative (+/-) values have already been + // normalized at this point + var matches = rcssNum.exec( value ); + return matches ? + + // Guard against undefined "subtract", e.g., when used as in cssHooks + Math.max( 0, matches[ 2 ] - ( subtract || 0 ) ) + ( matches[ 3 ] || "px" ) : + value; +} + +function boxModelAdjustment( elem, dimension, box, isBorderBox, styles, computedVal ) { + var i = dimension === "width" ? 1 : 0, + extra = 0, + delta = 0; + + // Adjustment may not be necessary + if ( box === ( isBorderBox ? "border" : "content" ) ) { + return 0; + } + + for ( ; i < 4; i += 2 ) { + + // Both box models exclude margin + if ( box === "margin" ) { + delta += jQuery.css( elem, box + cssExpand[ i ], true, styles ); + } + + // If we get here with a content-box, we're seeking "padding" or "border" or "margin" + if ( !isBorderBox ) { + + // Add padding + delta += jQuery.css( elem, "padding" + cssExpand[ i ], true, styles ); + + // For "border" or "margin", add border + if ( box !== "padding" ) { + delta += jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); + + // But still keep track of it otherwise + } else { + extra += jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); + } + + // If we get here with a border-box (content + padding + border), we're seeking "content" or + // "padding" or "margin" + } else { + + // For "content", subtract padding + if ( box === "content" ) { + delta -= jQuery.css( elem, "padding" + cssExpand[ i ], true, styles ); + } + + // For "content" or "padding", subtract border + if ( box !== "margin" ) { + delta -= jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); + } + } + } + + // Account for positive content-box scroll gutter when requested by providing computedVal + if ( !isBorderBox && computedVal >= 0 ) { + + // offsetWidth/offsetHeight is a rounded sum of content, padding, scroll gutter, and border + // Assuming integer scroll gutter, subtract the rest and round down + delta += Math.max( 0, Math.ceil( + elem[ "offset" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ) ] - + computedVal - + delta - + extra - + 0.5 + + // If offsetWidth/offsetHeight is unknown, then we can't determine content-box scroll gutter + // Use an explicit zero to avoid NaN (gh-3964) + ) ) || 0; + } + + return delta; +} + +function getWidthOrHeight( elem, dimension, extra ) { + + // Start with computed style + var styles = getStyles( elem ), + + // To avoid forcing a reflow, only fetch boxSizing if we need it (gh-4322). + // Fake content-box until we know it's needed to know the true value. + boxSizingNeeded = !support.boxSizingReliable() || extra, + isBorderBox = boxSizingNeeded && + jQuery.css( elem, "boxSizing", false, styles ) === "border-box", + valueIsBorderBox = isBorderBox, + + val = curCSS( elem, dimension, styles ), + offsetProp = "offset" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ); + + // Support: Firefox <=54 + // Return a confounding non-pixel value or feign ignorance, as appropriate. + if ( rnumnonpx.test( val ) ) { + if ( !extra ) { + return val; + } + val = "auto"; + } + + + // Support: IE 9 - 11 only + // Use offsetWidth/offsetHeight for when box sizing is unreliable. + // In those cases, the computed value can be trusted to be border-box. + if ( ( !support.boxSizingReliable() && isBorderBox || + + // Support: IE 10 - 11+, Edge 15 - 18+ + // IE/Edge misreport `getComputedStyle` of table rows with width/height + // set in CSS while `offset*` properties report correct values. + // Interestingly, in some cases IE 9 doesn't suffer from this issue. + !support.reliableTrDimensions() && nodeName( elem, "tr" ) || + + // Fall back to offsetWidth/offsetHeight when value is "auto" + // This happens for inline elements with no explicit setting (gh-3571) + val === "auto" || + + // Support: Android <=4.1 - 4.3 only + // Also use offsetWidth/offsetHeight for misreported inline dimensions (gh-3602) + !parseFloat( val ) && jQuery.css( elem, "display", false, styles ) === "inline" ) && + + // Make sure the element is visible & connected + elem.getClientRects().length ) { + + isBorderBox = jQuery.css( elem, "boxSizing", false, styles ) === "border-box"; + + // Where available, offsetWidth/offsetHeight approximate border box dimensions. + // Where not available (e.g., SVG), assume unreliable box-sizing and interpret the + // retrieved value as a content box dimension. + valueIsBorderBox = offsetProp in elem; + if ( valueIsBorderBox ) { + val = elem[ offsetProp ]; + } + } + + // Normalize "" and auto + val = parseFloat( val ) || 0; + + // Adjust for the element's box model + return ( val + + boxModelAdjustment( + elem, + dimension, + extra || ( isBorderBox ? "border" : "content" ), + valueIsBorderBox, + styles, + + // Provide the current computed size to request scroll gutter calculation (gh-3589) + val + ) + ) + "px"; +} + +jQuery.extend( { + + // Add in style property hooks for overriding the default + // behavior of getting and setting a style property + cssHooks: { + opacity: { + get: function( elem, computed ) { + if ( computed ) { + + // We should always get a number back from opacity + var ret = curCSS( elem, "opacity" ); + return ret === "" ? "1" : ret; + } + } + } + }, + + // Don't automatically add "px" to these possibly-unitless properties + cssNumber: { + "animationIterationCount": true, + "columnCount": true, + "fillOpacity": true, + "flexGrow": true, + "flexShrink": true, + "fontWeight": true, + "gridArea": true, + "gridColumn": true, + "gridColumnEnd": true, + "gridColumnStart": true, + "gridRow": true, + "gridRowEnd": true, + "gridRowStart": true, + "lineHeight": true, + "opacity": true, + "order": true, + "orphans": true, + "widows": true, + "zIndex": true, + "zoom": true + }, + + // Add in properties whose names you wish to fix before + // setting or getting the value + cssProps: {}, + + // Get and set the style property on a DOM Node + style: function( elem, name, value, extra ) { + + // Don't set styles on text and comment nodes + if ( !elem || elem.nodeType === 3 || elem.nodeType === 8 || !elem.style ) { + return; + } + + // Make sure that we're working with the right name + var ret, type, hooks, + origName = camelCase( name ), + isCustomProp = rcustomProp.test( name ), + style = elem.style; + + // Make sure that we're working with the right name. We don't + // want to query the value if it is a CSS custom property + // since they are user-defined. + if ( !isCustomProp ) { + name = finalPropName( origName ); + } + + // Gets hook for the prefixed version, then unprefixed version + hooks = jQuery.cssHooks[ name ] || jQuery.cssHooks[ origName ]; + + // Check if we're setting a value + if ( value !== undefined ) { + type = typeof value; + + // Convert "+=" or "-=" to relative numbers (#7345) + if ( type === "string" && ( ret = rcssNum.exec( value ) ) && ret[ 1 ] ) { + value = adjustCSS( elem, name, ret ); + + // Fixes bug #9237 + type = "number"; + } + + // Make sure that null and NaN values aren't set (#7116) + if ( value == null || value !== value ) { + return; + } + + // If a number was passed in, add the unit (except for certain CSS properties) + // The isCustomProp check can be removed in jQuery 4.0 when we only auto-append + // "px" to a few hardcoded values. + if ( type === "number" && !isCustomProp ) { + value += ret && ret[ 3 ] || ( jQuery.cssNumber[ origName ] ? "" : "px" ); + } + + // background-* props affect original clone's values + if ( !support.clearCloneStyle && value === "" && name.indexOf( "background" ) === 0 ) { + style[ name ] = "inherit"; + } + + // If a hook was provided, use that value, otherwise just set the specified value + if ( !hooks || !( "set" in hooks ) || + ( value = hooks.set( elem, value, extra ) ) !== undefined ) { + + if ( isCustomProp ) { + style.setProperty( name, value ); + } else { + style[ name ] = value; + } + } + + } else { + + // If a hook was provided get the non-computed value from there + if ( hooks && "get" in hooks && + ( ret = hooks.get( elem, false, extra ) ) !== undefined ) { + + return ret; + } + + // Otherwise just get the value from the style object + return style[ name ]; + } + }, + + css: function( elem, name, extra, styles ) { + var val, num, hooks, + origName = camelCase( name ), + isCustomProp = rcustomProp.test( name ); + + // Make sure that we're working with the right name. We don't + // want to modify the value if it is a CSS custom property + // since they are user-defined. + if ( !isCustomProp ) { + name = finalPropName( origName ); + } + + // Try prefixed name followed by the unprefixed name + hooks = jQuery.cssHooks[ name ] || jQuery.cssHooks[ origName ]; + + // If a hook was provided get the computed value from there + if ( hooks && "get" in hooks ) { + val = hooks.get( elem, true, extra ); + } + + // Otherwise, if a way to get the computed value exists, use that + if ( val === undefined ) { + val = curCSS( elem, name, styles ); + } + + // Convert "normal" to computed value + if ( val === "normal" && name in cssNormalTransform ) { + val = cssNormalTransform[ name ]; + } + + // Make numeric if forced or a qualifier was provided and val looks numeric + if ( extra === "" || extra ) { + num = parseFloat( val ); + return extra === true || isFinite( num ) ? num || 0 : val; + } + + return val; + } +} ); + +jQuery.each( [ "height", "width" ], function( _i, dimension ) { + jQuery.cssHooks[ dimension ] = { + get: function( elem, computed, extra ) { + if ( computed ) { + + // Certain elements can have dimension info if we invisibly show them + // but it must have a current display style that would benefit + return rdisplayswap.test( jQuery.css( elem, "display" ) ) && + + // Support: Safari 8+ + // Table columns in Safari have non-zero offsetWidth & zero + // getBoundingClientRect().width unless display is changed. + // Support: IE <=11 only + // Running getBoundingClientRect on a disconnected node + // in IE throws an error. + ( !elem.getClientRects().length || !elem.getBoundingClientRect().width ) ? + swap( elem, cssShow, function() { + return getWidthOrHeight( elem, dimension, extra ); + } ) : + getWidthOrHeight( elem, dimension, extra ); + } + }, + + set: function( elem, value, extra ) { + var matches, + styles = getStyles( elem ), + + // Only read styles.position if the test has a chance to fail + // to avoid forcing a reflow. + scrollboxSizeBuggy = !support.scrollboxSize() && + styles.position === "absolute", + + // To avoid forcing a reflow, only fetch boxSizing if we need it (gh-3991) + boxSizingNeeded = scrollboxSizeBuggy || extra, + isBorderBox = boxSizingNeeded && + jQuery.css( elem, "boxSizing", false, styles ) === "border-box", + subtract = extra ? + boxModelAdjustment( + elem, + dimension, + extra, + isBorderBox, + styles + ) : + 0; + + // Account for unreliable border-box dimensions by comparing offset* to computed and + // faking a content-box to get border and padding (gh-3699) + if ( isBorderBox && scrollboxSizeBuggy ) { + subtract -= Math.ceil( + elem[ "offset" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ) ] - + parseFloat( styles[ dimension ] ) - + boxModelAdjustment( elem, dimension, "border", false, styles ) - + 0.5 + ); + } + + // Convert to pixels if value adjustment is needed + if ( subtract && ( matches = rcssNum.exec( value ) ) && + ( matches[ 3 ] || "px" ) !== "px" ) { + + elem.style[ dimension ] = value; + value = jQuery.css( elem, dimension ); + } + + return setPositiveNumber( elem, value, subtract ); + } + }; +} ); + +jQuery.cssHooks.marginLeft = addGetHookIf( support.reliableMarginLeft, + function( elem, computed ) { + if ( computed ) { + return ( parseFloat( curCSS( elem, "marginLeft" ) ) || + elem.getBoundingClientRect().left - + swap( elem, { marginLeft: 0 }, function() { + return elem.getBoundingClientRect().left; + } ) + ) + "px"; + } + } +); + +// These hooks are used by animate to expand properties +jQuery.each( { + margin: "", + padding: "", + border: "Width" +}, function( prefix, suffix ) { + jQuery.cssHooks[ prefix + suffix ] = { + expand: function( value ) { + var i = 0, + expanded = {}, + + // Assumes a single number if not a string + parts = typeof value === "string" ? value.split( " " ) : [ value ]; + + for ( ; i < 4; i++ ) { + expanded[ prefix + cssExpand[ i ] + suffix ] = + parts[ i ] || parts[ i - 2 ] || parts[ 0 ]; + } + + return expanded; + } + }; + + if ( prefix !== "margin" ) { + jQuery.cssHooks[ prefix + suffix ].set = setPositiveNumber; + } +} ); + +jQuery.fn.extend( { + css: function( name, value ) { + return access( this, function( elem, name, value ) { + var styles, len, + map = {}, + i = 0; + + if ( Array.isArray( name ) ) { + styles = getStyles( elem ); + len = name.length; + + for ( ; i < len; i++ ) { + map[ name[ i ] ] = jQuery.css( elem, name[ i ], false, styles ); + } + + return map; + } + + return value !== undefined ? + jQuery.style( elem, name, value ) : + jQuery.css( elem, name ); + }, name, value, arguments.length > 1 ); + } +} ); + + +function Tween( elem, options, prop, end, easing ) { + return new Tween.prototype.init( elem, options, prop, end, easing ); +} +jQuery.Tween = Tween; + +Tween.prototype = { + constructor: Tween, + init: function( elem, options, prop, end, easing, unit ) { + this.elem = elem; + this.prop = prop; + this.easing = easing || jQuery.easing._default; + this.options = options; + this.start = this.now = this.cur(); + this.end = end; + this.unit = unit || ( jQuery.cssNumber[ prop ] ? "" : "px" ); + }, + cur: function() { + var hooks = Tween.propHooks[ this.prop ]; + + return hooks && hooks.get ? + hooks.get( this ) : + Tween.propHooks._default.get( this ); + }, + run: function( percent ) { + var eased, + hooks = Tween.propHooks[ this.prop ]; + + if ( this.options.duration ) { + this.pos = eased = jQuery.easing[ this.easing ]( + percent, this.options.duration * percent, 0, 1, this.options.duration + ); + } else { + this.pos = eased = percent; + } + this.now = ( this.end - this.start ) * eased + this.start; + + if ( this.options.step ) { + this.options.step.call( this.elem, this.now, this ); + } + + if ( hooks && hooks.set ) { + hooks.set( this ); + } else { + Tween.propHooks._default.set( this ); + } + return this; + } +}; + +Tween.prototype.init.prototype = Tween.prototype; + +Tween.propHooks = { + _default: { + get: function( tween ) { + var result; + + // Use a property on the element directly when it is not a DOM element, + // or when there is no matching style property that exists. + if ( tween.elem.nodeType !== 1 || + tween.elem[ tween.prop ] != null && tween.elem.style[ tween.prop ] == null ) { + return tween.elem[ tween.prop ]; + } + + // Passing an empty string as a 3rd parameter to .css will automatically + // attempt a parseFloat and fallback to a string if the parse fails. + // Simple values such as "10px" are parsed to Float; + // complex values such as "rotate(1rad)" are returned as-is. + result = jQuery.css( tween.elem, tween.prop, "" ); + + // Empty strings, null, undefined and "auto" are converted to 0. + return !result || result === "auto" ? 0 : result; + }, + set: function( tween ) { + + // Use step hook for back compat. + // Use cssHook if its there. + // Use .style if available and use plain properties where available. + if ( jQuery.fx.step[ tween.prop ] ) { + jQuery.fx.step[ tween.prop ]( tween ); + } else if ( tween.elem.nodeType === 1 && ( + jQuery.cssHooks[ tween.prop ] || + tween.elem.style[ finalPropName( tween.prop ) ] != null ) ) { + jQuery.style( tween.elem, tween.prop, tween.now + tween.unit ); + } else { + tween.elem[ tween.prop ] = tween.now; + } + } + } +}; + +// Support: IE <=9 only +// Panic based approach to setting things on disconnected nodes +Tween.propHooks.scrollTop = Tween.propHooks.scrollLeft = { + set: function( tween ) { + if ( tween.elem.nodeType && tween.elem.parentNode ) { + tween.elem[ tween.prop ] = tween.now; + } + } +}; + +jQuery.easing = { + linear: function( p ) { + return p; + }, + swing: function( p ) { + return 0.5 - Math.cos( p * Math.PI ) / 2; + }, + _default: "swing" +}; + +jQuery.fx = Tween.prototype.init; + +// Back compat <1.8 extension point +jQuery.fx.step = {}; + + + + +var + fxNow, inProgress, + rfxtypes = /^(?:toggle|show|hide)$/, + rrun = /queueHooks$/; + +function schedule() { + if ( inProgress ) { + if ( document.hidden === false && window.requestAnimationFrame ) { + window.requestAnimationFrame( schedule ); + } else { + window.setTimeout( schedule, jQuery.fx.interval ); + } + + jQuery.fx.tick(); + } +} + +// Animations created synchronously will run synchronously +function createFxNow() { + window.setTimeout( function() { + fxNow = undefined; + } ); + return ( fxNow = Date.now() ); +} + +// Generate parameters to create a standard animation +function genFx( type, includeWidth ) { + var which, + i = 0, + attrs = { height: type }; + + // If we include width, step value is 1 to do all cssExpand values, + // otherwise step value is 2 to skip over Left and Right + includeWidth = includeWidth ? 1 : 0; + for ( ; i < 4; i += 2 - includeWidth ) { + which = cssExpand[ i ]; + attrs[ "margin" + which ] = attrs[ "padding" + which ] = type; + } + + if ( includeWidth ) { + attrs.opacity = attrs.width = type; + } + + return attrs; +} + +function createTween( value, prop, animation ) { + var tween, + collection = ( Animation.tweeners[ prop ] || [] ).concat( Animation.tweeners[ "*" ] ), + index = 0, + length = collection.length; + for ( ; index < length; index++ ) { + if ( ( tween = collection[ index ].call( animation, prop, value ) ) ) { + + // We're done with this property + return tween; + } + } +} + +function defaultPrefilter( elem, props, opts ) { + var prop, value, toggle, hooks, oldfire, propTween, restoreDisplay, display, + isBox = "width" in props || "height" in props, + anim = this, + orig = {}, + style = elem.style, + hidden = elem.nodeType && isHiddenWithinTree( elem ), + dataShow = dataPriv.get( elem, "fxshow" ); + + // Queue-skipping animations hijack the fx hooks + if ( !opts.queue ) { + hooks = jQuery._queueHooks( elem, "fx" ); + if ( hooks.unqueued == null ) { + hooks.unqueued = 0; + oldfire = hooks.empty.fire; + hooks.empty.fire = function() { + if ( !hooks.unqueued ) { + oldfire(); + } + }; + } + hooks.unqueued++; + + anim.always( function() { + + // Ensure the complete handler is called before this completes + anim.always( function() { + hooks.unqueued--; + if ( !jQuery.queue( elem, "fx" ).length ) { + hooks.empty.fire(); + } + } ); + } ); + } + + // Detect show/hide animations + for ( prop in props ) { + value = props[ prop ]; + if ( rfxtypes.test( value ) ) { + delete props[ prop ]; + toggle = toggle || value === "toggle"; + if ( value === ( hidden ? "hide" : "show" ) ) { + + // Pretend to be hidden if this is a "show" and + // there is still data from a stopped show/hide + if ( value === "show" && dataShow && dataShow[ prop ] !== undefined ) { + hidden = true; + + // Ignore all other no-op show/hide data + } else { + continue; + } + } + orig[ prop ] = dataShow && dataShow[ prop ] || jQuery.style( elem, prop ); + } + } + + // Bail out if this is a no-op like .hide().hide() + propTween = !jQuery.isEmptyObject( props ); + if ( !propTween && jQuery.isEmptyObject( orig ) ) { + return; + } + + // Restrict "overflow" and "display" styles during box animations + if ( isBox && elem.nodeType === 1 ) { + + // Support: IE <=9 - 11, Edge 12 - 15 + // Record all 3 overflow attributes because IE does not infer the shorthand + // from identically-valued overflowX and overflowY and Edge just mirrors + // the overflowX value there. + opts.overflow = [ style.overflow, style.overflowX, style.overflowY ]; + + // Identify a display type, preferring old show/hide data over the CSS cascade + restoreDisplay = dataShow && dataShow.display; + if ( restoreDisplay == null ) { + restoreDisplay = dataPriv.get( elem, "display" ); + } + display = jQuery.css( elem, "display" ); + if ( display === "none" ) { + if ( restoreDisplay ) { + display = restoreDisplay; + } else { + + // Get nonempty value(s) by temporarily forcing visibility + showHide( [ elem ], true ); + restoreDisplay = elem.style.display || restoreDisplay; + display = jQuery.css( elem, "display" ); + showHide( [ elem ] ); + } + } + + // Animate inline elements as inline-block + if ( display === "inline" || display === "inline-block" && restoreDisplay != null ) { + if ( jQuery.css( elem, "float" ) === "none" ) { + + // Restore the original display value at the end of pure show/hide animations + if ( !propTween ) { + anim.done( function() { + style.display = restoreDisplay; + } ); + if ( restoreDisplay == null ) { + display = style.display; + restoreDisplay = display === "none" ? "" : display; + } + } + style.display = "inline-block"; + } + } + } + + if ( opts.overflow ) { + style.overflow = "hidden"; + anim.always( function() { + style.overflow = opts.overflow[ 0 ]; + style.overflowX = opts.overflow[ 1 ]; + style.overflowY = opts.overflow[ 2 ]; + } ); + } + + // Implement show/hide animations + propTween = false; + for ( prop in orig ) { + + // General show/hide setup for this element animation + if ( !propTween ) { + if ( dataShow ) { + if ( "hidden" in dataShow ) { + hidden = dataShow.hidden; + } + } else { + dataShow = dataPriv.access( elem, "fxshow", { display: restoreDisplay } ); + } + + // Store hidden/visible for toggle so `.stop().toggle()` "reverses" + if ( toggle ) { + dataShow.hidden = !hidden; + } + + // Show elements before animating them + if ( hidden ) { + showHide( [ elem ], true ); + } + + /* eslint-disable no-loop-func */ + + anim.done( function() { + + /* eslint-enable no-loop-func */ + + // The final step of a "hide" animation is actually hiding the element + if ( !hidden ) { + showHide( [ elem ] ); + } + dataPriv.remove( elem, "fxshow" ); + for ( prop in orig ) { + jQuery.style( elem, prop, orig[ prop ] ); + } + } ); + } + + // Per-property setup + propTween = createTween( hidden ? dataShow[ prop ] : 0, prop, anim ); + if ( !( prop in dataShow ) ) { + dataShow[ prop ] = propTween.start; + if ( hidden ) { + propTween.end = propTween.start; + propTween.start = 0; + } + } + } +} + +function propFilter( props, specialEasing ) { + var index, name, easing, value, hooks; + + // camelCase, specialEasing and expand cssHook pass + for ( index in props ) { + name = camelCase( index ); + easing = specialEasing[ name ]; + value = props[ index ]; + if ( Array.isArray( value ) ) { + easing = value[ 1 ]; + value = props[ index ] = value[ 0 ]; + } + + if ( index !== name ) { + props[ name ] = value; + delete props[ index ]; + } + + hooks = jQuery.cssHooks[ name ]; + if ( hooks && "expand" in hooks ) { + value = hooks.expand( value ); + delete props[ name ]; + + // Not quite $.extend, this won't overwrite existing keys. + // Reusing 'index' because we have the correct "name" + for ( index in value ) { + if ( !( index in props ) ) { + props[ index ] = value[ index ]; + specialEasing[ index ] = easing; + } + } + } else { + specialEasing[ name ] = easing; + } + } +} + +function Animation( elem, properties, options ) { + var result, + stopped, + index = 0, + length = Animation.prefilters.length, + deferred = jQuery.Deferred().always( function() { + + // Don't match elem in the :animated selector + delete tick.elem; + } ), + tick = function() { + if ( stopped ) { + return false; + } + var currentTime = fxNow || createFxNow(), + remaining = Math.max( 0, animation.startTime + animation.duration - currentTime ), + + // Support: Android 2.3 only + // Archaic crash bug won't allow us to use `1 - ( 0.5 || 0 )` (#12497) + temp = remaining / animation.duration || 0, + percent = 1 - temp, + index = 0, + length = animation.tweens.length; + + for ( ; index < length; index++ ) { + animation.tweens[ index ].run( percent ); + } + + deferred.notifyWith( elem, [ animation, percent, remaining ] ); + + // If there's more to do, yield + if ( percent < 1 && length ) { + return remaining; + } + + // If this was an empty animation, synthesize a final progress notification + if ( !length ) { + deferred.notifyWith( elem, [ animation, 1, 0 ] ); + } + + // Resolve the animation and report its conclusion + deferred.resolveWith( elem, [ animation ] ); + return false; + }, + animation = deferred.promise( { + elem: elem, + props: jQuery.extend( {}, properties ), + opts: jQuery.extend( true, { + specialEasing: {}, + easing: jQuery.easing._default + }, options ), + originalProperties: properties, + originalOptions: options, + startTime: fxNow || createFxNow(), + duration: options.duration, + tweens: [], + createTween: function( prop, end ) { + var tween = jQuery.Tween( elem, animation.opts, prop, end, + animation.opts.specialEasing[ prop ] || animation.opts.easing ); + animation.tweens.push( tween ); + return tween; + }, + stop: function( gotoEnd ) { + var index = 0, + + // If we are going to the end, we want to run all the tweens + // otherwise we skip this part + length = gotoEnd ? animation.tweens.length : 0; + if ( stopped ) { + return this; + } + stopped = true; + for ( ; index < length; index++ ) { + animation.tweens[ index ].run( 1 ); + } + + // Resolve when we played the last frame; otherwise, reject + if ( gotoEnd ) { + deferred.notifyWith( elem, [ animation, 1, 0 ] ); + deferred.resolveWith( elem, [ animation, gotoEnd ] ); + } else { + deferred.rejectWith( elem, [ animation, gotoEnd ] ); + } + return this; + } + } ), + props = animation.props; + + propFilter( props, animation.opts.specialEasing ); + + for ( ; index < length; index++ ) { + result = Animation.prefilters[ index ].call( animation, elem, props, animation.opts ); + if ( result ) { + if ( isFunction( result.stop ) ) { + jQuery._queueHooks( animation.elem, animation.opts.queue ).stop = + result.stop.bind( result ); + } + return result; + } + } + + jQuery.map( props, createTween, animation ); + + if ( isFunction( animation.opts.start ) ) { + animation.opts.start.call( elem, animation ); + } + + // Attach callbacks from options + animation + .progress( animation.opts.progress ) + .done( animation.opts.done, animation.opts.complete ) + .fail( animation.opts.fail ) + .always( animation.opts.always ); + + jQuery.fx.timer( + jQuery.extend( tick, { + elem: elem, + anim: animation, + queue: animation.opts.queue + } ) + ); + + return animation; +} + +jQuery.Animation = jQuery.extend( Animation, { + + tweeners: { + "*": [ function( prop, value ) { + var tween = this.createTween( prop, value ); + adjustCSS( tween.elem, prop, rcssNum.exec( value ), tween ); + return tween; + } ] + }, + + tweener: function( props, callback ) { + if ( isFunction( props ) ) { + callback = props; + props = [ "*" ]; + } else { + props = props.match( rnothtmlwhite ); + } + + var prop, + index = 0, + length = props.length; + + for ( ; index < length; index++ ) { + prop = props[ index ]; + Animation.tweeners[ prop ] = Animation.tweeners[ prop ] || []; + Animation.tweeners[ prop ].unshift( callback ); + } + }, + + prefilters: [ defaultPrefilter ], + + prefilter: function( callback, prepend ) { + if ( prepend ) { + Animation.prefilters.unshift( callback ); + } else { + Animation.prefilters.push( callback ); + } + } +} ); + +jQuery.speed = function( speed, easing, fn ) { + var opt = speed && typeof speed === "object" ? jQuery.extend( {}, speed ) : { + complete: fn || !fn && easing || + isFunction( speed ) && speed, + duration: speed, + easing: fn && easing || easing && !isFunction( easing ) && easing + }; + + // Go to the end state if fx are off + if ( jQuery.fx.off ) { + opt.duration = 0; + + } else { + if ( typeof opt.duration !== "number" ) { + if ( opt.duration in jQuery.fx.speeds ) { + opt.duration = jQuery.fx.speeds[ opt.duration ]; + + } else { + opt.duration = jQuery.fx.speeds._default; + } + } + } + + // Normalize opt.queue - true/undefined/null -> "fx" + if ( opt.queue == null || opt.queue === true ) { + opt.queue = "fx"; + } + + // Queueing + opt.old = opt.complete; + + opt.complete = function() { + if ( isFunction( opt.old ) ) { + opt.old.call( this ); + } + + if ( opt.queue ) { + jQuery.dequeue( this, opt.queue ); + } + }; + + return opt; +}; + +jQuery.fn.extend( { + fadeTo: function( speed, to, easing, callback ) { + + // Show any hidden elements after setting opacity to 0 + return this.filter( isHiddenWithinTree ).css( "opacity", 0 ).show() + + // Animate to the value specified + .end().animate( { opacity: to }, speed, easing, callback ); + }, + animate: function( prop, speed, easing, callback ) { + var empty = jQuery.isEmptyObject( prop ), + optall = jQuery.speed( speed, easing, callback ), + doAnimation = function() { + + // Operate on a copy of prop so per-property easing won't be lost + var anim = Animation( this, jQuery.extend( {}, prop ), optall ); + + // Empty animations, or finishing resolves immediately + if ( empty || dataPriv.get( this, "finish" ) ) { + anim.stop( true ); + } + }; + + doAnimation.finish = doAnimation; + + return empty || optall.queue === false ? + this.each( doAnimation ) : + this.queue( optall.queue, doAnimation ); + }, + stop: function( type, clearQueue, gotoEnd ) { + var stopQueue = function( hooks ) { + var stop = hooks.stop; + delete hooks.stop; + stop( gotoEnd ); + }; + + if ( typeof type !== "string" ) { + gotoEnd = clearQueue; + clearQueue = type; + type = undefined; + } + if ( clearQueue ) { + this.queue( type || "fx", [] ); + } + + return this.each( function() { + var dequeue = true, + index = type != null && type + "queueHooks", + timers = jQuery.timers, + data = dataPriv.get( this ); + + if ( index ) { + if ( data[ index ] && data[ index ].stop ) { + stopQueue( data[ index ] ); + } + } else { + for ( index in data ) { + if ( data[ index ] && data[ index ].stop && rrun.test( index ) ) { + stopQueue( data[ index ] ); + } + } + } + + for ( index = timers.length; index--; ) { + if ( timers[ index ].elem === this && + ( type == null || timers[ index ].queue === type ) ) { + + timers[ index ].anim.stop( gotoEnd ); + dequeue = false; + timers.splice( index, 1 ); + } + } + + // Start the next in the queue if the last step wasn't forced. + // Timers currently will call their complete callbacks, which + // will dequeue but only if they were gotoEnd. + if ( dequeue || !gotoEnd ) { + jQuery.dequeue( this, type ); + } + } ); + }, + finish: function( type ) { + if ( type !== false ) { + type = type || "fx"; + } + return this.each( function() { + var index, + data = dataPriv.get( this ), + queue = data[ type + "queue" ], + hooks = data[ type + "queueHooks" ], + timers = jQuery.timers, + length = queue ? queue.length : 0; + + // Enable finishing flag on private data + data.finish = true; + + // Empty the queue first + jQuery.queue( this, type, [] ); + + if ( hooks && hooks.stop ) { + hooks.stop.call( this, true ); + } + + // Look for any active animations, and finish them + for ( index = timers.length; index--; ) { + if ( timers[ index ].elem === this && timers[ index ].queue === type ) { + timers[ index ].anim.stop( true ); + timers.splice( index, 1 ); + } + } + + // Look for any animations in the old queue and finish them + for ( index = 0; index < length; index++ ) { + if ( queue[ index ] && queue[ index ].finish ) { + queue[ index ].finish.call( this ); + } + } + + // Turn off finishing flag + delete data.finish; + } ); + } +} ); + +jQuery.each( [ "toggle", "show", "hide" ], function( _i, name ) { + var cssFn = jQuery.fn[ name ]; + jQuery.fn[ name ] = function( speed, easing, callback ) { + return speed == null || typeof speed === "boolean" ? + cssFn.apply( this, arguments ) : + this.animate( genFx( name, true ), speed, easing, callback ); + }; +} ); + +// Generate shortcuts for custom animations +jQuery.each( { + slideDown: genFx( "show" ), + slideUp: genFx( "hide" ), + slideToggle: genFx( "toggle" ), + fadeIn: { opacity: "show" }, + fadeOut: { opacity: "hide" }, + fadeToggle: { opacity: "toggle" } +}, function( name, props ) { + jQuery.fn[ name ] = function( speed, easing, callback ) { + return this.animate( props, speed, easing, callback ); + }; +} ); + +jQuery.timers = []; +jQuery.fx.tick = function() { + var timer, + i = 0, + timers = jQuery.timers; + + fxNow = Date.now(); + + for ( ; i < timers.length; i++ ) { + timer = timers[ i ]; + + // Run the timer and safely remove it when done (allowing for external removal) + if ( !timer() && timers[ i ] === timer ) { + timers.splice( i--, 1 ); + } + } + + if ( !timers.length ) { + jQuery.fx.stop(); + } + fxNow = undefined; +}; + +jQuery.fx.timer = function( timer ) { + jQuery.timers.push( timer ); + jQuery.fx.start(); +}; + +jQuery.fx.interval = 13; +jQuery.fx.start = function() { + if ( inProgress ) { + return; + } + + inProgress = true; + schedule(); +}; + +jQuery.fx.stop = function() { + inProgress = null; +}; + +jQuery.fx.speeds = { + slow: 600, + fast: 200, + + // Default speed + _default: 400 +}; + + +// Based off of the plugin by Clint Helfers, with permission. +// https://web.archive.org/web/20100324014747/http://blindsignals.com/index.php/2009/07/jquery-delay/ +jQuery.fn.delay = function( time, type ) { + time = jQuery.fx ? jQuery.fx.speeds[ time ] || time : time; + type = type || "fx"; + + return this.queue( type, function( next, hooks ) { + var timeout = window.setTimeout( next, time ); + hooks.stop = function() { + window.clearTimeout( timeout ); + }; + } ); +}; + + +( function() { + var input = document.createElement( "input" ), + select = document.createElement( "select" ), + opt = select.appendChild( document.createElement( "option" ) ); + + input.type = "checkbox"; + + // Support: Android <=4.3 only + // Default value for a checkbox should be "on" + support.checkOn = input.value !== ""; + + // Support: IE <=11 only + // Must access selectedIndex to make default options select + support.optSelected = opt.selected; + + // Support: IE <=11 only + // An input loses its value after becoming a radio + input = document.createElement( "input" ); + input.value = "t"; + input.type = "radio"; + support.radioValue = input.value === "t"; +} )(); + + +var boolHook, + attrHandle = jQuery.expr.attrHandle; + +jQuery.fn.extend( { + attr: function( name, value ) { + return access( this, jQuery.attr, name, value, arguments.length > 1 ); + }, + + removeAttr: function( name ) { + return this.each( function() { + jQuery.removeAttr( this, name ); + } ); + } +} ); + +jQuery.extend( { + attr: function( elem, name, value ) { + var ret, hooks, + nType = elem.nodeType; + + // Don't get/set attributes on text, comment and attribute nodes + if ( nType === 3 || nType === 8 || nType === 2 ) { + return; + } + + // Fallback to prop when attributes are not supported + if ( typeof elem.getAttribute === "undefined" ) { + return jQuery.prop( elem, name, value ); + } + + // Attribute hooks are determined by the lowercase version + // Grab necessary hook if one is defined + if ( nType !== 1 || !jQuery.isXMLDoc( elem ) ) { + hooks = jQuery.attrHooks[ name.toLowerCase() ] || + ( jQuery.expr.match.bool.test( name ) ? boolHook : undefined ); + } + + if ( value !== undefined ) { + if ( value === null ) { + jQuery.removeAttr( elem, name ); + return; + } + + if ( hooks && "set" in hooks && + ( ret = hooks.set( elem, value, name ) ) !== undefined ) { + return ret; + } + + elem.setAttribute( name, value + "" ); + return value; + } + + if ( hooks && "get" in hooks && ( ret = hooks.get( elem, name ) ) !== null ) { + return ret; + } + + ret = jQuery.find.attr( elem, name ); + + // Non-existent attributes return null, we normalize to undefined + return ret == null ? undefined : ret; + }, + + attrHooks: { + type: { + set: function( elem, value ) { + if ( !support.radioValue && value === "radio" && + nodeName( elem, "input" ) ) { + var val = elem.value; + elem.setAttribute( "type", value ); + if ( val ) { + elem.value = val; + } + return value; + } + } + } + }, + + removeAttr: function( elem, value ) { + var name, + i = 0, + + // Attribute names can contain non-HTML whitespace characters + // https://html.spec.whatwg.org/multipage/syntax.html#attributes-2 + attrNames = value && value.match( rnothtmlwhite ); + + if ( attrNames && elem.nodeType === 1 ) { + while ( ( name = attrNames[ i++ ] ) ) { + elem.removeAttribute( name ); + } + } + } +} ); + +// Hooks for boolean attributes +boolHook = { + set: function( elem, value, name ) { + if ( value === false ) { + + // Remove boolean attributes when set to false + jQuery.removeAttr( elem, name ); + } else { + elem.setAttribute( name, name ); + } + return name; + } +}; + +jQuery.each( jQuery.expr.match.bool.source.match( /\w+/g ), function( _i, name ) { + var getter = attrHandle[ name ] || jQuery.find.attr; + + attrHandle[ name ] = function( elem, name, isXML ) { + var ret, handle, + lowercaseName = name.toLowerCase(); + + if ( !isXML ) { + + // Avoid an infinite loop by temporarily removing this function from the getter + handle = attrHandle[ lowercaseName ]; + attrHandle[ lowercaseName ] = ret; + ret = getter( elem, name, isXML ) != null ? + lowercaseName : + null; + attrHandle[ lowercaseName ] = handle; + } + return ret; + }; +} ); + + + + +var rfocusable = /^(?:input|select|textarea|button)$/i, + rclickable = /^(?:a|area)$/i; + +jQuery.fn.extend( { + prop: function( name, value ) { + return access( this, jQuery.prop, name, value, arguments.length > 1 ); + }, + + removeProp: function( name ) { + return this.each( function() { + delete this[ jQuery.propFix[ name ] || name ]; + } ); + } +} ); + +jQuery.extend( { + prop: function( elem, name, value ) { + var ret, hooks, + nType = elem.nodeType; + + // Don't get/set properties on text, comment and attribute nodes + if ( nType === 3 || nType === 8 || nType === 2 ) { + return; + } + + if ( nType !== 1 || !jQuery.isXMLDoc( elem ) ) { + + // Fix name and attach hooks + name = jQuery.propFix[ name ] || name; + hooks = jQuery.propHooks[ name ]; + } + + if ( value !== undefined ) { + if ( hooks && "set" in hooks && + ( ret = hooks.set( elem, value, name ) ) !== undefined ) { + return ret; + } + + return ( elem[ name ] = value ); + } + + if ( hooks && "get" in hooks && ( ret = hooks.get( elem, name ) ) !== null ) { + return ret; + } + + return elem[ name ]; + }, + + propHooks: { + tabIndex: { + get: function( elem ) { + + // Support: IE <=9 - 11 only + // elem.tabIndex doesn't always return the + // correct value when it hasn't been explicitly set + // https://web.archive.org/web/20141116233347/http://fluidproject.org/blog/2008/01/09/getting-setting-and-removing-tabindex-values-with-javascript/ + // Use proper attribute retrieval(#12072) + var tabindex = jQuery.find.attr( elem, "tabindex" ); + + if ( tabindex ) { + return parseInt( tabindex, 10 ); + } + + if ( + rfocusable.test( elem.nodeName ) || + rclickable.test( elem.nodeName ) && + elem.href + ) { + return 0; + } + + return -1; + } + } + }, + + propFix: { + "for": "htmlFor", + "class": "className" + } +} ); + +// Support: IE <=11 only +// Accessing the selectedIndex property +// forces the browser to respect setting selected +// on the option +// The getter ensures a default option is selected +// when in an optgroup +// eslint rule "no-unused-expressions" is disabled for this code +// since it considers such accessions noop +if ( !support.optSelected ) { + jQuery.propHooks.selected = { + get: function( elem ) { + + /* eslint no-unused-expressions: "off" */ + + var parent = elem.parentNode; + if ( parent && parent.parentNode ) { + parent.parentNode.selectedIndex; + } + return null; + }, + set: function( elem ) { + + /* eslint no-unused-expressions: "off" */ + + var parent = elem.parentNode; + if ( parent ) { + parent.selectedIndex; + + if ( parent.parentNode ) { + parent.parentNode.selectedIndex; + } + } + } + }; +} + +jQuery.each( [ + "tabIndex", + "readOnly", + "maxLength", + "cellSpacing", + "cellPadding", + "rowSpan", + "colSpan", + "useMap", + "frameBorder", + "contentEditable" +], function() { + jQuery.propFix[ this.toLowerCase() ] = this; +} ); + + + + + // Strip and collapse whitespace according to HTML spec + // https://infra.spec.whatwg.org/#strip-and-collapse-ascii-whitespace + function stripAndCollapse( value ) { + var tokens = value.match( rnothtmlwhite ) || []; + return tokens.join( " " ); + } + + +function getClass( elem ) { + return elem.getAttribute && elem.getAttribute( "class" ) || ""; +} + +function classesToArray( value ) { + if ( Array.isArray( value ) ) { + return value; + } + if ( typeof value === "string" ) { + return value.match( rnothtmlwhite ) || []; + } + return []; +} + +jQuery.fn.extend( { + addClass: function( value ) { + var classes, elem, cur, curValue, clazz, j, finalValue, + i = 0; + + if ( isFunction( value ) ) { + return this.each( function( j ) { + jQuery( this ).addClass( value.call( this, j, getClass( this ) ) ); + } ); + } + + classes = classesToArray( value ); + + if ( classes.length ) { + while ( ( elem = this[ i++ ] ) ) { + curValue = getClass( elem ); + cur = elem.nodeType === 1 && ( " " + stripAndCollapse( curValue ) + " " ); + + if ( cur ) { + j = 0; + while ( ( clazz = classes[ j++ ] ) ) { + if ( cur.indexOf( " " + clazz + " " ) < 0 ) { + cur += clazz + " "; + } + } + + // Only assign if different to avoid unneeded rendering. + finalValue = stripAndCollapse( cur ); + if ( curValue !== finalValue ) { + elem.setAttribute( "class", finalValue ); + } + } + } + } + + return this; + }, + + removeClass: function( value ) { + var classes, elem, cur, curValue, clazz, j, finalValue, + i = 0; + + if ( isFunction( value ) ) { + return this.each( function( j ) { + jQuery( this ).removeClass( value.call( this, j, getClass( this ) ) ); + } ); + } + + if ( !arguments.length ) { + return this.attr( "class", "" ); + } + + classes = classesToArray( value ); + + if ( classes.length ) { + while ( ( elem = this[ i++ ] ) ) { + curValue = getClass( elem ); + + // This expression is here for better compressibility (see addClass) + cur = elem.nodeType === 1 && ( " " + stripAndCollapse( curValue ) + " " ); + + if ( cur ) { + j = 0; + while ( ( clazz = classes[ j++ ] ) ) { + + // Remove *all* instances + while ( cur.indexOf( " " + clazz + " " ) > -1 ) { + cur = cur.replace( " " + clazz + " ", " " ); + } + } + + // Only assign if different to avoid unneeded rendering. + finalValue = stripAndCollapse( cur ); + if ( curValue !== finalValue ) { + elem.setAttribute( "class", finalValue ); + } + } + } + } + + return this; + }, + + toggleClass: function( value, stateVal ) { + var type = typeof value, + isValidValue = type === "string" || Array.isArray( value ); + + if ( typeof stateVal === "boolean" && isValidValue ) { + return stateVal ? this.addClass( value ) : this.removeClass( value ); + } + + if ( isFunction( value ) ) { + return this.each( function( i ) { + jQuery( this ).toggleClass( + value.call( this, i, getClass( this ), stateVal ), + stateVal + ); + } ); + } + + return this.each( function() { + var className, i, self, classNames; + + if ( isValidValue ) { + + // Toggle individual class names + i = 0; + self = jQuery( this ); + classNames = classesToArray( value ); + + while ( ( className = classNames[ i++ ] ) ) { + + // Check each className given, space separated list + if ( self.hasClass( className ) ) { + self.removeClass( className ); + } else { + self.addClass( className ); + } + } + + // Toggle whole class name + } else if ( value === undefined || type === "boolean" ) { + className = getClass( this ); + if ( className ) { + + // Store className if set + dataPriv.set( this, "__className__", className ); + } + + // If the element has a class name or if we're passed `false`, + // then remove the whole classname (if there was one, the above saved it). + // Otherwise bring back whatever was previously saved (if anything), + // falling back to the empty string if nothing was stored. + if ( this.setAttribute ) { + this.setAttribute( "class", + className || value === false ? + "" : + dataPriv.get( this, "__className__" ) || "" + ); + } + } + } ); + }, + + hasClass: function( selector ) { + var className, elem, + i = 0; + + className = " " + selector + " "; + while ( ( elem = this[ i++ ] ) ) { + if ( elem.nodeType === 1 && + ( " " + stripAndCollapse( getClass( elem ) ) + " " ).indexOf( className ) > -1 ) { + return true; + } + } + + return false; + } +} ); + + + + +var rreturn = /\r/g; + +jQuery.fn.extend( { + val: function( value ) { + var hooks, ret, valueIsFunction, + elem = this[ 0 ]; + + if ( !arguments.length ) { + if ( elem ) { + hooks = jQuery.valHooks[ elem.type ] || + jQuery.valHooks[ elem.nodeName.toLowerCase() ]; + + if ( hooks && + "get" in hooks && + ( ret = hooks.get( elem, "value" ) ) !== undefined + ) { + return ret; + } + + ret = elem.value; + + // Handle most common string cases + if ( typeof ret === "string" ) { + return ret.replace( rreturn, "" ); + } + + // Handle cases where value is null/undef or number + return ret == null ? "" : ret; + } + + return; + } + + valueIsFunction = isFunction( value ); + + return this.each( function( i ) { + var val; + + if ( this.nodeType !== 1 ) { + return; + } + + if ( valueIsFunction ) { + val = value.call( this, i, jQuery( this ).val() ); + } else { + val = value; + } + + // Treat null/undefined as ""; convert numbers to string + if ( val == null ) { + val = ""; + + } else if ( typeof val === "number" ) { + val += ""; + + } else if ( Array.isArray( val ) ) { + val = jQuery.map( val, function( value ) { + return value == null ? "" : value + ""; + } ); + } + + hooks = jQuery.valHooks[ this.type ] || jQuery.valHooks[ this.nodeName.toLowerCase() ]; + + // If set returns undefined, fall back to normal setting + if ( !hooks || !( "set" in hooks ) || hooks.set( this, val, "value" ) === undefined ) { + this.value = val; + } + } ); + } +} ); + +jQuery.extend( { + valHooks: { + option: { + get: function( elem ) { + + var val = jQuery.find.attr( elem, "value" ); + return val != null ? + val : + + // Support: IE <=10 - 11 only + // option.text throws exceptions (#14686, #14858) + // Strip and collapse whitespace + // https://html.spec.whatwg.org/#strip-and-collapse-whitespace + stripAndCollapse( jQuery.text( elem ) ); + } + }, + select: { + get: function( elem ) { + var value, option, i, + options = elem.options, + index = elem.selectedIndex, + one = elem.type === "select-one", + values = one ? null : [], + max = one ? index + 1 : options.length; + + if ( index < 0 ) { + i = max; + + } else { + i = one ? index : 0; + } + + // Loop through all the selected options + for ( ; i < max; i++ ) { + option = options[ i ]; + + // Support: IE <=9 only + // IE8-9 doesn't update selected after form reset (#2551) + if ( ( option.selected || i === index ) && + + // Don't return options that are disabled or in a disabled optgroup + !option.disabled && + ( !option.parentNode.disabled || + !nodeName( option.parentNode, "optgroup" ) ) ) { + + // Get the specific value for the option + value = jQuery( option ).val(); + + // We don't need an array for one selects + if ( one ) { + return value; + } + + // Multi-Selects return an array + values.push( value ); + } + } + + return values; + }, + + set: function( elem, value ) { + var optionSet, option, + options = elem.options, + values = jQuery.makeArray( value ), + i = options.length; + + while ( i-- ) { + option = options[ i ]; + + /* eslint-disable no-cond-assign */ + + if ( option.selected = + jQuery.inArray( jQuery.valHooks.option.get( option ), values ) > -1 + ) { + optionSet = true; + } + + /* eslint-enable no-cond-assign */ + } + + // Force browsers to behave consistently when non-matching value is set + if ( !optionSet ) { + elem.selectedIndex = -1; + } + return values; + } + } + } +} ); + +// Radios and checkboxes getter/setter +jQuery.each( [ "radio", "checkbox" ], function() { + jQuery.valHooks[ this ] = { + set: function( elem, value ) { + if ( Array.isArray( value ) ) { + return ( elem.checked = jQuery.inArray( jQuery( elem ).val(), value ) > -1 ); + } + } + }; + if ( !support.checkOn ) { + jQuery.valHooks[ this ].get = function( elem ) { + return elem.getAttribute( "value" ) === null ? "on" : elem.value; + }; + } +} ); + + + + +// Return jQuery for attributes-only inclusion + + +support.focusin = "onfocusin" in window; + + +var rfocusMorph = /^(?:focusinfocus|focusoutblur)$/, + stopPropagationCallback = function( e ) { + e.stopPropagation(); + }; + +jQuery.extend( jQuery.event, { + + trigger: function( event, data, elem, onlyHandlers ) { + + var i, cur, tmp, bubbleType, ontype, handle, special, lastElement, + eventPath = [ elem || document ], + type = hasOwn.call( event, "type" ) ? event.type : event, + namespaces = hasOwn.call( event, "namespace" ) ? event.namespace.split( "." ) : []; + + cur = lastElement = tmp = elem = elem || document; + + // Don't do events on text and comment nodes + if ( elem.nodeType === 3 || elem.nodeType === 8 ) { + return; + } + + // focus/blur morphs to focusin/out; ensure we're not firing them right now + if ( rfocusMorph.test( type + jQuery.event.triggered ) ) { + return; + } + + if ( type.indexOf( "." ) > -1 ) { + + // Namespaced trigger; create a regexp to match event type in handle() + namespaces = type.split( "." ); + type = namespaces.shift(); + namespaces.sort(); + } + ontype = type.indexOf( ":" ) < 0 && "on" + type; + + // Caller can pass in a jQuery.Event object, Object, or just an event type string + event = event[ jQuery.expando ] ? + event : + new jQuery.Event( type, typeof event === "object" && event ); + + // Trigger bitmask: & 1 for native handlers; & 2 for jQuery (always true) + event.isTrigger = onlyHandlers ? 2 : 3; + event.namespace = namespaces.join( "." ); + event.rnamespace = event.namespace ? + new RegExp( "(^|\\.)" + namespaces.join( "\\.(?:.*\\.|)" ) + "(\\.|$)" ) : + null; + + // Clean up the event in case it is being reused + event.result = undefined; + if ( !event.target ) { + event.target = elem; + } + + // Clone any incoming data and prepend the event, creating the handler arg list + data = data == null ? + [ event ] : + jQuery.makeArray( data, [ event ] ); + + // Allow special events to draw outside the lines + special = jQuery.event.special[ type ] || {}; + if ( !onlyHandlers && special.trigger && special.trigger.apply( elem, data ) === false ) { + return; + } + + // Determine event propagation path in advance, per W3C events spec (#9951) + // Bubble up to document, then to window; watch for a global ownerDocument var (#9724) + if ( !onlyHandlers && !special.noBubble && !isWindow( elem ) ) { + + bubbleType = special.delegateType || type; + if ( !rfocusMorph.test( bubbleType + type ) ) { + cur = cur.parentNode; + } + for ( ; cur; cur = cur.parentNode ) { + eventPath.push( cur ); + tmp = cur; + } + + // Only add window if we got to document (e.g., not plain obj or detached DOM) + if ( tmp === ( elem.ownerDocument || document ) ) { + eventPath.push( tmp.defaultView || tmp.parentWindow || window ); + } + } + + // Fire handlers on the event path + i = 0; + while ( ( cur = eventPath[ i++ ] ) && !event.isPropagationStopped() ) { + lastElement = cur; + event.type = i > 1 ? + bubbleType : + special.bindType || type; + + // jQuery handler + handle = ( dataPriv.get( cur, "events" ) || Object.create( null ) )[ event.type ] && + dataPriv.get( cur, "handle" ); + if ( handle ) { + handle.apply( cur, data ); + } + + // Native handler + handle = ontype && cur[ ontype ]; + if ( handle && handle.apply && acceptData( cur ) ) { + event.result = handle.apply( cur, data ); + if ( event.result === false ) { + event.preventDefault(); + } + } + } + event.type = type; + + // If nobody prevented the default action, do it now + if ( !onlyHandlers && !event.isDefaultPrevented() ) { + + if ( ( !special._default || + special._default.apply( eventPath.pop(), data ) === false ) && + acceptData( elem ) ) { + + // Call a native DOM method on the target with the same name as the event. + // Don't do default actions on window, that's where global variables be (#6170) + if ( ontype && isFunction( elem[ type ] ) && !isWindow( elem ) ) { + + // Don't re-trigger an onFOO event when we call its FOO() method + tmp = elem[ ontype ]; + + if ( tmp ) { + elem[ ontype ] = null; + } + + // Prevent re-triggering of the same event, since we already bubbled it above + jQuery.event.triggered = type; + + if ( event.isPropagationStopped() ) { + lastElement.addEventListener( type, stopPropagationCallback ); + } + + elem[ type ](); + + if ( event.isPropagationStopped() ) { + lastElement.removeEventListener( type, stopPropagationCallback ); + } + + jQuery.event.triggered = undefined; + + if ( tmp ) { + elem[ ontype ] = tmp; + } + } + } + } + + return event.result; + }, + + // Piggyback on a donor event to simulate a different one + // Used only for `focus(in | out)` events + simulate: function( type, elem, event ) { + var e = jQuery.extend( + new jQuery.Event(), + event, + { + type: type, + isSimulated: true + } + ); + + jQuery.event.trigger( e, null, elem ); + } + +} ); + +jQuery.fn.extend( { + + trigger: function( type, data ) { + return this.each( function() { + jQuery.event.trigger( type, data, this ); + } ); + }, + triggerHandler: function( type, data ) { + var elem = this[ 0 ]; + if ( elem ) { + return jQuery.event.trigger( type, data, elem, true ); + } + } +} ); + + +// Support: Firefox <=44 +// Firefox doesn't have focus(in | out) events +// Related ticket - https://bugzilla.mozilla.org/show_bug.cgi?id=687787 +// +// Support: Chrome <=48 - 49, Safari <=9.0 - 9.1 +// focus(in | out) events fire after focus & blur events, +// which is spec violation - http://www.w3.org/TR/DOM-Level-3-Events/#events-focusevent-event-order +// Related ticket - https://bugs.chromium.org/p/chromium/issues/detail?id=449857 +if ( !support.focusin ) { + jQuery.each( { focus: "focusin", blur: "focusout" }, function( orig, fix ) { + + // Attach a single capturing handler on the document while someone wants focusin/focusout + var handler = function( event ) { + jQuery.event.simulate( fix, event.target, jQuery.event.fix( event ) ); + }; + + jQuery.event.special[ fix ] = { + setup: function() { + + // Handle: regular nodes (via `this.ownerDocument`), window + // (via `this.document`) & document (via `this`). + var doc = this.ownerDocument || this.document || this, + attaches = dataPriv.access( doc, fix ); + + if ( !attaches ) { + doc.addEventListener( orig, handler, true ); + } + dataPriv.access( doc, fix, ( attaches || 0 ) + 1 ); + }, + teardown: function() { + var doc = this.ownerDocument || this.document || this, + attaches = dataPriv.access( doc, fix ) - 1; + + if ( !attaches ) { + doc.removeEventListener( orig, handler, true ); + dataPriv.remove( doc, fix ); + + } else { + dataPriv.access( doc, fix, attaches ); + } + } + }; + } ); +} +var location = window.location; + +var nonce = { guid: Date.now() }; + +var rquery = ( /\?/ ); + + + +// Cross-browser xml parsing +jQuery.parseXML = function( data ) { + var xml, parserErrorElem; + if ( !data || typeof data !== "string" ) { + return null; + } + + // Support: IE 9 - 11 only + // IE throws on parseFromString with invalid input. + try { + xml = ( new window.DOMParser() ).parseFromString( data, "text/xml" ); + } catch ( e ) {} + + parserErrorElem = xml && xml.getElementsByTagName( "parsererror" )[ 0 ]; + if ( !xml || parserErrorElem ) { + jQuery.error( "Invalid XML: " + ( + parserErrorElem ? + jQuery.map( parserErrorElem.childNodes, function( el ) { + return el.textContent; + } ).join( "\n" ) : + data + ) ); + } + return xml; +}; + + +var + rbracket = /\[\]$/, + rCRLF = /\r?\n/g, + rsubmitterTypes = /^(?:submit|button|image|reset|file)$/i, + rsubmittable = /^(?:input|select|textarea|keygen)/i; + +function buildParams( prefix, obj, traditional, add ) { + var name; + + if ( Array.isArray( obj ) ) { + + // Serialize array item. + jQuery.each( obj, function( i, v ) { + if ( traditional || rbracket.test( prefix ) ) { + + // Treat each array item as a scalar. + add( prefix, v ); + + } else { + + // Item is non-scalar (array or object), encode its numeric index. + buildParams( + prefix + "[" + ( typeof v === "object" && v != null ? i : "" ) + "]", + v, + traditional, + add + ); + } + } ); + + } else if ( !traditional && toType( obj ) === "object" ) { + + // Serialize object item. + for ( name in obj ) { + buildParams( prefix + "[" + name + "]", obj[ name ], traditional, add ); + } + + } else { + + // Serialize scalar item. + add( prefix, obj ); + } +} + +// Serialize an array of form elements or a set of +// key/values into a query string +jQuery.param = function( a, traditional ) { + var prefix, + s = [], + add = function( key, valueOrFunction ) { + + // If value is a function, invoke it and use its return value + var value = isFunction( valueOrFunction ) ? + valueOrFunction() : + valueOrFunction; + + s[ s.length ] = encodeURIComponent( key ) + "=" + + encodeURIComponent( value == null ? "" : value ); + }; + + if ( a == null ) { + return ""; + } + + // If an array was passed in, assume that it is an array of form elements. + if ( Array.isArray( a ) || ( a.jquery && !jQuery.isPlainObject( a ) ) ) { + + // Serialize the form elements + jQuery.each( a, function() { + add( this.name, this.value ); + } ); + + } else { + + // If traditional, encode the "old" way (the way 1.3.2 or older + // did it), otherwise encode params recursively. + for ( prefix in a ) { + buildParams( prefix, a[ prefix ], traditional, add ); + } + } + + // Return the resulting serialization + return s.join( "&" ); +}; + +jQuery.fn.extend( { + serialize: function() { + return jQuery.param( this.serializeArray() ); + }, + serializeArray: function() { + return this.map( function() { + + // Can add propHook for "elements" to filter or add form elements + var elements = jQuery.prop( this, "elements" ); + return elements ? jQuery.makeArray( elements ) : this; + } ).filter( function() { + var type = this.type; + + // Use .is( ":disabled" ) so that fieldset[disabled] works + return this.name && !jQuery( this ).is( ":disabled" ) && + rsubmittable.test( this.nodeName ) && !rsubmitterTypes.test( type ) && + ( this.checked || !rcheckableType.test( type ) ); + } ).map( function( _i, elem ) { + var val = jQuery( this ).val(); + + if ( val == null ) { + return null; + } + + if ( Array.isArray( val ) ) { + return jQuery.map( val, function( val ) { + return { name: elem.name, value: val.replace( rCRLF, "\r\n" ) }; + } ); + } + + return { name: elem.name, value: val.replace( rCRLF, "\r\n" ) }; + } ).get(); + } +} ); + + +var + r20 = /%20/g, + rhash = /#.*$/, + rantiCache = /([?&])_=[^&]*/, + rheaders = /^(.*?):[ \t]*([^\r\n]*)$/mg, + + // #7653, #8125, #8152: local protocol detection + rlocalProtocol = /^(?:about|app|app-storage|.+-extension|file|res|widget):$/, + rnoContent = /^(?:GET|HEAD)$/, + rprotocol = /^\/\//, + + /* Prefilters + * 1) They are useful to introduce custom dataTypes (see ajax/jsonp.js for an example) + * 2) These are called: + * - BEFORE asking for a transport + * - AFTER param serialization (s.data is a string if s.processData is true) + * 3) key is the dataType + * 4) the catchall symbol "*" can be used + * 5) execution will start with transport dataType and THEN continue down to "*" if needed + */ + prefilters = {}, + + /* Transports bindings + * 1) key is the dataType + * 2) the catchall symbol "*" can be used + * 3) selection will start with transport dataType and THEN go to "*" if needed + */ + transports = {}, + + // Avoid comment-prolog char sequence (#10098); must appease lint and evade compression + allTypes = "*/".concat( "*" ), + + // Anchor tag for parsing the document origin + originAnchor = document.createElement( "a" ); + +originAnchor.href = location.href; + +// Base "constructor" for jQuery.ajaxPrefilter and jQuery.ajaxTransport +function addToPrefiltersOrTransports( structure ) { + + // dataTypeExpression is optional and defaults to "*" + return function( dataTypeExpression, func ) { + + if ( typeof dataTypeExpression !== "string" ) { + func = dataTypeExpression; + dataTypeExpression = "*"; + } + + var dataType, + i = 0, + dataTypes = dataTypeExpression.toLowerCase().match( rnothtmlwhite ) || []; + + if ( isFunction( func ) ) { + + // For each dataType in the dataTypeExpression + while ( ( dataType = dataTypes[ i++ ] ) ) { + + // Prepend if requested + if ( dataType[ 0 ] === "+" ) { + dataType = dataType.slice( 1 ) || "*"; + ( structure[ dataType ] = structure[ dataType ] || [] ).unshift( func ); + + // Otherwise append + } else { + ( structure[ dataType ] = structure[ dataType ] || [] ).push( func ); + } + } + } + }; +} + +// Base inspection function for prefilters and transports +function inspectPrefiltersOrTransports( structure, options, originalOptions, jqXHR ) { + + var inspected = {}, + seekingTransport = ( structure === transports ); + + function inspect( dataType ) { + var selected; + inspected[ dataType ] = true; + jQuery.each( structure[ dataType ] || [], function( _, prefilterOrFactory ) { + var dataTypeOrTransport = prefilterOrFactory( options, originalOptions, jqXHR ); + if ( typeof dataTypeOrTransport === "string" && + !seekingTransport && !inspected[ dataTypeOrTransport ] ) { + + options.dataTypes.unshift( dataTypeOrTransport ); + inspect( dataTypeOrTransport ); + return false; + } else if ( seekingTransport ) { + return !( selected = dataTypeOrTransport ); + } + } ); + return selected; + } + + return inspect( options.dataTypes[ 0 ] ) || !inspected[ "*" ] && inspect( "*" ); +} + +// A special extend for ajax options +// that takes "flat" options (not to be deep extended) +// Fixes #9887 +function ajaxExtend( target, src ) { + var key, deep, + flatOptions = jQuery.ajaxSettings.flatOptions || {}; + + for ( key in src ) { + if ( src[ key ] !== undefined ) { + ( flatOptions[ key ] ? target : ( deep || ( deep = {} ) ) )[ key ] = src[ key ]; + } + } + if ( deep ) { + jQuery.extend( true, target, deep ); + } + + return target; +} + +/* Handles responses to an ajax request: + * - finds the right dataType (mediates between content-type and expected dataType) + * - returns the corresponding response + */ +function ajaxHandleResponses( s, jqXHR, responses ) { + + var ct, type, finalDataType, firstDataType, + contents = s.contents, + dataTypes = s.dataTypes; + + // Remove auto dataType and get content-type in the process + while ( dataTypes[ 0 ] === "*" ) { + dataTypes.shift(); + if ( ct === undefined ) { + ct = s.mimeType || jqXHR.getResponseHeader( "Content-Type" ); + } + } + + // Check if we're dealing with a known content-type + if ( ct ) { + for ( type in contents ) { + if ( contents[ type ] && contents[ type ].test( ct ) ) { + dataTypes.unshift( type ); + break; + } + } + } + + // Check to see if we have a response for the expected dataType + if ( dataTypes[ 0 ] in responses ) { + finalDataType = dataTypes[ 0 ]; + } else { + + // Try convertible dataTypes + for ( type in responses ) { + if ( !dataTypes[ 0 ] || s.converters[ type + " " + dataTypes[ 0 ] ] ) { + finalDataType = type; + break; + } + if ( !firstDataType ) { + firstDataType = type; + } + } + + // Or just use first one + finalDataType = finalDataType || firstDataType; + } + + // If we found a dataType + // We add the dataType to the list if needed + // and return the corresponding response + if ( finalDataType ) { + if ( finalDataType !== dataTypes[ 0 ] ) { + dataTypes.unshift( finalDataType ); + } + return responses[ finalDataType ]; + } +} + +/* Chain conversions given the request and the original response + * Also sets the responseXXX fields on the jqXHR instance + */ +function ajaxConvert( s, response, jqXHR, isSuccess ) { + var conv2, current, conv, tmp, prev, + converters = {}, + + // Work with a copy of dataTypes in case we need to modify it for conversion + dataTypes = s.dataTypes.slice(); + + // Create converters map with lowercased keys + if ( dataTypes[ 1 ] ) { + for ( conv in s.converters ) { + converters[ conv.toLowerCase() ] = s.converters[ conv ]; + } + } + + current = dataTypes.shift(); + + // Convert to each sequential dataType + while ( current ) { + + if ( s.responseFields[ current ] ) { + jqXHR[ s.responseFields[ current ] ] = response; + } + + // Apply the dataFilter if provided + if ( !prev && isSuccess && s.dataFilter ) { + response = s.dataFilter( response, s.dataType ); + } + + prev = current; + current = dataTypes.shift(); + + if ( current ) { + + // There's only work to do if current dataType is non-auto + if ( current === "*" ) { + + current = prev; + + // Convert response if prev dataType is non-auto and differs from current + } else if ( prev !== "*" && prev !== current ) { + + // Seek a direct converter + conv = converters[ prev + " " + current ] || converters[ "* " + current ]; + + // If none found, seek a pair + if ( !conv ) { + for ( conv2 in converters ) { + + // If conv2 outputs current + tmp = conv2.split( " " ); + if ( tmp[ 1 ] === current ) { + + // If prev can be converted to accepted input + conv = converters[ prev + " " + tmp[ 0 ] ] || + converters[ "* " + tmp[ 0 ] ]; + if ( conv ) { + + // Condense equivalence converters + if ( conv === true ) { + conv = converters[ conv2 ]; + + // Otherwise, insert the intermediate dataType + } else if ( converters[ conv2 ] !== true ) { + current = tmp[ 0 ]; + dataTypes.unshift( tmp[ 1 ] ); + } + break; + } + } + } + } + + // Apply converter (if not an equivalence) + if ( conv !== true ) { + + // Unless errors are allowed to bubble, catch and return them + if ( conv && s.throws ) { + response = conv( response ); + } else { + try { + response = conv( response ); + } catch ( e ) { + return { + state: "parsererror", + error: conv ? e : "No conversion from " + prev + " to " + current + }; + } + } + } + } + } + } + + return { state: "success", data: response }; +} + +jQuery.extend( { + + // Counter for holding the number of active queries + active: 0, + + // Last-Modified header cache for next request + lastModified: {}, + etag: {}, + + ajaxSettings: { + url: location.href, + type: "GET", + isLocal: rlocalProtocol.test( location.protocol ), + global: true, + processData: true, + async: true, + contentType: "application/x-www-form-urlencoded; charset=UTF-8", + + /* + timeout: 0, + data: null, + dataType: null, + username: null, + password: null, + cache: null, + throws: false, + traditional: false, + headers: {}, + */ + + accepts: { + "*": allTypes, + text: "text/plain", + html: "text/html", + xml: "application/xml, text/xml", + json: "application/json, text/javascript" + }, + + contents: { + xml: /\bxml\b/, + html: /\bhtml/, + json: /\bjson\b/ + }, + + responseFields: { + xml: "responseXML", + text: "responseText", + json: "responseJSON" + }, + + // Data converters + // Keys separate source (or catchall "*") and destination types with a single space + converters: { + + // Convert anything to text + "* text": String, + + // Text to html (true = no transformation) + "text html": true, + + // Evaluate text as a json expression + "text json": JSON.parse, + + // Parse text as xml + "text xml": jQuery.parseXML + }, + + // For options that shouldn't be deep extended: + // you can add your own custom options here if + // and when you create one that shouldn't be + // deep extended (see ajaxExtend) + flatOptions: { + url: true, + context: true + } + }, + + // Creates a full fledged settings object into target + // with both ajaxSettings and settings fields. + // If target is omitted, writes into ajaxSettings. + ajaxSetup: function( target, settings ) { + return settings ? + + // Building a settings object + ajaxExtend( ajaxExtend( target, jQuery.ajaxSettings ), settings ) : + + // Extending ajaxSettings + ajaxExtend( jQuery.ajaxSettings, target ); + }, + + ajaxPrefilter: addToPrefiltersOrTransports( prefilters ), + ajaxTransport: addToPrefiltersOrTransports( transports ), + + // Main method + ajax: function( url, options ) { + + // If url is an object, simulate pre-1.5 signature + if ( typeof url === "object" ) { + options = url; + url = undefined; + } + + // Force options to be an object + options = options || {}; + + var transport, + + // URL without anti-cache param + cacheURL, + + // Response headers + responseHeadersString, + responseHeaders, + + // timeout handle + timeoutTimer, + + // Url cleanup var + urlAnchor, + + // Request state (becomes false upon send and true upon completion) + completed, + + // To know if global events are to be dispatched + fireGlobals, + + // Loop variable + i, + + // uncached part of the url + uncached, + + // Create the final options object + s = jQuery.ajaxSetup( {}, options ), + + // Callbacks context + callbackContext = s.context || s, + + // Context for global events is callbackContext if it is a DOM node or jQuery collection + globalEventContext = s.context && + ( callbackContext.nodeType || callbackContext.jquery ) ? + jQuery( callbackContext ) : + jQuery.event, + + // Deferreds + deferred = jQuery.Deferred(), + completeDeferred = jQuery.Callbacks( "once memory" ), + + // Status-dependent callbacks + statusCode = s.statusCode || {}, + + // Headers (they are sent all at once) + requestHeaders = {}, + requestHeadersNames = {}, + + // Default abort message + strAbort = "canceled", + + // Fake xhr + jqXHR = { + readyState: 0, + + // Builds headers hashtable if needed + getResponseHeader: function( key ) { + var match; + if ( completed ) { + if ( !responseHeaders ) { + responseHeaders = {}; + while ( ( match = rheaders.exec( responseHeadersString ) ) ) { + responseHeaders[ match[ 1 ].toLowerCase() + " " ] = + ( responseHeaders[ match[ 1 ].toLowerCase() + " " ] || [] ) + .concat( match[ 2 ] ); + } + } + match = responseHeaders[ key.toLowerCase() + " " ]; + } + return match == null ? null : match.join( ", " ); + }, + + // Raw string + getAllResponseHeaders: function() { + return completed ? responseHeadersString : null; + }, + + // Caches the header + setRequestHeader: function( name, value ) { + if ( completed == null ) { + name = requestHeadersNames[ name.toLowerCase() ] = + requestHeadersNames[ name.toLowerCase() ] || name; + requestHeaders[ name ] = value; + } + return this; + }, + + // Overrides response content-type header + overrideMimeType: function( type ) { + if ( completed == null ) { + s.mimeType = type; + } + return this; + }, + + // Status-dependent callbacks + statusCode: function( map ) { + var code; + if ( map ) { + if ( completed ) { + + // Execute the appropriate callbacks + jqXHR.always( map[ jqXHR.status ] ); + } else { + + // Lazy-add the new callbacks in a way that preserves old ones + for ( code in map ) { + statusCode[ code ] = [ statusCode[ code ], map[ code ] ]; + } + } + } + return this; + }, + + // Cancel the request + abort: function( statusText ) { + var finalText = statusText || strAbort; + if ( transport ) { + transport.abort( finalText ); + } + done( 0, finalText ); + return this; + } + }; + + // Attach deferreds + deferred.promise( jqXHR ); + + // Add protocol if not provided (prefilters might expect it) + // Handle falsy url in the settings object (#10093: consistency with old signature) + // We also use the url parameter if available + s.url = ( ( url || s.url || location.href ) + "" ) + .replace( rprotocol, location.protocol + "//" ); + + // Alias method option to type as per ticket #12004 + s.type = options.method || options.type || s.method || s.type; + + // Extract dataTypes list + s.dataTypes = ( s.dataType || "*" ).toLowerCase().match( rnothtmlwhite ) || [ "" ]; + + // A cross-domain request is in order when the origin doesn't match the current origin. + if ( s.crossDomain == null ) { + urlAnchor = document.createElement( "a" ); + + // Support: IE <=8 - 11, Edge 12 - 15 + // IE throws exception on accessing the href property if url is malformed, + // e.g. http://example.com:80x/ + try { + urlAnchor.href = s.url; + + // Support: IE <=8 - 11 only + // Anchor's host property isn't correctly set when s.url is relative + urlAnchor.href = urlAnchor.href; + s.crossDomain = originAnchor.protocol + "//" + originAnchor.host !== + urlAnchor.protocol + "//" + urlAnchor.host; + } catch ( e ) { + + // If there is an error parsing the URL, assume it is crossDomain, + // it can be rejected by the transport if it is invalid + s.crossDomain = true; + } + } + + // Convert data if not already a string + if ( s.data && s.processData && typeof s.data !== "string" ) { + s.data = jQuery.param( s.data, s.traditional ); + } + + // Apply prefilters + inspectPrefiltersOrTransports( prefilters, s, options, jqXHR ); + + // If request was aborted inside a prefilter, stop there + if ( completed ) { + return jqXHR; + } + + // We can fire global events as of now if asked to + // Don't fire events if jQuery.event is undefined in an AMD-usage scenario (#15118) + fireGlobals = jQuery.event && s.global; + + // Watch for a new set of requests + if ( fireGlobals && jQuery.active++ === 0 ) { + jQuery.event.trigger( "ajaxStart" ); + } + + // Uppercase the type + s.type = s.type.toUpperCase(); + + // Determine if request has content + s.hasContent = !rnoContent.test( s.type ); + + // Save the URL in case we're toying with the If-Modified-Since + // and/or If-None-Match header later on + // Remove hash to simplify url manipulation + cacheURL = s.url.replace( rhash, "" ); + + // More options handling for requests with no content + if ( !s.hasContent ) { + + // Remember the hash so we can put it back + uncached = s.url.slice( cacheURL.length ); + + // If data is available and should be processed, append data to url + if ( s.data && ( s.processData || typeof s.data === "string" ) ) { + cacheURL += ( rquery.test( cacheURL ) ? "&" : "?" ) + s.data; + + // #9682: remove data so that it's not used in an eventual retry + delete s.data; + } + + // Add or update anti-cache param if needed + if ( s.cache === false ) { + cacheURL = cacheURL.replace( rantiCache, "$1" ); + uncached = ( rquery.test( cacheURL ) ? "&" : "?" ) + "_=" + ( nonce.guid++ ) + + uncached; + } + + // Put hash and anti-cache on the URL that will be requested (gh-1732) + s.url = cacheURL + uncached; + + // Change '%20' to '+' if this is encoded form body content (gh-2658) + } else if ( s.data && s.processData && + ( s.contentType || "" ).indexOf( "application/x-www-form-urlencoded" ) === 0 ) { + s.data = s.data.replace( r20, "+" ); + } + + // Set the If-Modified-Since and/or If-None-Match header, if in ifModified mode. + if ( s.ifModified ) { + if ( jQuery.lastModified[ cacheURL ] ) { + jqXHR.setRequestHeader( "If-Modified-Since", jQuery.lastModified[ cacheURL ] ); + } + if ( jQuery.etag[ cacheURL ] ) { + jqXHR.setRequestHeader( "If-None-Match", jQuery.etag[ cacheURL ] ); + } + } + + // Set the correct header, if data is being sent + if ( s.data && s.hasContent && s.contentType !== false || options.contentType ) { + jqXHR.setRequestHeader( "Content-Type", s.contentType ); + } + + // Set the Accepts header for the server, depending on the dataType + jqXHR.setRequestHeader( + "Accept", + s.dataTypes[ 0 ] && s.accepts[ s.dataTypes[ 0 ] ] ? + s.accepts[ s.dataTypes[ 0 ] ] + + ( s.dataTypes[ 0 ] !== "*" ? ", " + allTypes + "; q=0.01" : "" ) : + s.accepts[ "*" ] + ); + + // Check for headers option + for ( i in s.headers ) { + jqXHR.setRequestHeader( i, s.headers[ i ] ); + } + + // Allow custom headers/mimetypes and early abort + if ( s.beforeSend && + ( s.beforeSend.call( callbackContext, jqXHR, s ) === false || completed ) ) { + + // Abort if not done already and return + return jqXHR.abort(); + } + + // Aborting is no longer a cancellation + strAbort = "abort"; + + // Install callbacks on deferreds + completeDeferred.add( s.complete ); + jqXHR.done( s.success ); + jqXHR.fail( s.error ); + + // Get transport + transport = inspectPrefiltersOrTransports( transports, s, options, jqXHR ); + + // If no transport, we auto-abort + if ( !transport ) { + done( -1, "No Transport" ); + } else { + jqXHR.readyState = 1; + + // Send global event + if ( fireGlobals ) { + globalEventContext.trigger( "ajaxSend", [ jqXHR, s ] ); + } + + // If request was aborted inside ajaxSend, stop there + if ( completed ) { + return jqXHR; + } + + // Timeout + if ( s.async && s.timeout > 0 ) { + timeoutTimer = window.setTimeout( function() { + jqXHR.abort( "timeout" ); + }, s.timeout ); + } + + try { + completed = false; + transport.send( requestHeaders, done ); + } catch ( e ) { + + // Rethrow post-completion exceptions + if ( completed ) { + throw e; + } + + // Propagate others as results + done( -1, e ); + } + } + + // Callback for when everything is done + function done( status, nativeStatusText, responses, headers ) { + var isSuccess, success, error, response, modified, + statusText = nativeStatusText; + + // Ignore repeat invocations + if ( completed ) { + return; + } + + completed = true; + + // Clear timeout if it exists + if ( timeoutTimer ) { + window.clearTimeout( timeoutTimer ); + } + + // Dereference transport for early garbage collection + // (no matter how long the jqXHR object will be used) + transport = undefined; + + // Cache response headers + responseHeadersString = headers || ""; + + // Set readyState + jqXHR.readyState = status > 0 ? 4 : 0; + + // Determine if successful + isSuccess = status >= 200 && status < 300 || status === 304; + + // Get response data + if ( responses ) { + response = ajaxHandleResponses( s, jqXHR, responses ); + } + + // Use a noop converter for missing script but not if jsonp + if ( !isSuccess && + jQuery.inArray( "script", s.dataTypes ) > -1 && + jQuery.inArray( "json", s.dataTypes ) < 0 ) { + s.converters[ "text script" ] = function() {}; + } + + // Convert no matter what (that way responseXXX fields are always set) + response = ajaxConvert( s, response, jqXHR, isSuccess ); + + // If successful, handle type chaining + if ( isSuccess ) { + + // Set the If-Modified-Since and/or If-None-Match header, if in ifModified mode. + if ( s.ifModified ) { + modified = jqXHR.getResponseHeader( "Last-Modified" ); + if ( modified ) { + jQuery.lastModified[ cacheURL ] = modified; + } + modified = jqXHR.getResponseHeader( "etag" ); + if ( modified ) { + jQuery.etag[ cacheURL ] = modified; + } + } + + // if no content + if ( status === 204 || s.type === "HEAD" ) { + statusText = "nocontent"; + + // if not modified + } else if ( status === 304 ) { + statusText = "notmodified"; + + // If we have data, let's convert it + } else { + statusText = response.state; + success = response.data; + error = response.error; + isSuccess = !error; + } + } else { + + // Extract error from statusText and normalize for non-aborts + error = statusText; + if ( status || !statusText ) { + statusText = "error"; + if ( status < 0 ) { + status = 0; + } + } + } + + // Set data for the fake xhr object + jqXHR.status = status; + jqXHR.statusText = ( nativeStatusText || statusText ) + ""; + + // Success/Error + if ( isSuccess ) { + deferred.resolveWith( callbackContext, [ success, statusText, jqXHR ] ); + } else { + deferred.rejectWith( callbackContext, [ jqXHR, statusText, error ] ); + } + + // Status-dependent callbacks + jqXHR.statusCode( statusCode ); + statusCode = undefined; + + if ( fireGlobals ) { + globalEventContext.trigger( isSuccess ? "ajaxSuccess" : "ajaxError", + [ jqXHR, s, isSuccess ? success : error ] ); + } + + // Complete + completeDeferred.fireWith( callbackContext, [ jqXHR, statusText ] ); + + if ( fireGlobals ) { + globalEventContext.trigger( "ajaxComplete", [ jqXHR, s ] ); + + // Handle the global AJAX counter + if ( !( --jQuery.active ) ) { + jQuery.event.trigger( "ajaxStop" ); + } + } + } + + return jqXHR; + }, + + getJSON: function( url, data, callback ) { + return jQuery.get( url, data, callback, "json" ); + }, + + getScript: function( url, callback ) { + return jQuery.get( url, undefined, callback, "script" ); + } +} ); + +jQuery.each( [ "get", "post" ], function( _i, method ) { + jQuery[ method ] = function( url, data, callback, type ) { + + // Shift arguments if data argument was omitted + if ( isFunction( data ) ) { + type = type || callback; + callback = data; + data = undefined; + } + + // The url can be an options object (which then must have .url) + return jQuery.ajax( jQuery.extend( { + url: url, + type: method, + dataType: type, + data: data, + success: callback + }, jQuery.isPlainObject( url ) && url ) ); + }; +} ); + +jQuery.ajaxPrefilter( function( s ) { + var i; + for ( i in s.headers ) { + if ( i.toLowerCase() === "content-type" ) { + s.contentType = s.headers[ i ] || ""; + } + } +} ); + + +jQuery._evalUrl = function( url, options, doc ) { + return jQuery.ajax( { + url: url, + + // Make this explicit, since user can override this through ajaxSetup (#11264) + type: "GET", + dataType: "script", + cache: true, + async: false, + global: false, + + // Only evaluate the response if it is successful (gh-4126) + // dataFilter is not invoked for failure responses, so using it instead + // of the default converter is kludgy but it works. + converters: { + "text script": function() {} + }, + dataFilter: function( response ) { + jQuery.globalEval( response, options, doc ); + } + } ); +}; + + +jQuery.fn.extend( { + wrapAll: function( html ) { + var wrap; + + if ( this[ 0 ] ) { + if ( isFunction( html ) ) { + html = html.call( this[ 0 ] ); + } + + // The elements to wrap the target around + wrap = jQuery( html, this[ 0 ].ownerDocument ).eq( 0 ).clone( true ); + + if ( this[ 0 ].parentNode ) { + wrap.insertBefore( this[ 0 ] ); + } + + wrap.map( function() { + var elem = this; + + while ( elem.firstElementChild ) { + elem = elem.firstElementChild; + } + + return elem; + } ).append( this ); + } + + return this; + }, + + wrapInner: function( html ) { + if ( isFunction( html ) ) { + return this.each( function( i ) { + jQuery( this ).wrapInner( html.call( this, i ) ); + } ); + } + + return this.each( function() { + var self = jQuery( this ), + contents = self.contents(); + + if ( contents.length ) { + contents.wrapAll( html ); + + } else { + self.append( html ); + } + } ); + }, + + wrap: function( html ) { + var htmlIsFunction = isFunction( html ); + + return this.each( function( i ) { + jQuery( this ).wrapAll( htmlIsFunction ? html.call( this, i ) : html ); + } ); + }, + + unwrap: function( selector ) { + this.parent( selector ).not( "body" ).each( function() { + jQuery( this ).replaceWith( this.childNodes ); + } ); + return this; + } +} ); + + +jQuery.expr.pseudos.hidden = function( elem ) { + return !jQuery.expr.pseudos.visible( elem ); +}; +jQuery.expr.pseudos.visible = function( elem ) { + return !!( elem.offsetWidth || elem.offsetHeight || elem.getClientRects().length ); +}; + + + + +jQuery.ajaxSettings.xhr = function() { + try { + return new window.XMLHttpRequest(); + } catch ( e ) {} +}; + +var xhrSuccessStatus = { + + // File protocol always yields status code 0, assume 200 + 0: 200, + + // Support: IE <=9 only + // #1450: sometimes IE returns 1223 when it should be 204 + 1223: 204 + }, + xhrSupported = jQuery.ajaxSettings.xhr(); + +support.cors = !!xhrSupported && ( "withCredentials" in xhrSupported ); +support.ajax = xhrSupported = !!xhrSupported; + +jQuery.ajaxTransport( function( options ) { + var callback, errorCallback; + + // Cross domain only allowed if supported through XMLHttpRequest + if ( support.cors || xhrSupported && !options.crossDomain ) { + return { + send: function( headers, complete ) { + var i, + xhr = options.xhr(); + + xhr.open( + options.type, + options.url, + options.async, + options.username, + options.password + ); + + // Apply custom fields if provided + if ( options.xhrFields ) { + for ( i in options.xhrFields ) { + xhr[ i ] = options.xhrFields[ i ]; + } + } + + // Override mime type if needed + if ( options.mimeType && xhr.overrideMimeType ) { + xhr.overrideMimeType( options.mimeType ); + } + + // X-Requested-With header + // For cross-domain requests, seeing as conditions for a preflight are + // akin to a jigsaw puzzle, we simply never set it to be sure. + // (it can always be set on a per-request basis or even using ajaxSetup) + // For same-domain requests, won't change header if already provided. + if ( !options.crossDomain && !headers[ "X-Requested-With" ] ) { + headers[ "X-Requested-With" ] = "XMLHttpRequest"; + } + + // Set headers + for ( i in headers ) { + xhr.setRequestHeader( i, headers[ i ] ); + } + + // Callback + callback = function( type ) { + return function() { + if ( callback ) { + callback = errorCallback = xhr.onload = + xhr.onerror = xhr.onabort = xhr.ontimeout = + xhr.onreadystatechange = null; + + if ( type === "abort" ) { + xhr.abort(); + } else if ( type === "error" ) { + + // Support: IE <=9 only + // On a manual native abort, IE9 throws + // errors on any property access that is not readyState + if ( typeof xhr.status !== "number" ) { + complete( 0, "error" ); + } else { + complete( + + // File: protocol always yields status 0; see #8605, #14207 + xhr.status, + xhr.statusText + ); + } + } else { + complete( + xhrSuccessStatus[ xhr.status ] || xhr.status, + xhr.statusText, + + // Support: IE <=9 only + // IE9 has no XHR2 but throws on binary (trac-11426) + // For XHR2 non-text, let the caller handle it (gh-2498) + ( xhr.responseType || "text" ) !== "text" || + typeof xhr.responseText !== "string" ? + { binary: xhr.response } : + { text: xhr.responseText }, + xhr.getAllResponseHeaders() + ); + } + } + }; + }; + + // Listen to events + xhr.onload = callback(); + errorCallback = xhr.onerror = xhr.ontimeout = callback( "error" ); + + // Support: IE 9 only + // Use onreadystatechange to replace onabort + // to handle uncaught aborts + if ( xhr.onabort !== undefined ) { + xhr.onabort = errorCallback; + } else { + xhr.onreadystatechange = function() { + + // Check readyState before timeout as it changes + if ( xhr.readyState === 4 ) { + + // Allow onerror to be called first, + // but that will not handle a native abort + // Also, save errorCallback to a variable + // as xhr.onerror cannot be accessed + window.setTimeout( function() { + if ( callback ) { + errorCallback(); + } + } ); + } + }; + } + + // Create the abort callback + callback = callback( "abort" ); + + try { + + // Do send the request (this may raise an exception) + xhr.send( options.hasContent && options.data || null ); + } catch ( e ) { + + // #14683: Only rethrow if this hasn't been notified as an error yet + if ( callback ) { + throw e; + } + } + }, + + abort: function() { + if ( callback ) { + callback(); + } + } + }; + } +} ); + + + + +// Prevent auto-execution of scripts when no explicit dataType was provided (See gh-2432) +jQuery.ajaxPrefilter( function( s ) { + if ( s.crossDomain ) { + s.contents.script = false; + } +} ); + +// Install script dataType +jQuery.ajaxSetup( { + accepts: { + script: "text/javascript, application/javascript, " + + "application/ecmascript, application/x-ecmascript" + }, + contents: { + script: /\b(?:java|ecma)script\b/ + }, + converters: { + "text script": function( text ) { + jQuery.globalEval( text ); + return text; + } + } +} ); + +// Handle cache's special case and crossDomain +jQuery.ajaxPrefilter( "script", function( s ) { + if ( s.cache === undefined ) { + s.cache = false; + } + if ( s.crossDomain ) { + s.type = "GET"; + } +} ); + +// Bind script tag hack transport +jQuery.ajaxTransport( "script", function( s ) { + + // This transport only deals with cross domain or forced-by-attrs requests + if ( s.crossDomain || s.scriptAttrs ) { + var script, callback; + return { + send: function( _, complete ) { + script = jQuery( " + + + + + + + + + + + + + +
+ + +
+ +
+
+ + +
+ +
+
+ +
+
+ +
+

Continuous Integration (CI)

+
+

Note

+

At the moment, there is no triggering mechanism set up between different GitHub repositories. +All the workflows in this repo are triggered by push events, CRON jobs, or manually.

+
+
+

Status

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

Base, Simulation and Linting

Synthesis, PnR and Prog

Formal

ASIC

All-in-one

'doc workflow Status'

'apicula workflow Status'

'boolector workflow Status'

'irsim workflow Status'

'formal workflow Status'

'base workflow Status'

'arachne-pnr workflow Status'

'cvc workflow Status'

'klayout workflow Status'

'sim workflow Status'

'ghdl workflow Status'

'ghdl-yosys-plugin workflow Status'

'pono workflow Status'

'magic workflow Status'

'impl workflow Status'

'gtkwave workflow Status'

'icestorm workflow Status'

'superprove workflow Status'

'netgen workflow Status'

'prog workflow Status'

'iverilog workflow Status'

'nextpnr workflow Status'

'sby workflow Status'

'openroad workflow Status'

'nvc workflow Status'

'openfpgaloader workflow Status'

'yices2 workflow Status'

'verible workflow Status'

'prjoxide workflow Status'

'z3 workflow Status'

'verilator workflow Status'

'prjtrellis workflow Status'

'xschem workflow Status'

'f4pga workflow Status'

'xyce workflow Status'

'vtr workflow Status'

'yosys workflow Status'

+
+
+

Structure

+

The continuous integration in this repository is based on commands pull and build provided by the Python utils +(see pyHDLC Reference); so, contributors can execute exactly the same commands locally, for +debugging and development. +However, there are several layers of complexity around those commands, in order to precisely decide which images to +build in each workflow/job execution.

+
+Structure of the Continuous Integration (CI) +
+

Fig. 12 Structure of the Continuous Integration (CI) in this repository.

+
+
+

As shown in Fig. 12, the following wrappers are used:

+
+

Tip

+

In pyTooling/Actions: Context, details about Action and Workflow kinds supported in +GitHub Actions are explained. +See also Workflow syntax for GitHub Actions.

+
+
    +
  • build-test-release is a local Composite Action with three steps, +including setup, pulling/building/testing and releasing.

  • +
  • Common is a Reusable Workflow with two jobs. +The first job, named matrix, uses pyHDLC jobs to generate a list of tasks to be used in the second job, named +jobs (see docs.github.com: Workflow syntax for GitHub Actions » jobs.<job_id>.outputs). +Then, the Composite Action is used in each of the dynamically generated jobs.

  • +
  • Dispatch is a Dispatchable Workflow, which calls the Reusable Workflow. +In practice, Dispatch documents the internal triggering interface, but it is not used explicitly. +There are dozens of workflows (one per tool or group) which are equivalent to Dispatch with some hardcoded inputs. +Those are triggered through scheduled (CRON) events, by pushes, by Pull Requests or manually.

  • +
+

Since most of the complexity of the orchestration is defined in the YAML configuration file used by pyHDLC, reading +YAML Configuration File is strongly recommended. +As shown in Fig. 12, data from the configuration file is used in the Reusable Workflow Common and in the +build step of the Composite Action build-test-release.

+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/dev/Contributing.html b/dev/Contributing.html new file mode 100644 index 000000000..779f5ff30 --- /dev/null +++ b/dev/Contributing.html @@ -0,0 +1,442 @@ + + + + + + + Contributing — HDL Containers: Building and deploying container images for open source Electronic Design Automation latest documentation + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+ + +
+ +
+
+ +
+
+ +
+

Contributing

+

As explained in Tools and images and in the User Guide, +multiple collections of images are provided. +For each collection, a set of base images is provided, which are to be used for building and for runtime. +These are defined in base.dockerfile. +See, for instance, debian-bookworm/base.dockerfile. +All the images in the ecosystem are based on these:

+
    +
  • 'build/base container image size' Debian Bookworm, Debian Bullseye or Rocky Linux 8, with updated ca-certificates, +curl and Python 3.

  • +
  • 'build/build container image size' based on base, includes clang and make.

  • +
  • 'build/dev container image size' based on build, includes cmake, libboost-all-dev and python3-dev.

  • +
+

Then, for each project/tool there are dockerfiles (one for each collection), a GitHub Actions workflow, and one or more +test scripts. +Those are used for:

+
    +
  • Tools are built using REGISTRY/[ARCHITECTURE/][COLLECTION/]build images.

  • +
  • Package images based on scratch (and/or other reusable packages) are produced.

  • +
  • Ready-to-use images based on the runtime base image (REGISTRY/[ARCHITECTURE/][COLLECTION/]build/base) are produced.

  • +
  • Ready-to-use images are tested before uploading.

  • +
+

The Package images created in some dockerfiles/workflows are based on scratch +and contain pre-built assets. +Therefore, they are not really useful per se, but meant to be used for building other. +In fact, multiple tools are merged into ready-to-use images for common use cases (such as impl, +formal or prog).

+
+

Important

+

Before working on adding or extending the support for a tool, please check the +issues and pull requests; +open an issue +or let us know through the chat. +Someone might be working on that already!

+
+
+

Note

+

Currently, many projects don’t use containers at all, hence, all images are generated in this repository. +However, the workload is expected to be distributed between multiple projects in the ecosystem.

+
+
+

Dockerfiles

+

Two kinds of Dockerfile definitions are supported by the utils +used in this repository: single-file solutions, or aided by additional assets. +Nonetheless, all dockerfiles use, at least, two or three stages:

+
    +
  • A global argument named REGISTRY defines the default registry path and collection to be used.

  • +
  • One stage, named build, based on $REGISTRY/build/base or $REGISTRY/build/build or $REGISTRY/build/dev, +is used to (optionally) install build dependencies, and to actually build the tool.

    +
      +
    • The tool/project is built using the standard PREFIX, but installed to a custom location using DESTDIR. +See Package images.

    • +
    +
  • +
  • If the tool/project is to be packaged, one stage based on image scratch is named pkg and it contains the +artifacts of the build stage only.

    +
      +
    • Tool artifacts are copied from the build stage using COPY --from=STAGE_NAME.

    • +
    +
  • +
  • If the tool/project is to be used standalone, a final stage based on image $REGISTRY/build/base is used to +(optionally) install runtime dependencies, to copy the build artifacts from the build stage, and to (optionally) set +the default command for the image.

  • +
+
+

Note

+

In some dockerfiles, global argument IMAGE is used to compose stages on top of multiple intermediate images.

+
+
+

Single-file example

+

Some tools are defined in a dockerfile only, without any additional assets. +In those cases, the dockerfile is named after the name of the main tool/image built there.

+
+
Listing 1 Reference Dockerfile to build a TOOL and generate a regular image and a package image.
+
ARG REGISTRY='gcr.io/hdl-containers/debian/bookworm'
+
+#--
+
+FROM $REGISTRY/build/build AS build
+
+RUN apt-get update -qq \
+ && DEBIAN_FRONTEND=noninteractive apt-get -y install --no-install-recommends \
+    ... \
+ && apt-get autoclean && apt-get clean && apt-get -y autoremove \
+ && rm -rf /var/lib/apt/lists/*
+
+RUN git clone REPOSITORY_URL /tmp/TOOL \
+ && cd /tmp/TOOL \
+ && ./configure \
+ && make -j$(nproc) \
+ && make DESTDIR=/opt/TOOL install
+
+#---
+
+FROM scratch AS pkg
+COPY --from=build /opt/TOOL /TOOL
+
+#---
+
+FROM $REGISTRY/build/base
+
+RUN apt-get update -qq \
+ && DEBIAN_FRONTEND=noninteractive apt-get -y install --no-install-recommends \
+    ... \
+ && apt-get autoclean && apt-get clean && apt-get -y autoremove \
+ && rm -rf /var/lib/apt/lists/*
+
+COPY --from=build /opt/TOOL /
+CMD ["TOOL"]
+
+
+
+
+

Note

+

Typically, stage pkg is used as a target to build a package image, and the dockerfile is used without a target in +order to build the regular image for the tool. +However, some tools/groups require additional stages, and some other don’t have the package or the regular stage.

+
+
+
+

Example with HDLC script

+

On the other hand, the dockerfiles to build tools with additional assets are named Dockerfile and located in a +subdir under the collection directory, named after the name of the main tool/image built there. +Those are typically used along with a shell script named HDLC. +The structure of these dockerfiles is similar to the Single-file example, however, +BuilKit’s --mount feature is used to source a helper script (HDLC) without creating additional stages/steps (see +BuildKit). +A similar strategy can be used to run or copy additional assets into the images.

+
+
Listing 2 Reference HDLC script to decouple dependency lists and build steps from the Dockerfile.
+
makedepends=(
+  ...
+)
+
+build() {
+  mkdir /tmp/TOOL
+  cd /tmp/TOOL
+  git clone REPOSITORY_URL ./
+  ./configure
+  make -j$(nproc)
+  make DESTDIR=/opt/TOOL install
+}
+
+depends=(
+  ...
+)
+
+
+
+
+

Note

+

The default shell in the collections used in this repository is set to bash. +Therefore, arrays and other bash extensions are supported in these scripts.

+
+
+
Listing 3 Reference Dockerfile to build a TOOL and generate a regular image and a package image, using an HDLC script and +BuildKit mount features.
+
ARG REGISTRY='gcr.io/hdl-containers/debian/bookworm'
+
+#---
+
+FROM $REGISTRY/build/build AS build
+
+RUN --mount=type=bind,target=/tmp/ctx . /tmp/ctx/HDLC \
+ && mkdir -p /usr/share/man/man1/ \
+ && apt-get update -qq \
+ && DEBIAN_FRONTEND=noninteractive apt-get -y install --no-install-recommends ${makedepends[@]} \
+ && apt-get autoclean && apt-get clean && apt-get -y autoremove \
+ && update-ca-certificates \
+ && rm -rf /var/lib/apt/lists/*
+
+RUN --mount=type=bind,target=/tmp/ctx . /tmp/ctx/HDLC && build
+
+#---
+
+FROM scratch AS pkg
+COPY --from=build /opt/TOOL /TOOL
+
+#---
+
+FROM $REGISTRY/build/base
+
+RUN --mount=type=bind,target=/tmp/ctx . /tmp/ctx/HDLC \
+ && apt-get update -qq \
+ && DEBIAN_FRONTEND=noninteractive apt-get -y install --no-install-recommends ${depends[@]} \
+ && apt-get autoclean && apt-get clean && apt-get -y autoremove \
+ && rm -rf /var/lib/apt/lists/*
+
+COPY --from=build /opt/TOOL /
+CMD ["TOOL"]
+
+
+
+
+
+
+

BuildKit

+

The usage of dockerfiles in this repository relies on the image build engine making an analysis and pruning of the stages. +Furthermore, option --mount used in some of the dockerfiles requires docs.docker.com: BuildKit. +Therefore, enabling BuildKit is required in order to build the images.

+

Depending on the version of Docker on your host or CI service, BuildKit features might need to be enabled explicitly. +As explained in docs.docker.com: To enable BuildKit builds, either set the DOCKER_BUILDKIT=1 environment variable, or set the daemon feature to +true in the JSON configuration file: ({ "features": { "buildkit": true } }).

+

Find further details about BuildKit’s mount syntax in moby/buildkit: frontend/dockerfile/docs/syntax.md.

+ +
+

Note

+

In order to use those features, apart from using BuildKit # syntax=docker/dockerfile:1.3 might need to be added as +the first line of the Dockerfile. +That depends on the version of Docker. +Recent versions should not require it.

+
+
+
+

Step by step checklist

+
    +
  1. Create or update dockerfile(s).

  2. +
+
+
    +
  • For each tool and collection, a Dockerfile recipe exists. +Find details about the requirements when writing dockerfiles in Dockerfiles.

    +
    +
      +
    • Optionally, add tools to multiple collections at the same time. +That is, create one dockerfile for each collection.

    • +
    +
    +
  • +
  • Some tools are to be added to existing images which include several tools (coloured BROWN in the +Graphs). +After creating the dockerfile where the corresponding package image is defined, add +COPY --from=$REGISTRY/pkg/TOOL_NAME statements to the dockerfiles of multi-tool images.

  • +
+
+
    +
  1. Build and test the dockerfile(s) locally. +Use helper scripts from subdir utils/, as explained in Utils.

  2. +
+
+
    +
  • If a new tool was added, or a new image is to be generated, a test script needs to be added to test/. +See Smoke-tests for naming guidelines.

  • +
  • Be careful with the order. +If you add a new tool and include it in one of the multi-tool images, the package image needs to be built first.

  • +
+
+
    +
  1. Create or update workflow(s).

  2. +
+
+
    +
  • For each tool or multi-tool image, a GitHub Actions workflow is added to .github/workflows. +In each workflow, multiple images produced from stages of the corresponding dockerfile are built, tested and pushed. +Scripts from utils/ are used. +Find details at Structure.

    +
    +
      +
    • Copying some of the existing workflows in this repo and adapting it is suggested.

    • +
    • If necessary, update the config.yml to override the defaults or to define new +job/task lists.

    • +
    +
    +
  • +
+
+
    +
  1. Update the documentation.

  2. +
+
+
+
+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/dev/GraphGeneration.html b/dev/GraphGeneration.html new file mode 100644 index 000000000..cec4686a2 --- /dev/null +++ b/dev/GraphGeneration.html @@ -0,0 +1,259 @@ + + + + + + + Graph generation/parsing — HDL Containers: Building and deploying container images for open source Electronic Design Automation latest documentation + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+ + +
+ +
+
+ +
+
+ +
+

Graph generation/parsing

+

Currently, the Graphs are updated manually. +That is error prone, because the information shown in them is also defined in the dockerfiles, configuration YAML file +and CI workflows. +Ideally, graphs would be auto-generated by parsing/analysing those. +However, the complexity of the graphs is non-trivial. +There are many tools for automatically generating diagrams from large datasets, but not so many with features for +visualizing complex hierarchical nets. +The requirements we are willing to satisfy are the following:

+
    +
  • Open source tool and format(s).

  • +
  • Generates diagrams programmatically from a text representation and/or through a Python or Golang API.

  • +
  • Supports hierarchical DAGs with multiple levels of hierarchy. I.e. (nested) clusters which are nodes and have ports.

  • +
  • Generates SVG of the hierarchical DAGs.

  • +
  • Supports node styles (shape and colour).

  • +
  • Ideally:

    +
      +
    • Clusters are collapsible when shown in an HTML site.

    • +
    • Text in the nodes can be links to web sites.

    • +
    +
  • +
+

So far, the following options were analysed:

+ +

Graphviz and Gephi are probably the most known tools for generating all kinds of diagrams. +Unfortunately, none of them supports hierarchical clusters as required in this use case. +The same issue applies to aafigure and graphdracula.

+

yEd is a very interesting product, and fits most (if not all) the technical constraints. +However, it’s not open source. +The editor is freeware and the SDK is paid. +For programmatic generation, the SDK is required. +The draw.io/mxgraph toolkit seems to be the most similar open source solution. +However, using SDKs for building custom interactive diagraming tools feels overkill in this use case. +We don’t need graphs to be editable through a GUI!

+

Similarly, Tikz and SVG generation libraries (such as svgo) can be used for having the work done, but they require +writing a non-negligible plumbing which would increase the maintenance burden, instead of reducing it. +This would be a last resort.

+

Although d3-hwschematic and netlistsvg are very different use cases, the JSON format used in elkjs might be suitable.

+

dagre-d3 is meant for DAGs and it supports nested clusters (experimentally, +Dagre D3 Demo: Clusters). +Although clusters seem not to have ports, it might be an easy update from the current solution. +Since it’s a client-side JS library, it does not write an SVG file to disk by default, but achieving it should be +trivial.

+

As a result, it seems that the most suitable solution might be using the JSON format from elkjs, either with elkjs or +with dagre-d3. +Yet, generating an SVG programmatically seems not to be as straightforward as using other solutions such as Graphviz’s +dot. +The following references illustrate advanced features for building custom views/GUIs/editors:

+ +

However, it seems that writing a JSON is cumbersome. +On the one hand, some nodes need to have a size for them to be shown. +On the other hand, it seems not possible to draw edges across hierarchies. +Ports need to be explicitly defined for that purpose. +Therefore, the complexity of generating the JSON given a set of nodes, edges and clusters is non-trivial.

+
+

Note

+

Branch utils/pyHDLC/map.py@pymap contains work in progress. +First, GenerateMap builds a DAG by parsing the dockerfiles. +Then, report prints the content in the terminal, for debugging purposes. +Last, dotgraph generates a Graphviz dot diagram. +The dot diagram does not have clusters. +We want to add those by parsing the GitHub Actions workflows (see below). +However, we want to first reproduce the dot output using elkjs. +See function elkjsgraph in utils/pyHDLC/map.py@pymap. +Do you want to give it a try? Let us know or join the chat!

+
+
+

Reading dockerfiles

+

One of the two sources of information for the graph are dockerfiles. +As far as we are aware, there is no tool for generating a DAG from the stages of a dockerfile. +However, gh:asottile/dockerfile is an interesting Python module which wraps docker/moby’s golang parser. +Hence, it can be used for getting the stages and COPY --from or --mount statements for generating the hierarchy. +See utils/pyHDLC/map.py.

+
+
+

Reading GitHub Actions workflow files

+

The second source of information are CI workflow files. +Since YAML is used, reading it from any language is trivial, however, semantic analysis needs to be done. +Particularly, variables from matrix need to be expanded/replaced. +gh:nektos/act is written in golang, and it allows executing GitHub Actions workflows locally. +Therefore, it might have the required features. +However, as far as we are aware, it’s not meant to be used as a library.

+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/dev/Graphs.html b/dev/Graphs.html new file mode 100644 index 000000000..fa3ead0a1 --- /dev/null +++ b/dev/Graphs.html @@ -0,0 +1,2518 @@ + + + + + + + Graphs — HDL Containers: Building and deploying container images for open source Electronic Design Automation latest documentation + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+ + +
+ +
+
+ +
+
+ +
+

Graphs

+

Understanding how all the pieces in this project fit together might be daunting for newcomers. +Fortunately, there is a map for helping maintainers and contributors traveling through the ecosystem. +Subdir doc/graph/ contains the sources of directed graphs, where the +relations between workflows, dockerfiles, images and tests are shown.

+

(Graphviz)’s digraph format is used, hence, graphs can be rendered to multiple image +formats. +The output shown in Fig. 2 describes which images are created in each map. +See the details in the figure corresponding to the name of the subgraph: +Base (Fig. 3), +Sim (Fig. 4), +Synth (Fig. 5), +Impl (Fig. 6), +Formal (Fig. 7), +ASIC (Fig. 8), and +F4PGA (Fig. 9). +Multiple colours and arrow types are used for describing different dependency types. +All of those are explained in the legend: Fig. 10.

+
+

Important

+

These graphs represent a single collection of images (the virtual aggregation of others). +In practice, some tools might be missing in some collections. +For instance, a tool might be available in Debian Buster based containers, but not in CentOS 7. +That info is not tracked in the graphs yet. +Please, see whether a dockerfile exists in the corresponding subdir.

+
+
+
# Authors:
+#   Unai Martinez-Corral
+#     <umartinezcorral@antmicro.com>
+#     <unai.martinezcorral@ehu.eus>
+#
+# Copyright Unai Martinez-Corral
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# SPDX-License-Identifier: Apache-2.0
+
+digraph G {
+
+  #splines=polyline; #curved
+  newrank=true;
+
+  # Maps
+
+  { node [shape=point]
+    m_base
+    m_synth
+    m_sim
+    m_impl
+    m_formal
+    m_asic
+    m_f4pga
+  }
+
+  # Images
+
+  { node [shape=cylinder]
+    "build/base"
+    "build/build"
+    "build/dev"
+    { node [color=limegreen, fontcolor=limegreen]
+      "apicula"
+      "arachne-pnr"
+      "ghdl"
+      "ghdl/llvm"
+      "gtkwave"
+      "icestorm"
+      "irsim"
+      "iverilog"
+      "klayout"
+      "magic"
+      "netgen"
+      "nextpnr/generic"
+      "nextpnr/ice40"
+      "nextpnr/nexus"
+      "nextpnr/ecp5"
+      "nextpnr"
+      "nvc"
+      "openfpgaloader"
+      "openroad"
+      "openroad/gui"
+      "prjoxide"
+      "prjtrellis"
+      "verible"
+      "verilator"
+      "vtr"
+      "xschem"
+      "xyce"
+      "yosys"
+    }
+    { node [color=mediumblue, fontcolor=mediumblue]
+      "pkg/apicula"
+      "pkg/arachne-pnr"
+      "pkg/boolector"
+      "pkg/cvc"
+      "pkg/ghdl"
+      "pkg/ghdl/llvm"
+      "pkg/ghdl-yosys-plugin"
+      "pkg/gtkwave"
+      "pkg/icestorm"
+      "pkg/irsim"
+      "pkg/iverilog"
+      "pkg/klayout"
+      "pkg/magic"
+      "pkg/netgen"
+      "pkg/nextpnr/ice40"
+      "pkg/nextpnr/nexus"
+      "pkg/nextpnr/ecp5"
+      "pkg/nextpnr/generic"
+      "pkg/nvc"
+      "pkg/openfpgaloader"
+      "pkg/openroad"
+      "pkg/openroad/gui"
+      "pkg/osvb"
+      "pkg/pono"
+      "pkg/prjoxide"
+      "pkg/prjtrellis"
+      "pkg/superprove"
+      "pkg/sby"
+      "pkg/yices2"
+      "pkg/yosys"
+      "pkg/verible"
+      "pkg/verilator"
+      "pkg/vtr"
+      "pkg/xschem"
+      "pkg/xyce"
+      "pkg/z3"
+    }
+    { node [color=brown, fontcolor=brown]
+      "ghdl/yosys"
+      "formal/min"
+      "formal"
+      "formal/all"
+      "nextpnr/icestorm"
+      "nextpnr/prjoxide"
+      "nextpnr/prjtrellis"
+      "impl"
+      "impl/ice40"
+      "impl/nexus"
+      "impl/ecp5"
+      "impl/icestorm"
+      "impl/prjoxide"
+      "impl/prjtrellis"
+      "impl/generic"
+      "impl/pnr"
+      "prog"
+      "sim"
+      "sim/osvb"
+      "sim/scipy-slim"
+      "sim/scipy"
+      "sim/octave-slim"
+      "sim/octave"
+      "sim/octave/gnuplot"
+      "conda"
+      "conda/f4pga/xc7/toolchain"
+      "conda/f4pga/xc7/a50t"
+      "conda/f4pga/xc7/a100t"
+      "conda/f4pga/xc7/a200t"
+      "conda/f4pga/xc7/z010"
+      "conda/f4pga/xc7/z020"
+      "conda/f4pga/xc7"
+      "conda/f4pga/eos-s3"
+      "magic/irsim"
+    }
+  }
+
+  # External images
+
+  { node [shape=cylinder, color=orange, fontcolor=orange] rank=same
+    "BASE IMAGE"
+    "scratch"
+    "ghdl/pkg:bullseye-mcode"
+    "ghdl/pkg:bullseye-llvm-9"
+  }
+
+  # Dependencies
+
+  "BASE IMAGE" -> m_base;
+
+  {
+    "scratch"
+    "ghdl/pkg:bullseye-mcode"
+    "ghdl/pkg:bullseye-llvm-9"
+    "build/base"
+    "build/build"
+  } -> m_synth;
+
+  {
+    "build/build"
+    "build/base"
+    "scratch"
+    "ghdl/llvm"
+  } -> m_sim;
+
+  {
+    "scratch"
+    "build/build"
+    "build/base"
+    "build/dev"
+    "ghdl/yosys"
+  } -> m_impl;
+
+  {
+    "scratch"
+    "build/base"
+    "build/build"
+    "ghdl/yosys"
+   } -> m_formal;
+
+  {
+    "scratch"
+    "build/dev"
+    "build/build"
+    "build/base"
+  } -> m_asic;
+
+  {
+    "build/base"
+  } -> m_f4pga;
+
+  # Generated images
+
+  subgraph cluster_base {
+    label = "Base";
+    m_base -> {
+      "build/base"
+      "build/build"
+      "build/dev"
+    } [style=dotted];
+  }
+
+  subgraph cluster_synth {
+    label = "Synth";
+    m_synth -> {
+      "ghdl"
+      "ghdl/llvm"
+      "pkg/ghdl"
+      "pkg/ghdl/llvm"
+      "pkg/ghdl-yosys-plugin"
+      "ghdl/yosys"
+      "pkg/yosys"
+      "yosys"
+    }
+  }
+
+  subgraph cluster_sim {
+    label = "Sim";
+    m_sim -> {
+      "gtkwave"
+      "iverilog"
+      "nvc"
+      "verilator"
+      "xschem"
+      "xyce"
+      "sim"
+      "sim/osvb"
+      "sim/scipy-slim"
+      "sim/scipy"
+      "sim/octave-slim"
+      "sim/octave"
+      "sim/octave/gnuplot"
+      "pkg/osvb"
+      "pkg/gtkwave"
+      "pkg/iverilog"
+      "pkg/nvc"
+      "pkg/verilator"
+      "pkg/xschem"
+      "pkg/xyce"
+    };
+  }
+
+  subgraph cluster_impl {
+    label = "Impl";
+    m_impl -> {
+      "apicula"
+      "pkg/apicula"
+      "arachne-pnr"
+      "pkg/arachne-pnr"
+      "icestorm"
+      "pkg/icestorm"
+      "prog"
+      "nextpnr/generic"
+      "nextpnr/ice40"
+      "nextpnr/icestorm"
+      "nextpnr/nexus"
+      "nextpnr/prjoxide"
+      "nextpnr/ecp5"
+      "nextpnr/prjtrellis"
+      "nextpnr"
+      "impl/ice40"
+      "impl/nexus"
+      "impl/ecp5"
+      "impl/icestorm"
+      "impl/prjoxide"
+      "impl/prjtrellis"
+      "impl/generic"
+      "impl/pnr"
+      "impl"
+      "pkg/nextpnr/generic"
+      "pkg/nextpnr/ice40"
+      "pkg/nextpnr/nexus"
+      "pkg/nextpnr/ecp5"
+      "openfpgaloader"
+      "pkg/openfpgaloader"
+      "prjoxide"
+      "pkg/prjoxide"
+      "prjtrellis"
+      "pkg/prjtrellis"
+      "vtr"
+      "pkg/vtr"
+    }
+  }
+
+  subgraph cluster_formal {
+    label = "Formal";
+    m_formal -> {
+      "pkg/sby"
+      "pkg/boolector"
+      "pkg/cvc"
+      "pkg/pono"
+      "pkg/superprove"
+      "pkg/yices2"
+      "pkg/z3"
+      "formal/min"
+      "formal"
+      "formal/all"
+    }
+  }
+
+  subgraph cluster_asic {
+    label = "ASIC";
+    m_asic -> {
+      "irsim"
+      "klayout"
+      "magic"
+      "magic/irsim"
+      "netgen"
+      "openroad"
+      "openroad/gui"
+      "pkg/irsim"
+      "pkg/klayout"
+      "pkg/magic"
+      "pkg/netgen"
+      "pkg/openroad"
+      "pkg/openroad/gui"
+    };
+  }
+
+  subgraph cluster_f4pga {
+    label = "F4PGA";
+    m_f4pga -> {
+      "conda"
+      "conda/f4pga/xc7/toolchain"
+      "conda/f4pga/xc7/a50t"
+      "conda/f4pga/xc7/a100t"
+      "conda/f4pga/xc7/a200t"
+      "conda/f4pga/xc7/z010"
+      "conda/f4pga/xc7/z020"
+      "conda/f4pga/xc7"
+      "conda/f4pga/eos-s3"
+      "verible"
+      "pkg/verible"
+    }
+  }
+
+}
+
+

Fig. 2 Subgraphs and images

+
+
+
+
# Authors:
+#   Unai Martinez-Corral
+#     <umartinezcorral@antmicro.com>
+#     <unai.martinezcorral@ehu.eus>
+#
+# Copyright Unai Martinez-Corral
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# SPDX-License-Identifier: Apache-2.0
+
+digraph G {
+
+  #splines=polyline; #curved
+  newrank=true;
+
+  # Dockerfiles
+
+  { node [shape=note, color=dodgerblue, fontcolor=dodgerblue]
+    d_base  [label="base"];
+  }
+
+  # Images
+
+  { node [shape=cylinder]
+    "build/base"
+    "build/build"
+    "build/dev"
+  }
+
+  # External images
+
+  { node [shape=cylinder, color=orange, fontcolor=orange]
+    "BASE IMAGE"
+  }
+
+  # Workflows
+
+  subgraph cluster_base {
+    { rank=same
+      node [shape=cylinder, color=grey, fontcolor=grey]
+      "p_base_debian" [label="BASE IMAGE"]
+    }
+
+    d_base -> {
+      "build/base",
+      "build/build",
+      "build/dev"
+    } [style=dotted];
+
+    { rank=same
+      node [shape=folder, color=red, fontcolor=red];
+      "t_build/base" [label="build--base"];
+      "t_build/build" [label="build--build"];
+      "t_build/dev" [label="build--dev"];
+    }
+
+    "build/base" -> "t_build/base";
+    "build/build" -> "t_build/build";
+    "build/dev" -> "t_build/dev";
+  }
+
+  # Dockerfile dependencies
+
+  "BASE IMAGE" -> "p_base_debian" -> d_base;
+
+  # Image dependencies
+
+  { edge [style=dashed]
+    "p_base_debian" -> "build/base" -> "build/build" -> "build/dev";
+  }
+
+}
+
+

Fig. 3 Base: workflows, dockerfiles, images and tests.

+
+
+
+
# Authors:
+#   Unai Martinez-Corral
+#     <umartinezcorral@antmicro.com>
+#     <unai.martinezcorral@ehu.eus>
+#
+# Copyright Unai Martinez-Corral
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# SPDX-License-Identifier: Apache-2.0
+
+digraph G {
+
+  #splines=polyline; #curved
+  newrank=true;
+
+  # Dockerfiles
+
+  { node [shape=note, color=dodgerblue, fontcolor=dodgerblue]
+    d_gtkwave   [label="gtkwave"];
+    d_iverilog  [label="iverilog"];
+    d_nvc       [label="nvc"];
+    d_verilator [label="verilator"];
+    d_sim       [label="sim"];
+    d_octave    [label="octave"];
+    d_gnuplot   [label="gnuplot"];
+    d_scipy     [label="scipy"];
+    d_osvb      [label="osvb"];
+    d_xschem    [label="xschem"];
+    d_xyce      [label="xyce"];
+  }
+
+  # Images
+
+  { node [shape=cylinder]
+    "build/build"
+    "build/base"
+    { node [color=limegreen, fontcolor=limegreen]
+      "ghdl/llvm"
+      "gtkwave"
+      "iverilog"
+      "nvc"
+      "verilator"
+      "xschem"
+      "xyce"
+    }
+    { node [color=mediumblue, fontcolor=mediumblue]
+      "pkg/gtkwave"
+      "pkg/iverilog"
+      "pkg/nvc"
+      "pkg/verilator"
+      "pkg/osvb"
+      "pkg/xschem"
+      "pkg/xyce"
+    }
+    { node [color=brown, fontcolor=brown]
+      "sim"
+      "sim/scipy-slim"
+      "sim/scipy"
+      "sim/octave-slim"
+      "sim/octave"
+      "sim/octave/gnuplot"
+      "sim/osvb"
+    }
+  }
+
+  # External images
+
+  { node [shape=cylinder, color=orange, fontcolor=orange]
+    "scratch"
+  }
+
+  { rank=same
+    "build/build"
+    "build/base"
+    "scratch"
+    "ghdl/llvm"
+  }
+
+  # Workflows
+
+  subgraph cluster_gtkwave {
+    { rank=same
+      node [shape=cylinder, color=grey, fontcolor=grey]
+      "p_gtkwave_build/build" [label="build/build"]
+      "p_gtkwave_build/base" [label="build/base"]
+      "p_gtkwave_scratch" [label="scratch"]
+    }
+
+    d_gtkwave -> {
+      "gtkwave"
+      "pkg/gtkwave"
+     } [style=dotted];
+
+    "t_gtkwave" [shape=folder, color=red, fontcolor=red, label="gtkwave"];
+    "t_pkg/gtkwave" [shape=folder, color=red, fontcolor=red, label="gtkwave.pkg"];
+
+    "gtkwave" -> "t_gtkwave";
+    "pkg/gtkwave" -> "t_pkg/gtkwave";
+  }
+
+  subgraph cluster_iverilog {
+    { rank=same
+      node [shape=cylinder, color=grey, fontcolor=grey]
+      "p_iverilog_build/build" [label="build/build"]
+      "p_iverilog_build/base" [label="build/base"]
+      "p_iverilog_scratch" [label="scratch"]
+    }
+
+    d_iverilog -> {
+      "iverilog"
+      "pkg/iverilog"
+    } [style=dotted];
+
+    {
+      node [shape=folder, color=red, fontcolor=red]
+      "t_iverilog" [label="iverilog"];
+      "t_pkg/iverilog" [label="iverilog.pkg"];
+    }
+
+    "iverilog" -> "t_iverilog";
+    "pkg/iverilog" -> "t_pkg/iverilog";
+  }
+
+  subgraph cluster_nvc {
+    { rank=same
+      node [shape=cylinder, color=grey, fontcolor=grey]
+      "p_nvc_build/build" [label="build/build"]
+      "p_nvc_build/base" [label="build/base"]
+      "p_nvc_scratch" [label="scratch"]
+    }
+
+    d_nvc -> {
+      "nvc"
+      "pkg/nvc"
+     } [style=dotted];
+
+    "t_nvc" [shape=folder, color=red, fontcolor=red, label="nvc"];
+    "t_pkg/nvc" [shape=folder, color=red, fontcolor=red, label="nvc.pkg"];
+
+    "nvc" -> "t_nvc";
+    "pkg/nvc" -> "t_pkg/nvc";
+  }
+
+  subgraph cluster_verilator {
+    { rank=same
+      node [shape=cylinder, color=grey, fontcolor=grey]
+      "p_verilator_build/build" [label="build/build"]
+      "p_verilator_build/base" [label="build/base"]
+      "p_verilator_scratch" [label="scratch"]
+    }
+
+    d_verilator -> {
+      "verilator"
+      "pkg/verilator"
+    } [style=dotted];
+
+    {
+      node [shape=folder, color=red, fontcolor=red]
+      "t_verilator" [label="verilator"];
+      "t_pkg/verilator" [label="verilator.pkg"];
+    }
+
+    "verilator" -> "t_verilator";
+    "pkg/verilator" -> "t_pkg/verilator";
+  }
+
+  subgraph cluster_sim {
+    { rank=same
+      node [shape=cylinder, color=grey, fontcolor=grey]
+      "p_sim_ghdl/llvm" [label="ghdl/llvm"]
+      "p_sim_pkg/nvc" [label="pkg/nvc"]
+      "p_sim_pkg/verilator" [label="pkg/verilator"]
+      "p_sim_pkg/iverilog" [label="pkg/iverilog"]
+    }
+
+    d_sim -> "sim" [style=dotted];
+
+    "sim" -> {
+      d_osvb;
+      d_scipy;
+      d_octave;
+    };
+
+    d_osvb -> {
+      "pkg/osvb"
+      "sim/osvb"
+      "sim/scipy"
+      "sim/octave"
+    } [style=dotted];
+
+    d_scipy -> "sim/scipy-slim" [style=dotted];
+    d_octave -> "sim/octave-slim" [style=dotted];
+    d_gnuplot -> "sim/octave/gnuplot" [style=dotted];
+
+    { rank=same
+      node [shape=folder, color=red, fontcolor=red]
+      "t_sim"                [label="sim"];
+      "t_pkg/osvb"           [label="osvb.pkg"];
+      "t_sim/osvb"           [label="sim--osvb"];
+      "t_sim/scipy-slim"     [label="sim--scipy-slim"];
+      "t_sim/scipy"          [label="sim--scipy"];
+      "t_sim/octave-slim"    [label="sim--octave-slim"];
+      "t_sim/octave"         [label="sim--octave"];
+      "t_sim/octave/gnuplot" [label="sim--octave--gnuplot"];
+    }
+
+    "sim" -> "t_sim";
+    "pkg/osvb" -> "t_pkg/osvb";
+    "sim/osvb" -> "t_sim/osvb";
+    "sim/scipy-slim" -> "t_sim/scipy-slim";
+    "sim/scipy" -> "t_sim/scipy";
+    "sim/octave-slim" -> "t_sim/octave-slim";
+    "sim/octave" -> "t_sim/octave";
+    "sim/octave/gnuplot" -> "t_sim/octave/gnuplot";
+  }
+
+  subgraph cluster_xschem {
+    { rank=same
+      node [shape=cylinder, color=grey, fontcolor=grey]
+      "p_xschem_build/build" [label="build/build"]
+      "p_xschem_build/base" [label="build/base"]
+      "p_xschem_scratch" [label="scratch"]
+    }
+
+    d_xschem -> {
+      "xschem"
+      "pkg/xschem"
+    } [style=dotted];
+
+    {
+      node [shape=folder, color=red, fontcolor=red]
+      "t_xschem" [label="xschem"];
+      "t_pkg/xschem" [label="xschem.pkg"];
+    }
+
+    "xschem" -> "t_xschem";
+    "pkg/xschem" -> "t_pkg/xschem";
+  }
+
+  subgraph cluster_xyce {
+    { rank=same
+      node [shape=cylinder, color=grey, fontcolor=grey]
+      "p_xyce_build/build" [label="build/build"]
+      "p_xyce_build/base" [label="build/base"]
+      "p_xyce_scratch" [label="scratch"]
+    }
+
+    d_xyce -> {
+      "xyce"
+      "pkg/xyce"
+    } [style=dotted];
+
+    {
+      node [shape=folder, color=red, fontcolor=red]
+      "t_xyce" [label="xyce"];
+      "t_pkg/xyce" [label="xyce.pkg"];
+    }
+
+    "xyce" -> "t_xyce";
+    "pkg/xyce" -> "t_pkg/xyce";
+  }
+
+  # Dockerfile dependencies
+
+  "build/build" -> "p_gtkwave_build/build" -> d_gtkwave;
+  "build/base" -> "p_gtkwave_build/base" -> d_gtkwave;
+  "scratch" -> "p_gtkwave_scratch" -> d_gtkwave;
+
+  "build/build" -> "p_iverilog_build/build" -> d_iverilog;
+  "build/base" -> "p_iverilog_build/base" -> d_iverilog;
+  "scratch" -> "p_iverilog_scratch" -> d_iverilog;
+
+  "build/build" -> "p_nvc_build/build" -> d_nvc;
+  "build/base" -> "p_nvc_build/base" -> d_nvc;
+  "scratch" -> "p_nvc_scratch" -> d_nvc;
+
+  "build/build" -> "p_verilator_build/build" -> d_verilator;
+  "build/base" -> "p_verilator_build/base" -> d_verilator;
+  "scratch" -> "p_verilator_scratch" -> d_verilator;
+
+  "build/build" -> "p_xschem_build/build" -> d_xschem;
+  "build/base" -> "p_xschem_build/base" -> d_xschem;
+  "scratch" -> "p_xschem_scratch" -> d_xschem;
+
+  "build/build" -> "p_xyce_build/build" -> d_xyce;
+  "build/base" -> "p_xyce_build/base" -> d_xyce;
+  "scratch" -> "p_xyce_scratch" -> d_xyce;
+
+  "ghdl/llvm" -> "p_sim_ghdl/llvm" -> d_sim;
+  "pkg/nvc" -> "p_sim_pkg/nvc" -> d_sim;
+  "pkg/verilator" -> "p_sim_pkg/verilator" -> d_sim;
+  "pkg/iverilog" -> "p_sim_pkg/iverilog" -> d_sim;
+
+   {
+     "sim/scipy-slim"
+     "sim/octave-slim"
+   } -> d_osvb;
+
+   "sim/octave" -> d_gnuplot;
+
+  # Image dependencies
+
+  { edge [style=dashed]
+    "p_gtkwave_build/base" -> "gtkwave";
+    "p_gtkwave_scratch" -> "pkg/gtkwave";
+
+    "p_iverilog_build/base" -> "iverilog";
+    "p_iverilog_scratch" -> "pkg/iverilog";
+
+    "p_nvc_build/base" -> "nvc";
+    "p_nvc_scratch" -> "pkg/nvc";
+
+    "p_verilator_build/base" -> "verilator";
+    "p_verilator_scratch" -> "pkg/verilator";
+
+    "p_xschem_build/base" -> "xschem";
+    "p_xschem_scratch" -> "pkg/xschem";
+
+    "p_xyce_build/base" -> "xyce";
+    "p_xyce_scratch" -> "pkg/xyce";
+
+    "p_sim_ghdl/llvm" -> "sim" -> {
+      "sim/osvb"
+      "sim/scipy-slim"
+      "sim/octave-slim"
+    };
+
+    "sim/scipy-slim" -> "sim/scipy";
+    "sim/octave-slim" -> "sim/octave" -> "sim/octave/gnuplot";
+  }
+
+  { edge [style=dashed, color=grey]
+    "p_sim_pkg/nvc" -> "sim";
+    "p_sim_pkg/verilator" -> "sim";
+    "p_sim_pkg/iverilog" -> "sim";
+  }
+
+}
+
+

Fig. 4 Sim: workflows, dockerfiles, images and tests.

+
+
+
+
# Authors:
+#   Unai Martinez-Corral
+#     <umartinezcorral@antmicro.com>
+#     <unai.martinezcorral@ehu.eus>
+#
+# Copyright Unai Martinez-Corral
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# SPDX-License-Identifier: Apache-2.0
+
+digraph G {
+
+  #splines=polyline; #curved
+  newrank=true;
+
+  # Dockerfiles
+
+  { node [shape=note, color=dodgerblue, fontcolor=dodgerblue]
+    d_ghdl             [label="ghdl"];
+    d_ghdlYosysPlugin  [label="ghdl-yosys-plugin"];
+    d_yosys            [label="yosys"];
+  }
+
+  # Images
+
+  { node [shape=cylinder]
+    "build/base"
+    "build/build"
+    { node [color=limegreen, fontcolor=limegreen]
+      "ghdl"
+      "ghdl/llvm"
+      "ghdl/yosys"
+      "yosys"
+    }
+    { node [color=mediumblue, fontcolor=mediumblue]
+      "pkg/ghdl"
+      "pkg/ghdl/llvm"
+      "pkg/ghdl-yosys-plugin"
+      "pkg/yosys"
+    }
+  }
+
+  # External images
+
+  { node [shape=cylinder, color=orange, fontcolor=orange]
+    "scratch"
+    "ghdl/pkg:bullseye-mcode"
+    "ghdl/pkg:bullseye-llvm-9";
+  }
+
+  { rank=same
+    "build/base"
+    "build/build"
+    "scratch"
+    "ghdl/pkg:bullseye-mcode"
+    "ghdl/pkg:bullseye-llvm-9"
+  }
+
+  # Workflows
+
+  subgraph cluster_ghdl {
+    { rank=same
+      node [shape=cylinder, color=grey, fontcolor=grey]
+      "p_ghdl_build/base" [label="build/base"]
+      "p_ghdl_scratch" [label="scratch"]
+      "p_ghdl_bullseye" [label="ghdl/pkg:bullseye-mcode"]
+      "p_ghdl_bullseye-llvm" [label="ghdl/pkg:bullseye-llvm-9"]
+    }
+
+    d_ghdl -> { rank=same
+      "ghdl",
+      "ghdl/llvm",
+      "pkg/ghdl",
+      "pkg/ghdl/llvm"
+    } [style=dotted];
+
+    { rank=same
+      node [shape=folder, color=red, fontcolor=red];
+      "t_ghdl" [label="ghdl"];
+      "t_ghdl/llvm" [label="ghdl--llvm"];
+      "t_pkg/ghdl" [label="ghdl.pkg"];
+      "t_pkg/ghdl/llvm" [label="ghdl--llvm.pkg"];
+    }
+
+    "ghdl" -> "t_ghdl";
+    "ghdl/llvm" -> "t_ghdl/llvm";
+    "pkg/ghdl" -> "t_pkg/ghdl";
+    "pkg/ghdl/llvm" -> "t_pkg/ghdl/llvm";
+  }
+
+  subgraph cluster_ghdlYosysPlugin {
+    { rank=same
+      node [shape=cylinder, color=grey, fontcolor=grey]
+      "p_ghdl-yosys-plugin_yosys" [label="yosys"]
+      "p_ghdl-yosys-plugin_pkg/ghdl" [label="pkg/ghdl"]
+    }
+
+    d_ghdlYosysPlugin -> { rank=same
+      "pkg/ghdl-yosys-plugin",
+      "ghdl/yosys"
+    } [style=dotted];
+
+    { rank=same
+      node [shape=folder, color=red, fontcolor=red];
+      "t_pkg/ghdl-yosys-plugin" [label="ghdl-yosys-plugin.pkg"];
+      "t_ghdl/yosys" [label="ghdl--yosys"];
+    }
+
+    "pkg/ghdl-yosys-plugin" -> "t_pkg/ghdl-yosys-plugin";
+    "ghdl/yosys" -> "t_ghdl/yosys";
+  }
+
+  subgraph cluster_yosys {
+    { rank=same
+      node [shape=cylinder, color=grey, fontcolor=grey]
+      "p_yosys_build/build" [label="build/build"]
+      "p_yosys_scratch" [label="scratch"]
+    }
+
+    d_yosys -> { rank=same
+      "pkg/yosys",
+      "yosys"
+    } [style=dotted];
+
+    { rank=same
+      node [shape=folder, color=red, fontcolor=red];
+      "t_yosys" [label="yosys"];
+      "t_pkg/yosys" [label="yosys.pkg"];
+    }
+
+    "yosys" -> "t_yosys";
+    "pkg/yosys" -> "t_pkg/yosys";
+  }
+
+  { rank=same
+    d_ghdl
+    d_yosys
+  }
+
+  # Dockerfile dependencies
+
+  "scratch" -> "p_ghdl_scratch" -> d_ghdl;
+  "ghdl/pkg:bullseye-mcode" -> "p_ghdl_bullseye" -> d_ghdl;
+  "ghdl/pkg:bullseye-llvm-9" -> "p_ghdl_bullseye-llvm" -> d_ghdl;
+  "build/base" -> "p_ghdl_build/base" -> d_ghdl;
+
+  "pkg/ghdl" -> "p_ghdl-yosys-plugin_pkg/ghdl" -> d_ghdlYosysPlugin;
+  "yosys" -> "p_ghdl-yosys-plugin_yosys" -> d_ghdlYosysPlugin;
+
+  "build/build" -> "p_yosys_build/build" -> d_yosys;
+  "scratch" -> "p_yosys_scratch" -> d_yosys;
+
+  # Image dependencies
+
+  { edge [style=dashed]
+    "p_ghdl_scratch" -> { "pkg/ghdl", "pkg/ghdl/llvm" };
+    "p_ghdl_build/base" -> { "ghdl", "ghdl/llvm" };
+
+    "p_yosys_scratch" -> "pkg/yosys";
+    "p_yosys_build/build" -> "yosys";
+
+    "p_ghdl-yosys-plugin_yosys" -> "ghdl/yosys";
+    "p_ghdl-yosys-plugin_pkg/ghdl" -> "pkg/ghdl-yosys-plugin";
+  }
+
+  { edge [style=dashed, color=grey]
+    "p_ghdl_bullseye" -> {
+      "ghdl",
+      "pkg/ghdl"
+    };
+    "p_ghdl_bullseye-llvm" -> {
+      "ghdl/llvm",
+      "pkg/ghdl/llvm"
+    };
+  }
+
+}
+
+

Fig. 5 Synth: workflows, dockerfiles, images and tests.

+
+
+
+
# Authors:
+#   Unai Martinez-Corral
+#     <umartinezcorral@antmicro.com>
+#     <unai.martinezcorral@ehu.eus>
+#
+# Copyright Unai Martinez-Corral
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# SPDX-License-Identifier: Apache-2.0
+
+digraph G {
+
+  #splines=polyline; #curved
+  newrank=true;
+
+  # Dockerfiles
+
+  { node [shape=note, color=dodgerblue, fontcolor=dodgerblue]
+    d_apicula        [label="apicula"];
+    d_arachnepnr     [label="arachne-pnr"];
+    d_icestorm       [label="icestorm"];
+    d_impl           [label="impl"];
+    d_nextpnr        [label="nextpnr"];
+    d_openfpgaloader [label="openfpgaloader"];
+    d_prjoxide       [label="prjoxide"];
+    d_prjtrellis     [label="prjtrellis"];
+    d_prog           [label="prog"];
+    d_vtr            [label="vtr"];
+  }
+
+  # Images
+
+  { node [shape=cylinder]
+    "build/base"
+    "build/build"
+    "build/dev"
+    { node [color=limegreen, fontcolor=limegreen]
+      "apicula"
+      "arachne-pnr"
+      "ghdl/yosys"
+      "icestorm"
+      "nextpnr/ice40"
+      "nextpnr/nexus"
+      "nextpnr/ecp5"
+      "nextpnr/generic"
+      "nextpnr"
+      "openfpgaloader"
+      "prjoxide"
+      "prjtrellis"
+      "vtr"
+    }
+    { node [color=mediumblue, fontcolor=mediumblue]
+      "pkg/apicula"
+      "pkg/arachne-pnr"
+      "pkg/icestorm"
+      "pkg/nextpnr/generic"
+      "pkg/nextpnr/ice40"
+      "pkg/nextpnr/nexus"
+      "pkg/nextpnr/ecp5"
+      "pkg/openfpgaloader"
+      "pkg/prjoxide"
+      "pkg/prjtrellis"
+      "pkg/vtr"
+    }
+    { node [color=brown, fontcolor=brown]
+      "nextpnr/icestorm"
+      "nextpnr/prjoxide"
+      "nextpnr/prjtrellis"
+      "impl/generic"
+      "impl/ice40"
+      "impl/nexus"
+      "impl/ecp5"
+      "impl/icestorm"
+      "impl/prjoxide"
+      "impl/prjtrellis"
+      "impl/pnr"
+      "impl"
+      "prog"
+    }
+  }
+
+  # External images
+
+  { node [shape=cylinder, color=orange, fontcolor=orange]
+    "scratch"
+  }
+
+  { rank=same
+    "build/base"
+    "build/build"
+    "build/dev"
+    "ghdl/yosys"
+    "scratch"
+  }
+
+  # Workflows
+
+  subgraph cluster_apicula {
+    { rank=same
+      node [shape=cylinder, color=grey, fontcolor=grey]
+      "p_apicula_build/build"  [label="build/build"]
+      "p_apicula_build/base"   [label="build/base"]
+      "p_apicula_scratch"      [label="scratch"]
+    }
+
+    d_apicula -> {
+      "apicula"
+      "pkg/apicula"
+     } [style=dotted];
+
+    { rank=same
+      node [shape=folder, color=red, fontcolor=red]
+      "t_apicula"     [label="apicula"];
+      "t_pkg/apicula" [label="apicula.pkg"];
+    }
+
+    "apicula" -> "t_apicula";
+    "pkg/apicula" -> "t_pkg/apicula";
+  }
+
+  subgraph cluster_arachepnr {
+    { rank=same
+      node [shape=cylinder, color=grey, fontcolor=grey]
+      "p_arachnepnr_pkg/icestorm" [label="pkg/icestorm"]
+      "p_arachnepnr_build/build"  [label="build/build"]
+      "p_arachnepnr_build/base"   [label="build/base"]
+      "p_arachnepnr_scratch"      [label="scratch"]
+    }
+
+    d_arachnepnr -> {
+      "arachne-pnr"
+      "pkg/arachne-pnr"
+     } [style=dotted];
+
+    { rank=same
+      node [shape=folder, color=red, fontcolor=red]
+      "t_arachne-pnr"     [label="arachne-pnr"];
+      "t_pkg/arachne-pnr" [label="arachne-pnr.pkg"];
+    }
+
+    "arachne-pnr" -> "t_arachne-pnr";
+    "pkg/arachne-pnr" -> "t_pkg/arachne-pnr";
+  }
+
+  subgraph cluster_icestorm {
+    { rank=same
+      node [shape=cylinder, color=grey, fontcolor=grey]
+      "p_icestorm_scratch"     [label="scratch"]
+      "p_icestorm_build/base"  [label="build/base"]
+      "p_icestorm_build/build" [label="build/build"]
+    }
+
+    d_icestorm -> { rank=same
+      "pkg/icestorm",
+      "icestorm"
+    } [style=dotted];
+
+    { rank=same
+      node [shape=folder, color=red, fontcolor=red];
+      "t_icestorm"     [label="icestorm"];
+      "t_pkg/icestorm" [label="icestorm.pkg"];
+    }
+
+    "icestorm" -> "t_icestorm";
+    "pkg/icestorm" -> "t_pkg/icestorm";
+  }
+
+  subgraph cluster_impl {
+    { rank=same
+      node [shape=cylinder, color=grey, fontcolor=grey]
+      "p_impl_ghdl/yosys"           [label="ghdl/yosys"]
+      "p_impl_pkg/nextpnr/generic"  [label="pkg/nextpnr/generic"]
+      "p_impl_pkg/nextpnr/ice40"    [label="pkg/nextpnr/ice40"]
+      "p_impl_pkg/nextpnr/nexus"    [label="pkg/nextpnr/nexus"]
+      "p_impl_pkg/nextpnr/ecp5"     [label="pkg/nextpnr/ecp5"]
+      "p_impl_pkg/icestorm"         [label="pkg/icestorm"]
+      "p_impl_pkg/prjoxide"         [label="pkg/prjoxide"]
+      "p_impl_pkg/prjtrellis"       [label="pkg/prjtrellis"]
+    }
+
+    { node [shape=cylinder]
+      "build/impl"
+    }
+
+    d_impl -> {
+      "build/impl"
+      "impl/generic"
+      "impl/ice40"
+      "impl/nexus"
+      "impl/ecp5"
+      "impl/icestorm"
+      "impl/prjoxide"
+      "impl/prjtrellis"
+      "impl/pnr"
+      "impl"
+    } [style=dotted];
+
+    { rank=same
+      node [shape=folder, color=red, fontcolor=red];
+      "t_impl/generic"    [label="impl--generic"];
+      "t_impl/ice40"      [label="impl--ice40"];
+      "t_impl/nexus"      [label="impl--nexus"];
+      "t_impl/ecp5"       [label="impl--ecp5"];
+      "t_impl/icestorm"   [label="impl--icestorm"];
+      "t_impl/prjoxide"   [label="impl--prjoxide"];
+      "t_impl/prjtrellis" [label="impl--prjtrellis"];
+      "t_impl/pnr"        [label="impl--pnr"];
+      "t_impl"            [label="impl"];
+    }
+
+    "impl/generic" -> "t_impl/generic";
+    "impl/ice40" -> "t_impl/ice40";
+    "impl/nexus" -> "t_impl/nexus";
+    "impl/ecp5" -> "t_impl/ecp5";
+    "impl/icestorm" -> "t_impl/icestorm";
+    "impl/prjoxide" -> "t_impl/prjoxide";
+    "impl/prjtrellis" -> "t_impl/prjtrellis";
+    "impl/pnr" -> "t_impl/pnr";
+    "impl" -> "t_impl";
+  }
+
+  subgraph cluster_nextpnr {
+    { rank=same
+      node [shape=cylinder, color=grey, fontcolor=grey]
+      "p_nextpnr_scratch"    [label="scratch"]
+      "p_nextpnr_build/base" [label="build/base"]
+      "p_nextpnr_build/dev"  [label="build/dev"]
+      "p_nextpnr_icestorm"   [label="pkg/icestorm"]
+      "p_nextpnr_prjoxide"   [label="pkg/prjoxide"]
+      "p_nextpnr_prjtrellis" [label="pkg/prjtrellis"]
+    }
+
+    { node [shape=cylinder]
+      "build/nextpnr/base"
+      "build/nextpnr/build"
+    }
+
+    d_nextpnr -> { rank=same
+      "build/nextpnr/base"
+      "build/nextpnr/build"
+    } [style=dotted];
+
+    d_nextpnr -> { rank=same
+      "nextpnr/generic",
+      "nextpnr/ice40",
+      "nextpnr/nexus",
+      "nextpnr/ecp5",
+      "nextpnr"
+    } [style=dotted];
+
+    d_nextpnr -> { rank=same
+      "nextpnr/icestorm",
+      "nextpnr/prjoxide"
+      "nextpnr/prjtrellis"
+    } [style=dotted];
+
+    d_nextpnr -> { rank=same
+      "pkg/nextpnr/generic",
+      "pkg/nextpnr/ice40",
+      "pkg/nextpnr/nexus",
+      "pkg/nextpnr/ecp5"
+    } [style=dotted];
+
+    { rank=same
+      node [shape=folder, color=red, fontcolor=red];
+      "t_nextpnr"             [label="nextpnr"];
+      "t_nextpnr/generic"     [label="nextpnr--generic"];
+      "t_nextpnr/ice40"       [label="nextpnr--ice40"];
+      "t_nextpnr/nexus"       [label="nextpnr--nexus"];
+      "t_nextpnr/ecp5"        [label="nextpnr--ecp5"];
+      "t_nextpnr/icestorm"    [label="nextpnr--icestorm"];
+      "t_nextpnr/prjoxide"    [label="nextpnr--prjoxide"];
+      "t_nextpnr/prjtrellis"  [label="nextpnr--prjtrellis"];
+      "t_pkg/nextpnr/generic" [label="nextpnr--generic.pkg"];
+      "t_pkg/nextpnr/ice40"   [label="nextpnr--ice40.pkg"];
+      "t_pkg/nextpnr/nexus"   [label="nextpnr--nexus.pkg"];
+      "t_pkg/nextpnr/ecp5"    [label="nextpnr--ecp5.pkg"];
+    }
+
+    "nextpnr/generic"     -> "t_nextpnr/generic";
+    "nextpnr/ice40"       -> "t_nextpnr/ice40";
+    "nextpnr/nexus"       -> "t_nextpnr/nexus";
+    "nextpnr/ecp5"        -> "t_nextpnr/ecp5";
+    "nextpnr"             -> "t_nextpnr";
+    "nextpnr/icestorm"    -> "t_nextpnr/icestorm";
+    "nextpnr/prjoxide"    -> "t_nextpnr/prjoxide";
+    "nextpnr/prjtrellis"  -> "t_nextpnr/prjtrellis";
+    "pkg/nextpnr/generic" -> "t_pkg/nextpnr/generic";
+    "pkg/nextpnr/ice40"   -> "t_pkg/nextpnr/ice40";
+    "pkg/nextpnr/nexus"   -> "t_pkg/nextpnr/nexus";
+    "pkg/nextpnr/ecp5"    -> "t_pkg/nextpnr/ecp5";
+  }
+
+  subgraph cluster_openfpgaloader {
+    { rank=same
+      node [shape=cylinder, color=grey, fontcolor=grey]
+      "p_openfpgaloader_build/build" [label="build/build"]
+      "p_openfpgaloader_build/base" [label="build/base"]
+      "p_openfpgaloader_scratch" [label="scratch"]
+    }
+
+    d_openfpgaloader -> {
+      "openfpgaloader"
+      "pkg/openfpgaloader"
+    } [style=dotted];
+
+    {
+      node [shape=folder, color=red, fontcolor=red]
+      "t_openfpgaloader" [label="openfpgaloader"];
+      "t_pkg/openfpgaloader" [label="openfpgaloader.pkg"];
+    }
+
+    "openfpgaloader" -> "t_openfpgaloader";
+    "pkg/openfpgaloader" -> "t_pkg/openfpgaloader";
+  }
+
+  subgraph cluster_prjoxide {
+    { rank=same
+      node [shape=cylinder, color=grey, fontcolor=grey]
+      "p_prjoxide_scratch" [label="scratch"]
+      "p_prjoxide_build/base" [label="build/base"]
+      "p_prjoxide_build/build" [label="build/build"]
+    }
+
+    d_prjoxide -> { rank=same
+      "pkg/prjoxide",
+      "prjoxide"
+    } [style=dotted];
+
+    { rank=same
+      node [shape=folder, color=red, fontcolor=red];
+      "t_prjoxide" [label="prjoxide"];
+      "t_pkg/prjoxide" [label="prjoxide.pkg"];
+    }
+
+    "prjoxide" -> "t_prjoxide";
+    "pkg/prjoxide" -> "t_pkg/prjoxide";
+  }
+
+  subgraph cluster_prjtrellis {
+    { rank=same
+      node [shape=cylinder, color=grey, fontcolor=grey]
+      "p_prjtrellis_scratch" [label="scratch"]
+      "p_prjtrellis_build/base" [label="build/base"]
+      "p_prjtrellis_build/dev" [label="build/dev"]
+    }
+
+    d_prjtrellis -> { rank=same
+      "pkg/prjtrellis",
+      "prjtrellis"
+    } [style=dotted];
+
+    { rank=same
+      node [shape=folder, color=red, fontcolor=red];
+      "t_prjtrellis" [label="prjtrellis"];
+      "t_pkg/prjtrellis" [label="prjtrellis.pkg"];
+    }
+
+    "prjtrellis" -> "t_prjtrellis";
+    "pkg/prjtrellis" -> "t_pkg/prjtrellis";
+  }
+
+  subgraph cluster_prog {
+    { rank=same
+      node [shape=cylinder, color=grey, fontcolor=grey]
+      "p_prog_icestorm" [label="pkg/icestorm"]
+      "p_prog_build/base" [label="build/base"]
+    }
+
+    d_prog -> "prog" [style=dotted];
+
+    "t_prog" [shape=folder, color=red, fontcolor=red, label="prog"];
+
+    "prog" -> "t_prog";
+  }
+
+  subgraph cluster_vtr {
+    { rank=same
+      node [shape=cylinder, color=grey, fontcolor=grey]
+      "p_vtr_build/dev"    [label="build/dev"]
+      "p_vtr_build/base"   [label="build/base"]
+      "p_vtr_scratch"      [label="scratch"]
+    }
+
+    d_vtr -> {
+      "vtr"
+      "pkg/vtr"
+     } [style=dotted];
+
+    { rank=same
+      node [shape=folder, color=red, fontcolor=red]
+      "t_vtr"     [label="vtr"];
+      "t_pkg/vtr" [label="vtr.pkg"];
+    }
+
+    "vtr" -> "t_vtr";
+    "pkg/vtr" -> "t_pkg/vtr";
+  }
+
+  { rank=same
+    d_icestorm
+    d_prjtrellis
+  }
+
+  { rank=same
+    d_nextpnr
+    d_prog
+  }
+
+  # Dockerfile dependencies
+
+  "build/build" -> "p_apicula_build/build" -> d_apicula;
+  "build/base" -> "p_apicula_build/base" -> d_apicula;
+  "scratch" -> "p_apicula_scratch" -> d_apicula;
+
+  "build/build" -> "p_arachnepnr_build/build" -> d_arachnepnr;
+  "build/base" -> "p_arachnepnr_build/base" -> d_arachnepnr;
+  "scratch" -> "p_arachnepnr_scratch" -> d_arachnepnr;
+  "pkg/icestorm" -> "p_arachnepnr_pkg/icestorm" -> d_arachnepnr;
+
+  "build/build" -> "p_icestorm_build/build" -> d_icestorm;
+  "build/base" -> "p_icestorm_build/base" -> d_icestorm;
+  "scratch" -> "p_icestorm_scratch" -> d_icestorm;
+
+  "ghdl/yosys" -> "p_impl_ghdl/yosys" -> d_impl;
+  "pkg/nextpnr/generic" -> "p_impl_pkg/nextpnr/generic" -> d_impl;
+  "pkg/nextpnr/ice40" -> "p_impl_pkg/nextpnr/ice40" -> d_impl;
+  "pkg/nextpnr/nexus" -> "p_impl_pkg/nextpnr/nexus" -> d_impl;
+  "pkg/nextpnr/ecp5" -> "p_impl_pkg/nextpnr/ecp5" -> d_impl;
+  "pkg/icestorm" -> "p_impl_pkg/icestorm" -> d_impl;
+  "pkg/prjoxide" -> "p_impl_pkg/prjoxide" -> d_impl;
+  "pkg/prjtrellis" -> "p_impl_pkg/prjtrellis" -> d_impl;
+
+  "scratch" -> "p_nextpnr_scratch" -> d_nextpnr;
+  "build/dev" -> "p_nextpnr_build/dev" -> d_nextpnr;
+  "build/base" -> "p_nextpnr_build/base" -> d_nextpnr;
+  "pkg/icestorm" -> "p_nextpnr_icestorm" -> d_nextpnr;
+  "pkg/prjoxide" -> "p_nextpnr_prjoxide" -> d_nextpnr;
+  "pkg/prjtrellis" -> "p_nextpnr_prjtrellis" -> d_nextpnr;
+
+  "build/build" -> "p_openfpgaloader_build/build" -> d_openfpgaloader;
+  "build/base" -> "p_openfpgaloader_build/base" -> d_openfpgaloader;
+  "scratch" -> "p_openfpgaloader_scratch" -> d_openfpgaloader;
+
+  "build/build" -> "p_prjoxide_build/build" -> d_prjoxide;
+  "build/base" -> "p_prjoxide_build/base" -> d_prjoxide;
+  "scratch" -> "p_prjoxide_scratch" -> d_prjoxide;
+
+  "build/dev" -> "p_prjtrellis_build/dev" -> d_prjtrellis;
+  "build/base" -> "p_prjtrellis_build/base" -> d_prjtrellis;
+  "scratch" -> "p_prjtrellis_scratch" -> d_prjtrellis;
+
+  "build/base" -> "p_prog_build/base" -> d_prog;
+  "pkg/icestorm" -> "p_prog_icestorm" -> d_prog;
+
+  "build/dev" -> "p_vtr_build/dev" -> d_vtr;
+  "build/base" -> "p_vtr_build/base" -> d_vtr;
+  "scratch" -> "p_vtr_scratch" -> d_vtr;
+
+  # Image dependencies
+
+  { edge [style=dashed]
+    "p_apicula_build/base" -> "apicula";
+    "p_apicula_scratch" -> "pkg/apicula";
+
+    "p_arachnepnr_build/base" -> "arachne-pnr";
+    "p_arachnepnr_scratch" -> "pkg/arachne-pnr";
+
+    "p_prog_build/base" -> "prog";
+
+    "p_openfpgaloader_build/base" -> "openfpgaloader";
+    "p_openfpgaloader_scratch" -> "pkg/openfpgaloader";
+
+    "p_nextpnr_build/base" -> "build/nextpnr/base" -> {
+      "nextpnr",
+      "nextpnr/generic",
+      "nextpnr/nexus",
+      "nextpnr/ice40",
+      "nextpnr/ecp5"
+    };
+
+    "p_nextpnr_scratch" -> {
+      "pkg/nextpnr/generic",
+      "pkg/nextpnr/ice40",
+      "pkg/nextpnr/nexus",
+      "pkg/nextpnr/ecp5"
+    };
+
+    "nextpnr/ice40" -> "nextpnr/icestorm";
+    "nextpnr/nexus" -> "nextpnr/prjoxide";
+    "nextpnr/ecp5" -> "nextpnr/prjtrellis";
+
+    "p_icestorm_build/base" -> "icestorm";
+    "p_icestorm_scratch" -> "pkg/icestorm";
+
+    "p_impl_ghdl/yosys" -> "build/impl" -> {
+      "impl/generic"
+      "impl/ice40"
+      "impl/nexus"
+      "impl/ecp5"
+      "impl/pnr"
+    };
+
+    "impl/ice40" -> "impl/icestorm";
+    "impl/nexus" -> "impl/prjoxide";
+    "impl/ecp5" -> "impl/prjtrellis";
+    "impl/pnr" -> "impl";
+
+    "p_prjoxide_scratch" -> "pkg/prjoxide";
+    "p_prjoxide_build/base" -> "prjoxide";
+
+    "p_prjtrellis_scratch" -> "pkg/prjtrellis";
+    "p_prjtrellis_build/base" -> "prjtrellis";
+
+    "p_vtr_build/base" -> "vtr";
+    "p_vtr_scratch" -> "pkg/vtr";
+  }
+
+  { edge [style=dashed, color=grey]
+    "p_prog_icestorm" -> "prog";
+
+    {
+      "pkg/nextpnr/ice40"
+      "pkg/nextpnr/nexus"
+      "pkg/nextpnr/ecp5"
+    } -> "nextpnr";
+    "p_nextpnr_icestorm"   -> "nextpnr/icestorm";
+    "p_nextpnr_prjoxide"   -> "nextpnr/prjoxide";
+    "p_nextpnr_prjtrellis" -> "nextpnr/prjtrellis";
+
+    "p_impl_pkg/icestorm"        -> { "impl/icestorm", "impl" };
+    "p_impl_pkg/prjoxide"        -> { "impl/prjoxide", "impl" };
+    "p_impl_pkg/prjtrellis"      -> { "impl/prjtrellis", "impl" };
+    "p_impl_pkg/nextpnr/generic" -> { "impl/generic", "impl/pnr" };
+    "p_impl_pkg/nextpnr/ice40"   -> { "impl/ice40", "impl/pnr" };
+    "p_impl_pkg/nextpnr/nexus"   -> { "impl/nexus", "impl/pnr" };
+    "p_impl_pkg/nextpnr/ecp5"    -> { "impl/ecp5", "impl/pnr" };
+  }
+
+}
+
+

Fig. 6 Impl: workflows, dockerfiles, images and tests.

+
+
+
+
# Authors:
+#   Unai Martinez-Corral
+#     <umartinezcorral@antmicro.com>
+#     <unai.martinezcorral@ehu.eus>
+#
+# Copyright Unai Martinez-Corral
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# SPDX-License-Identifier: Apache-2.0
+
+digraph G {
+
+  #splines=polyline; #curved
+  newrank=true;
+
+  # Dockerfiles
+
+  { node [shape=note, color=dodgerblue, fontcolor=dodgerblue]
+    d_boolector   [label="boolector"];
+    d_pono        [label="pono"];
+    d_cvc         [label="cvc"];
+    d_formal      [label="formal"];
+    d_superprove  [label="superprove"];
+    d_sby         [label="sby"];
+    d_yices2      [label="yices2"];
+    d_z3          [label="z3"];
+  }
+
+  # Images
+
+  { node [shape=cylinder]
+    "build/base"
+    "build/build"
+    { node [color=limegreen, fontcolor=limegreen]
+      "ghdl/yosys"
+    }
+    { node [color=mediumblue, fontcolor=mediumblue]
+      "pkg/boolector"
+      "pkg/cvc"
+      "pkg/pono"
+      "pkg/superprove"
+      "pkg/sby"
+      "pkg/yices2"
+      "pkg/z3"
+    }
+    { node [color=brown, fontcolor=brown]
+      "formal/min"
+      "formal"
+      "formal/all"
+    }
+  }
+
+  # External images
+
+  { node [shape=cylinder, color=orange, fontcolor=orange]
+    "scratch"
+  }
+
+  { rank=same
+    "scratch"
+    "build/base"
+    "build/build"
+    "ghdl/yosys"
+  }
+
+  # Workflows
+
+  subgraph cluster_boolector {
+    { rank=same
+      node [shape=cylinder, color=grey, fontcolor=grey]
+      "p_boolector_scratch" [label="scratch"]
+      "p_boolector_build/build" [label="build/build"]
+    }
+
+    d_boolector -> "pkg/boolector" [style=dotted];
+
+    "t_pkg/boolector" [shape=folder, color=red, fontcolor=red, label="boolector.pkg"];
+
+    "pkg/boolector" -> "t_pkg/boolector";
+  }
+
+  subgraph cluster_cvc {
+    { rank=same
+      node [shape=cylinder, color=grey, fontcolor=grey]
+      "p_cvc_scratch" [label="scratch"]
+      "p_cvc_build/build" [label="build/build"]
+    }
+
+    d_cvc -> "pkg/cvc" [style=dotted];
+
+    "t_pkg/cvc" [shape=folder, color=red, fontcolor=red, label="cvc.pkg"];
+
+    "pkg/cvc" -> "t_pkg/cvc";
+  }
+
+  subgraph cluster_pono {
+    { rank=same
+      node [shape=cylinder, color=grey, fontcolor=grey]
+      "p_pono_scratch" [label="scratch"]
+      "p_pono_build/build" [label="build/build"]
+    }
+
+    d_pono -> "pkg/pono" [style=dotted];
+
+    "t_pkg/pono" [shape=folder, color=red, fontcolor=red, label="pono.pkg"];
+
+    "pkg/pono" -> "t_pkg/pono";
+  }
+
+  subgraph cluster_superprove {
+    { rank=same
+      node [shape=cylinder, color=grey, fontcolor=grey]
+      "p_superprove_scratch" [label="scratch"]
+      "p_superprove_build/build" [label="build/build"]
+    }
+
+    d_superprove -> "pkg/superprove" [style=dotted];
+
+    "t_pkg/superprove" [shape=folder, color=red, fontcolor=red, label="superprove.pkg"];
+
+    "pkg/superprove" -> "t_pkg/superprove";
+  }
+
+  subgraph cluster_sby {
+    { rank=same
+      node [shape=cylinder, color=grey, fontcolor=grey]
+      "p_sby_scratch" [label="scratch"]
+      "p_sby_build/base" [label="build/base"]
+    }
+
+    d_sby -> "pkg/sby" [style=dotted];
+
+    "t_pkg/sby" [shape=folder, color=red, fontcolor=red, label="sby.pkg"];
+
+    "pkg/sby" -> "t_pkg/sby";
+  }
+
+  subgraph cluster_yices2 {
+    { rank=same
+      node [shape=cylinder, color=grey, fontcolor=grey]
+      "p_yices2_scratch" [label="scratch"]
+      "p_yices2_build/build" [label="build/build"]
+    }
+
+    d_yices2 -> "pkg/yices2" [style=dotted];
+
+    "t_pkg/yices2" [shape=folder, color=red, fontcolor=red, label="yices2.pkg"];
+
+    "pkg/yices2" -> "t_pkg/yices2";
+  }
+
+  subgraph cluster_z3 {
+    { rank=same
+      node [shape=cylinder, color=grey, fontcolor=grey]
+      "p_z3_scratch" [label="scratch"]
+      "p_z3_build/build" [label="build/build"]
+    }
+
+    d_z3 -> "pkg/z3" [style=dotted];
+
+    "t_pkg/z3" [shape=folder, color=red, fontcolor=red, label="z3.pkg"];
+
+    "pkg/z3" -> "t_pkg/z3";
+  }
+
+  subgraph cluster_formal {
+    { rank=same
+      node [shape=cylinder, color=grey, fontcolor=grey]
+      "p_formal_boolector" [label="pkg/boolector"]
+      "p_formal_cvc" [label="pkg/cvc"]
+      "p_formal_ghdl" [label="ghdl/yosys"]
+      "p_formal_pono" [label="pkg/pono"]
+      "p_formal_sby" [label="pkg/sby"]
+      "p_formal_superprove" [label="pkg/superprove"]
+      "p_formal_z3" [label="pkg/z3"]
+      "p_formal_yices2" [label="pkg/yices2"]
+    }
+
+    d_formal -> {
+      "formal/min",
+      "formal",
+      "formal/all"
+    } [style=dotted];
+
+    { rank=same
+      node [shape=folder, color=red, fontcolor=red];
+      "t_formal/min" [label="formal--min"];
+      "t_formal" [label="formal"];
+      "t_formal/all" [label="formal--all"];
+    }
+
+    "formal/min" -> "t_formal/min";
+    "formal" -> "t_formal";
+    "formal/all" -> "t_formal/all";
+  }
+
+  { rank=same
+    d_boolector
+    d_cvc
+    d_pono
+    d_superprove
+    d_sby
+    d_yices2
+    d_z3
+  }
+
+  # Dockerfile dependencies
+
+  "build/build" -> "p_boolector_build/build" -> d_boolector;
+  "scratch" -> "p_boolector_scratch" -> d_boolector;
+
+  "build/build" -> "p_cvc_build/build" -> d_cvc;
+  "scratch" -> "p_cvc_scratch" -> d_cvc;
+
+  "ghdl/yosys" -> "p_formal_ghdl" -> d_formal;
+  "pkg/sby" -> "p_formal_sby" -> d_formal;
+  "pkg/boolector" -> "p_formal_boolector" -> d_formal;
+  "pkg/cvc" -> "p_formal_cvc" -> d_formal;
+  "pkg/pono" -> "p_formal_pono" -> d_formal;
+  "pkg/yices2" -> "p_formal_yices2" -> d_formal;
+  "pkg/superprove" -> "p_formal_superprove" -> d_formal;
+  "pkg/z3" -> "p_formal_z3" -> d_formal;
+
+  "build/build" -> "p_pono_build/build" -> d_pono;
+  "scratch" -> "p_pono_scratch" -> d_pono;
+
+  "build/base" -> "p_sby_build/base" -> d_sby;
+  "scratch" -> "p_sby_scratch" -> d_sby;
+
+  "build/build" -> "p_superprove_build/build" -> d_superprove;
+  "scratch" -> "p_superprove_scratch" -> d_superprove;
+
+  "build/build" -> "p_yices2_build/build" -> d_yices2;
+  "scratch" -> "p_yices2_scratch" -> d_yices2;
+
+  "build/build" -> "p_z3_build/build" -> d_z3;
+  "scratch" -> "p_z3_scratch" -> d_z3;
+
+  # Image dependencies
+
+  { edge [style=dashed]
+    "p_boolector_scratch" -> "pkg/boolector";
+    "p_cvc_scratch" -> "pkg/cvc";
+    "p_formal_ghdl" -> "formal/min" -> "formal" -> "formal/all";
+    "p_pono_scratch" -> "pkg/pono";
+    "p_superprove_scratch" -> "pkg/superprove";
+    "p_sby_scratch" -> "pkg/sby";
+    "p_yices2_scratch" -> "pkg/yices2";
+    "p_z3_scratch" -> "pkg/z3";
+  }
+
+  { edge [style=dashed, color=grey]
+    {
+      "p_formal_sby",
+      "p_formal_z3"
+    } -> "formal/min";
+
+    {
+      "p_formal_boolector",
+      "p_formal_cvc",
+      "p_formal_pono",
+      "p_formal_yices2"
+    } -> "formal";
+
+    {
+      "p_formal_superprove"
+    } -> "formal/all";
+  }
+
+}
+
+

Fig. 7 Formal: workflows, dockerfiles, images and tests.

+
+
+
+
# Authors:
+#   Unai Martinez-Corral
+#     <umartinezcorral@antmicro.com>
+#     <unai.martinezcorral@ehu.eus>
+#
+# Copyright Unai Martinez-Corral
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# SPDX-License-Identifier: Apache-2.0
+
+digraph G {
+
+  #splines=polyline; #curved
+  newrank=true;
+
+  # Dockerfiles
+
+  { node [shape=note, color=dodgerblue, fontcolor=dodgerblue]
+    d_irsim [label="irsim"];
+    d_klayout [label="klayout"];
+    d_magic [label="magic"];
+    d_netgen [label="netgen"];
+    d_openroad [label="openroad"];
+  }
+
+  # Images
+
+  { node [shape=cylinder]
+    "build/dev"
+    "build/build"
+    "build/base"
+    { node [color=limegreen, fontcolor=limegreen]
+      "irsim"
+      "klayout"
+      "magic"
+      "netgen"
+      "openroad"
+      "openroad/gui"
+    }
+    { node [color=mediumblue, fontcolor=mediumblue]
+      "pkg/irsim"
+      "pkg/klayout"
+      "pkg/magic"
+      "pkg/netgen"
+      "pkg/openroad"
+      "pkg/openroad/gui"
+    }
+    { node [color=brown, fontcolor=brown]
+      "magic/irsim"
+    }
+  }
+
+  # External images
+
+  { node [shape=cylinder, color=orange, fontcolor=orange]
+    "scratch"
+  }
+
+  { rank=same
+    "build/dev"
+    "build/build"
+    "build/base"
+    "scratch"
+  }
+
+  # Workflows
+
+  subgraph cluster_irsim {
+    { rank=same
+      node [shape=cylinder, color=grey, fontcolor=grey]
+      "p_irsim_build/build" [label="build/build"]
+      "p_irsim_build/base" [label="build/base"]
+      "p_irsim_scratch" [label="scratch"]
+    }
+
+    d_irsim -> {
+      "irsim"
+      "pkg/irsim"
+    } [style=dotted];
+
+    {
+      node [shape=folder, color=red, fontcolor=red]
+      "t_irsim" [label="irsim"];
+      "t_pkg/irsim" [label="irsim.pkg"];
+    }
+
+    "irsim" -> "t_irsim";
+    "pkg/irsim" -> "t_pkg/irsim";
+  }
+
+  subgraph cluster_klayout {
+    { rank=same
+      node [shape=cylinder, color=grey, fontcolor=grey]
+      "p_klayout_build/build" [label="build/build"]
+      "p_klayout_build/base" [label="build/base"]
+      "p_klayout_scratch" [label="scratch"]
+    }
+
+    d_klayout -> {
+      "klayout"
+      "pkg/klayout"
+    } [style=dotted];
+
+    {
+      node [shape=folder, color=red, fontcolor=red]
+      "t_klayout" [label="klayout"];
+      "t_pkg/klayout" [label="klayout.pkg"];
+    }
+
+    "klayout" -> "t_klayout";
+    "pkg/klayout" -> "t_pkg/klayout";
+  }
+
+  subgraph cluster_magic {
+    { rank=same
+      node [shape=cylinder, color=grey, fontcolor=grey]
+      "p_magic_build/build" [label="build/build"]
+      "p_magic_build/base" [label="build/base"]
+      "p_magic_scratch" [label="scratch"]
+      "p_magic_pkg/irsim" [label="pkg/irsim"]
+    }
+
+    d_magic -> {
+      "magic"
+      "pkg/magic"
+      "magic/irsim"
+    } [style=dotted];
+
+    { rank=same
+      node [shape=folder, color=red, fontcolor=red]
+      "t_magic" [label="magic"];
+      "t_pkg/magic" [label="magic.pkg"];
+      "t_magic/irsim" [label="magic--irsim"];
+    }
+
+    "magic" -> "t_magic";
+    "pkg/magic" -> "t_pkg/magic";
+    "magic/irsim" -> "t_magic/irsim";
+  }
+
+  subgraph cluster_netgen {
+    { rank=same
+      node [shape=cylinder, color=grey, fontcolor=grey]
+      "p_netgen_build/build" [label="build/build"]
+      "p_netgen_build/base" [label="build/base"]
+      "p_netgen_scratch" [label="scratch"]
+    }
+
+    d_netgen -> {
+      "netgen"
+      "pkg/netgen"
+    } [style=dotted];
+
+    {
+      node [shape=folder, color=red, fontcolor=red]
+      "t_netgen" [label="netgen"];
+      "t_pkg/netgen" [label="netgen.pkg"];
+    }
+
+    "netgen" -> "t_netgen";
+    "pkg/netgen" -> "t_pkg/netgen";
+  }
+
+  subgraph cluster_openroad {
+    { rank=same
+      node [shape=cylinder, color=grey, fontcolor=grey]
+      "p_openroad_build/dev" [label="build/dev"]
+      "p_openroad_build/base" [label="build/base"]
+      "p_openroad_scratch" [label="scratch"]
+    }
+
+    d_openroad -> {
+      "openroad"
+      "openroad/gui"
+      "pkg/openroad"
+      "pkg/openroad/gui"
+    } [style=dotted];
+
+    {
+      node [shape=folder, color=red, fontcolor=red]
+      "t_openroad" [label="openroad"];
+      "t_pkg/openroad" [label="openroad.pkg"];
+      "t_openroad/gui" [label="openroad--gui"];
+      "t_pkg/openroad/gui" [label="openroad--gui.pkg"];
+    }
+
+    "openroad" -> "t_openroad";
+    "pkg/openroad" -> "t_pkg/openroad";
+
+    "openroad/gui" -> "t_openroad/gui";
+    "pkg/openroad/gui" -> "t_pkg/openroad/gui";
+  }
+
+  # Dockerfile dependencies
+
+  "build/build" -> "p_irsim_build/build" -> d_irsim;
+  "build/base" -> "p_irsim_build/base" -> d_irsim;
+  "scratch" -> "p_irsim_scratch" -> d_irsim;
+
+  "build/build" -> "p_klayout_build/build" -> d_klayout;
+  "build/base" -> "p_klayout_build/base" -> d_klayout;
+  "scratch" -> "p_klayout_scratch" -> d_klayout;
+
+  "pkg/irsim" -> "p_magic_pkg/irsim" -> d_magic;
+  "build/build" -> "p_magic_build/build" -> d_magic;
+  "build/base" -> "p_magic_build/base" -> d_magic;
+  "scratch" -> "p_magic_scratch" -> d_magic;
+
+  "build/build" -> "p_netgen_build/build" -> d_netgen;
+  "build/base" -> "p_netgen_build/base" -> d_netgen;
+  "scratch" -> "p_netgen_scratch" -> d_netgen;
+
+  "build/dev" -> "p_openroad_build/dev" -> d_openroad;
+  "build/base" -> "p_openroad_build/base" -> d_openroad;
+  "scratch" -> "p_openroad_scratch" -> d_openroad;
+
+  # Image dependencies
+
+  { edge [style=dashed]
+    "p_irsim_build/base" -> "irsim";
+    "p_irsim_scratch" -> "pkg/irsim";
+    "p_klayout_build/base" -> "klayout";
+    "p_klayout_scratch" -> "pkg/klayout";
+    "p_magic_build/base" -> "magic";
+    "p_magic_scratch" -> "pkg/magic";
+    "magic" -> "magic/irsim";
+    "p_netgen_build/base" -> "netgen";
+    "p_netgen_scratch" -> "pkg/netgen";
+    "p_openroad_build/base" -> "openroad";
+    "p_openroad_scratch" -> "pkg/openroad";
+    "p_openroad_build/base" -> "openroad/gui";
+    "p_openroad_scratch" -> "pkg/openroad/gui";
+  }
+
+  { edge [style=dashed, color=grey]
+    "p_magic_pkg/irsim" -> "magic/irsim";
+  }
+
+}
+
+

Fig. 8 ASIC: workflows, dockerfiles, images and tests.

+
+
+
+
# Authors:
+#   Unai Martinez-Corral
+#     <umartinezcorral@antmicro.com>
+#     <unai.martinezcorral@ehu.eus>
+#
+# Copyright Unai Martinez-Corral
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# SPDX-License-Identifier: Apache-2.0
+
+digraph G {
+
+  #splines=polyline; #curved
+  newrank=true;
+
+  # Dockerfiles
+
+  { node [shape=note, color=dodgerblue, fontcolor=dodgerblue]
+    d_conda     [label="conda"];
+    d_f4pga [label="conda/f4pga"];
+    d_verible [label="verible"];
+  }
+
+  # Images
+
+  { node [shape=cylinder]
+    "build/base"
+    "build/build"
+    { node [color=limegreen, fontcolor=limegreen]
+      "verible"
+    }
+    { node [color=mediumblue, fontcolor=mediumblue]
+      "pkg/verible"
+    }
+    { node [color=brown, fontcolor=brown]
+      "conda"
+      "conda/f4pga/xc7/toolchain"
+      "conda/f4pga/xc7/a50t"
+      "conda/f4pga/xc7/a100t"
+      "conda/f4pga/xc7/a200t"
+      "conda/f4pga/xc7/z010"
+      "conda/f4pga/xc7/z020"
+      "conda/f4pga/xc7"
+      "conda/f4pga/eos-s3"
+    }
+  }
+
+  # External images
+
+  { node [shape=cylinder, color=orange, fontcolor=orange]
+    "scratch"
+  }
+
+  { rank=same
+    "build/base"
+    "build/build"
+    "scratch"
+  }
+
+  # Workflows
+
+  subgraph cluster_conda {
+    "p_conda_build/base" [shape=cylinder, color=grey, fontcolor=grey, label="build/base"];
+    d_conda -> "conda" [style=dotted];
+    "t_conda" [shape=folder, color=red, fontcolor=red, label="conda"];
+    "conda" -> "t_conda";
+  }
+
+  subgraph cluster_F4PGA {
+    { rank=same
+      node [shape=cylinder, color=grey, fontcolor=grey]
+      "p_F4PGA_conda"  [label="conda"]
+    }
+
+    d_f4pga -> {
+      "conda/f4pga/xc7/toolchain"
+      { rank=same
+        "conda/f4pga/xc7/a50t"
+        "conda/f4pga/xc7/a100t"
+        "conda/f4pga/xc7/a200t"
+        "conda/f4pga/xc7/z010"
+        "conda/f4pga/xc7/z020"
+      }
+      "conda/f4pga/xc7"
+      "conda/f4pga/eos-s3"
+    } [style=dotted];
+
+    { rank=same
+      node [shape=folder, color=red, fontcolor=red];
+      "t_F4PGA_xc7_toolchain" [label="conda--f4pga--xc7--toolchain"];
+      "t_F4PGA_xc7_a50t"      [label="conda--f4pga--xc7--a50t"];
+      "t_F4PGA_xc7_a100t"     [label="conda--f4pga--xc7--a100t"];
+      "t_F4PGA_xc7_a200t"     [label="conda--f4pga--xc7--a200t"];
+      "t_F4PGA_xc7_z010"      [label="conda--f4pga--xc7--z010"];
+      "t_F4PGA_xc7_z020"      [label="conda--f4pga--xc7--z020"];
+      "t_F4PGA_xc7"           [label="conda--f4pga--xc7"];
+      "t_F4PGA_eos-s3"        [label="conda--f4pga--eos-s3"];
+    }
+
+    "conda/f4pga/xc7/toolchain"  -> "t_F4PGA_xc7_toolchain";
+    "conda/f4pga/xc7/a50t"       -> "t_F4PGA_xc7_a50t";
+    "conda/f4pga/xc7/a100t"      -> "t_F4PGA_xc7_a100t";
+    "conda/f4pga/xc7/a200t"      -> "t_F4PGA_xc7_a200t";
+    "conda/f4pga/xc7/z010"       -> "t_F4PGA_xc7_z010";
+    "conda/f4pga/xc7/z020"       -> "t_F4PGA_xc7_z020";
+    "conda/f4pga/xc7"            -> "t_F4PGA_xc7";
+    "conda/f4pga/eos-s3"         -> "t_F4PGA_eos-s3";
+  }
+
+  subgraph cluster_verible {
+    { rank=same
+      node [shape=cylinder, color=grey, fontcolor=grey]
+      "p_verible_build/build" [label="build/build"]
+      "p_verible_build/base" [label="build/base"]
+      "p_verible_scratch" [label="scratch"]
+    }
+
+    d_verible -> {
+      "verible"
+      "pkg/verible"
+    } [style=dotted];
+
+    {
+      node [shape=folder, color=red, fontcolor=red]
+      "t_verible" [label="verible"];
+      "t_pkg/verible" [label="verible.pkg"];
+    }
+
+    "verible" -> "t_verible";
+    "pkg/verible" -> "t_pkg/verible";
+  }
+
+  # Dockerfile dependencies
+
+  "build/base" -> "p_conda_build/base" -> d_conda;
+
+  "build/build" -> "p_verible_build/build" -> d_verible;
+  "build/base" -> "p_verible_build/base" -> d_verible;
+  "scratch" -> "p_verible_scratch" -> d_verible;
+
+  "conda" -> "p_F4PGA_conda" -> d_f4pga;
+
+  # Image dependencies
+
+  { edge [style=dashed]
+    "conda/f4pga/xc7/toolchain" -> "conda/f4pga/xc7/a50t";
+    "conda/f4pga/xc7/toolchain" -> "conda/f4pga/xc7/a100t";
+    "conda/f4pga/xc7/toolchain" -> "conda/f4pga/xc7/a200t";
+    "conda/f4pga/xc7/toolchain" -> "conda/f4pga/xc7/z010";
+    "conda/f4pga/xc7/toolchain" -> "conda/f4pga/xc7/z020";
+    "conda/f4pga/xc7/toolchain" -> "conda/f4pga/xc7";
+
+    "p_verible_build/base" -> "verible";
+    "p_verible_scratch" -> "pkg/verible";
+  }
+
+  { edge [style=dashed, color=grey]
+    "conda/f4pga/xc7/a50t"  -> "conda/f4pga/xc7";
+    "conda/f4pga/xc7/a100t" -> "conda/f4pga/xc7";
+    # TODO: This is temporarily disabled because of space limits on GitHub Actions default runners
+    #"conda/f4pga/xc7/a200t" -> "conda/f4pga/xc7";
+    "conda/f4pga/xc7/z010"  -> "conda/f4pga/xc7";
+    "conda/f4pga/xc7/z020"  -> "conda/f4pga/xc7";
+  }
+
+}
+
+

Fig. 9 F4PGA: workflows, dockerfiles, images and tests.

+
+
+
+
# Authors:
+#   Unai Martinez-Corral
+#     <umartinezcorral@antmicro.com>
+#     <unai.martinezcorral@ehu.eus>
+#
+# Copyright Unai Martinez-Corral
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# SPDX-License-Identifier: Apache-2.0
+
+digraph G {
+
+  #splines=polyline; #curved
+  newrank=true;
+  node [fontsize=8];
+  edge [fontsize=8];
+
+  { rank=same
+    image_ext [shape=cylinder, color=orange, fontcolor=orange, label=""];
+    image_hdl [shape=cylinder, label=""];
+    image_hdlpkg [shape=cylinder, label=""];
+    deps [shape=none, label="Publicly available images which the workflow depends on:\l- Black: own, generated in other workflows of this project\l- Orange: external, generated somewhere else\l"]
+  }
+
+  subgraph cluster_legend {
+    test [shape=folder, color=magenta, fontcolor=magenta, label="Test"];
+    image [shape=cylinder, label="Image"];
+    image_base [shape=cylinder, color=grey, fontcolor=grey, label=""];
+    image_dep [shape=cylinder, color=grey, fontcolor=grey, label=""];
+    image_pkg [shape=cylinder, color=grey, fontcolor=grey, label=""];
+    dockerfile [shape=note, color=dodgerblue, fontcolor=dodgerblue, label="Dockerfile"];
+    {
+      image_base,
+      image_dep,
+      image_pkg
+    } -> dockerfile;
+    dockerfile -> image [style=dotted, label="Image\ngenerated\nby"];
+    image_base -> image [style=dashed, label="Image\nbased\non"];
+    image_pkg -> image [style=dashed, color=gray, label="Image\nimports\nfrom"];
+    image -> test;
+  }
+  { rank=same
+    image_base
+    image_dep
+    image_pkg
+    shadow [shape=none, label="Shadows of the images the workflow depends on.\lShown for ease of visualisation only.\l"];
+  }
+  { rank=same
+    dockerfile
+    workflow [shape=none, label="A cluster represents a GitHub Actions workflow, which\ltypically uses a single dockerfile.\l The workflow and the dockerfile are named after the tools.\l"];
+  }
+  { rank=same
+    image
+    desc [shape=none, label="Image(s) generated in the workflow:\l- Green: fine-grained ready-to-use image.\l- Brown: ready-to-use image including several tools.\l- Blue: package image, not executable.\lEach image has, at least and at most, two black input edges, one\ldotted and one dashed. It can optionally have other gray input edges.\l"];
+  }
+  { rank=same
+    test
+    test_desc [shape=none, label="Each image has a test script, which is executed in a temporary\lcontainer before pushing the image to DockerHub.\lTests which are not complete yet are shown in Red.\l"];
+  }
+  image_ext -> image_dep;
+  image_hdl -> image_base;
+  image_hdlpkg -> image_pkg;
+
+}
+
+

Fig. 10 Legend of the directed graph.

+
+
+
+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/dev/PackageImages.html b/dev/PackageImages.html new file mode 100644 index 000000000..084ee32c2 --- /dev/null +++ b/dev/PackageImages.html @@ -0,0 +1,168 @@ + + + + + + + Package images — HDL Containers: Building and deploying container images for open source Electronic Design Automation latest documentation + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+ + +
+ +
+
+ +
+
+ +
+

Package images

+

Each EDA tool/project is built once only for each collection and architecture in this image/container ecosystem. +However, some (many) of the tools need to be included in multiple images for different purposes. +Moreover, it is desirable to keep build recipes separated, in order to better understand the dependencies of each +tool/project. +Therefore, REGISTRY/[ARCHITECTURE/][COLLECTION/]pkg/ images are created/used (coloured BLUE in the +Graphs). +These are all based on scratch and are not runnable. +Instead, they contain pre-built artifacts, to be then added into other images through COPY --from=.

+

Since pkg images are not runnable per se, but an intermediate utility, the usage of environment variables +PREFIX and DESTDIR in the dockerfiles might be misleading. +All the tools in the ecosystem are expected to be installed into /usr/local, the standard location for user built +tools on most GNU/Linux distributions. +Hence:

+
    +
  • PREFIX should typically not need to be modified. +Most of the tools will default to PREFIX=/usr/local, which is correct. +Yet, some tools might default to / or /usr. +In those cases, setting it explicitly is required.

  • +
  • DESTDIR must be set to an empty location when calling make install or when copying the artifacts otherhow. +The content of the corresponding package images is taken from that empty location. +Therefore, if DESTDIR was unset, the artifacts of the tool might potentially be mixed with other existing assets +in /usr/local. +In most of the dockerfiles, /opt/TOOL_NAME is used as the temporary empty location.

  • +
+

Despite the usage of these variables being documented in GNU Coding Standards, +DESTDIR seems not to be very used, except by packagers. +As a result, contributors might need to patch the build scripts upstream. +Sometimes DESTDIR is not supported at all, or it is supported but some lines in the makefiles are missing it. +Do not hesitate to reach for help through the issues or the chat!

+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/dev/Tasks.html b/dev/Tasks.html new file mode 100644 index 000000000..dce063e0b --- /dev/null +++ b/dev/Tasks.html @@ -0,0 +1,176 @@ + + + + + + + Tasks — HDL Containers: Building and deploying container images for open source Electronic Design Automation latest documentation + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+ + +
+ +
+
+ +
+
+ +
+

Tasks

+
+

Credentials

+

In order to push images to container registries, credentials are required. +The default github.token is enough for publishing to GHCR, however, docker.io and GCR do need specific secrets to be +setup.

+

In The Google Cloud Platform (GCP), credentials are managed through a CLI tool named gcloud. +Periodically, a new key needs to be created and the outdated ones need to be removed.

+
# List the projects:
+~ gcloud projects list
+
+# Set the project for the current workspace:
+~ gcloud config set project [PROJECT_ID]
+
+# List the available service accounts:
+~ gcloud iam service-accounts list
+
+# Note the e-mail of the service account, and list the keys:
+~ gcloud iam service-accounts keys list --iam-account=[NAME]@[PROJECT_ID].iam.gserviceaccount.com
+
+# Create a new key and save it to a file:
+~ gcloud iam service-accounts keys create keyfile.json --iam-account [NAME]@[PROJECT_ID].iam.gserviceaccount.com
+
+# Go to organisation secrets and update the GCR_JSON_KEY secret with the whole content of the JSON file
+# https://github.com/organizations/hdl/settings/secrets/actions
+
+# Remove the JSON file
+~ rm keyfile.json
+
+# Remove other (expired) keys
+~ gcloud iam service-accounts keys delete KEY_ID --iam-account [NAME]@[PROJECT_ID].iam.gserviceaccount.com
+
+
+

See cloud.google.com/container-registry/docs/advanced-authentication#json-key.

+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/dev/Utils.html b/dev/Utils.html new file mode 100644 index 000000000..c40b4c064 --- /dev/null +++ b/dev/Utils.html @@ -0,0 +1,609 @@ + + + + + + + Utils — HDL Containers: Building and deploying container images for open source Electronic Design Automation latest documentation + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+ + +
+ +
+
+ +
+
+ +
+

Utils

+
+
+

Some helper shell and Python utilities are available in utils/bin and +utils/pyHDLC, respectively. +A utils/setup.sh script is provided for installing Python dependencies and adding the bin +subdir to the PATH. +Since pip is used for installing utils/pyHDLC/requirements.txt, it is +desirable to create a virtual environment (docs.python.org/3/library/venv) +before running setup.sh:

+
virtualenv venv
+source venv/bin/activate
+./utils/setup.sh
+
+
+
+

pyHDLC

+

Helper tool for building one or multiple images, for easily browsing publicly +available tags, and for generating graphs showing the dependencies between them.

+
usage: pyHDLC [-n] {help,jobs,pull,build,test,push} ...
+
+
+

Happy hacking!

+
+

options

+
+
+-n, --noexec
+

Print commands but do not execute them.

+
+ +
+
+

pyHDLC build

+

Build one or multiple images (and optionally test them) at once, reusing common parameters.

+
+

Important

+

DOCKERFILE defaults to Image if None.

+
+
usage: pyHDLC build [-h] [-a ARCHITECTURE] [-c COLLECTION] [-r REGISTRY]
+                    [-f DOCKERFILE] [-t TARGET] [-i ARGIMG] [-p] [-d] [-q]
+                    Image [Image ...]
+
+
+
+
+image
+

Image name(s), without registry prefix.

+
+ +
+
+-h, --help
+

show this help message and exit

+
+ +
+
+-a <architecture>, --arch <architecture>
+

Name of the architecture.

+
+ +
+
+-c <collection>, --collection <collection>
+

Name of the collection/subset of images.

+
+ +
+
+-r <registry>, --registry <registry>
+

Container image registry prefix.

+
+ +
+
+-f <dockerfile>, --dockerfile <dockerfile>
+

Dockerfile to be built, from the collection.

+
+ +
+
+-t <target>, --target <target>
+

Target stage in the dockerfile.

+
+ +
+
+-i <argimg>, --argimg <argimg>
+

Base image passed as an ARG to the dockerfile.

+
+ +
+
+-p, --pkg
+

Preprend ‘pkg/’ to Image and set Target to ‘pkg’ (if unset).

+
+ +
+
+-d, --default
+

Set default Dockerfile, Target and ArgImg options, given the image name(s).

+
+ +
+
+-q, --test
+

Test each image right after building it.

+
+ +
+
+

pyHDLC help

+
usage: pyHDLC help [-h] [Command]
+
+
+
+
+command
+

Print help page(s) for a command.

+
+ +
+
+-h, --help
+

show this help message and exit

+
+ +
+
+

pyHDLC jobs

+

Generate list of jobs for a named task.

+
usage: pyHDLC jobs [-h] [-f {gha,GHA}] Name
+
+
+
+
+name
+

Identifier to extract jobs from the YAML configuration file.

+
+ +
+
+-h, --help
+

show this help message and exit

+
+ +
+
+-f {gha,GHA}, --format {gha,GHA}
+

Output format (by default, print GitHub Actions’ set-output syntax).

+
+ +
+
+

pyHDLC pull

+

Pull container image(s) from registry.

+
usage: pyHDLC pull [-h] [-a ARCHITECTURE] [-c COLLECTION] [-r REGISTRY]
+                   Image [Image ...]
+
+
+
+
+image
+

Image name(s), without registry prefix.

+
+ +
+
+-h, --help
+

show this help message and exit

+
+ +
+
+-a <architecture>, --arch <architecture>
+

Name of the architecture.

+
+ +
+
+-c <collection>, --collection <collection>
+

Name of the collection/subset of images.

+
+ +
+
+-r <registry>, --registry <registry>
+

Container image registry prefix.

+
+ +
+
+

pyHDLC push

+

Push container image(s) to registry/registries.

+
usage: pyHDLC push [-h] [-a ARCHITECTURE] [-c COLLECTION] [-r REGISTRY]
+                   [-m [MIRROR ...]]
+                   Image [Image ...]
+
+
+
+
+image
+

Image name(s), without registry prefix.

+
+ +
+
+-h, --help
+

show this help message and exit

+
+ +
+
+-a <architecture>, --arch <architecture>
+

Name of the architecture.

+
+ +
+
+-c <collection>, --collection <collection>
+

Name of the collection/subset of images.

+
+ +
+
+-r <registry>, --registry <registry>
+

Container image registry prefix.

+
+ +
+
+-m <mirror>, --mirror <mirror>
+

List of additional registry/registries to push to. Supported placeholders: #A (architecture), #C (collection).

+
+ +
+
+

pyHDLC test

+

Test container image(s).

+
+

Important

+

The supported syntax for each Image is name[#<DirName>], where the optional <DirName> is used as the location in +package images to copy the content from.

+
+
usage: pyHDLC test [-h] [-a ARCHITECTURE] [-c COLLECTION] [-r REGISTRY]
+                   Image [Image ...]
+
+
+
+
+image
+

Image name(s), without registry prefix.

+
+ +
+
+-h, --help
+

show this help message and exit

+
+ +
+
+-a <architecture>, --arch <architecture>
+

Name of the architecture.

+
+ +
+
+-c <collection>, --collection <collection>
+

Name of the collection/subset of images.

+
+ +
+
+-r <registry>, --registry <registry>
+

Container image registry prefix.

+
+ +
+
+
+

Smoke-tests

+

There is a test script in test/ for each image in this ecosystem, according to the following +convention:

+
    +
  • Scripts for package images, /[ARCHITECTURE/][COLLECTION/]pkg/TOOL_NAME[/SUBNAME], are named +TOOL_NAME[--SUBNAME].pkg.sh.

  • +
  • Scripts for other images, /[ARCHITECTURE/][COLLECTION/]NAME[/SUBNAME], are named NAME[--SUBNAME].sh.

  • +
  • Other helper scripts are named _*.sh.

  • +
+

Furthermore, gh:hdl/smoke-tests is a submodule of this repository (test/smoke-tests). +Smoke-tests contains fine-grained tests that cover the most important functionalities of the tools. +Those are used in other packaging projects too. +Therefore, container tests are expected to execute the smoke-tests corresponding to the tools available in the image, +before executing more specific tests.

+

pyHDLC test allows testing the runnable and package images. +It is used in CI but can be useful locally too. +When using pyHDLC test, DirName allows to optionally specify the name of the directory inside the package image +which needs to be copied to the temporary image for testing. +By default, the escaped name of the image is used as the location.

+
+
+

Inspect

+

All ready-to-use images (coloured GREEN or BROWN in the Graphs) are +runnable. +Therefore, users/contributors can run containers and test the tools interactively or through scripting. +However, since pkg images are not runnable, creating another image is required in order to inspect their content +from a container. +For instance:

+
FROM busybox
+COPY --from=REGISTRY/pkg/TOOL_NAME /TOOL_NAME /
+
+
+

In fact, pyHDLC test uses a similar dockerfile for running .pkg.sh scripts from test/. +See Test.

+

Alternatively, or as a complement, gh:wagoodman/dive is a lightweight tool with a nice terminal based GUI for +exploring layers and contents of container images. +It can be downloaded as a tarball/zipfile, or used as a container:

+
docker run --rm -it \
+  -v //var/run/docker.sock://var/run/docker.sock \
+  wagoodman/dive \
+  REGISTRY/[ARCHITECTURE/][COLLECTION/]IMAGE[:TAG]
+
+
+
+gh:wagoodman/dive +
+

Fig. 11 Inspection of REGISTRY/pkg/yosys with gh:wagoodman/dive.

+
+
+

dockerDive is a wrapper around the wagoodman/dive container, which supports one +or two arguments for specifying the image to be inspected. +The default registry prefix is gcr.io/hdl-containers, however, it can be overriden through envvar HDL_REGISTRY.

+

For instance, inspect image gcr.io/hdl-containers/debian/bullseye/ghdl:

+
dockerDive debian/bullseye ghdl
+
+
+

or, inspect any image from any registry:

+
HDL_REGISTRY=docker.io dockerDive python:slim-bookworm
+
+
+
+
+

YAML Configuration File

+

Most of the complexity regarding images, dockerfiles, arguments and jobs is defined in the YAML configuration file +(see config.yml), which contains two data fields:

+
    +
  • defaults: which dockerfile and (optionally) target stage or base image to be used when building “non-regular” images. +That is, using a non-empty target, an specific base image, etc. +If the image name is not defined in this field, the dockerfile defaults to the image name and the target depends on +option package.

  • +
  • jobs: which images and for which collections and architectures to build each list of tasks. +For convenienve, the keywords match the name of the main tool/group in the list.

  • +
+
+

Tip

+

Contributors will find that field anchors in config.yml is ignored by pyHDLC +commands when analyzing the file. +That’s because anchors are used to reduce the verbosity of the YAML file, but they are resolved by the loader.

+ +
+

The fields and types supported in the configuration file are defined through dataclasses (see Dataclasses). +However, some details about the syntax can be non-obvious. +See the clarifications below:

+
+

Defaults

+

If the following conditions are met, images need not to be explicitly listed in the configuration file:

+
    +
  • The dockerfile to be used matches the image name.

  • +
  • The default target is empty, or pkg if a package image is being built.

  • +
  • The argimg is empty.

  • +
+

Otherwise, a dictionary is expected, with the fields that need to be overriden (dockerfile, target and/or +argimg).

+
+
+

Jobs

+

There are four kinds of job lists:

+
    +
  • default: two images are built for each collection and architecture, a regular image and a package image.

  • +
  • pkgonly: a package image is built for each collection and architecture.

  • +
  • runonly: a regular image is built for each collection and architecture.

  • +
  • custom: the lists of jobs/tasks are declared as cross-products, and exclude is supported.

  • +
+

In default, pkgonly and runonly, a dictionary of lists is expected per keyword; each key corresponding to a +collection and the lists specifying the architectures. +Conversely, in custom three fields are expected:

+
    +
  • sys: a dictionary of lists, such as the one expected in default, pkgonly and runonly.

  • +
  • images: either a list or a list of lists of image names.

    +
      +
    • If a single list is provided, all images are built sequentially in a single job:

      +
      images:
      +  - formal/min
      +  - formal
      +  - formal/all
      +
      +
      +

      If a list of lists is provided, each of them is built sequentially in a different job:

      +
      images:
      +  - [ conda/f4pga/xc7/a50t  ]
      +  - [ conda/f4pga/xc7/a100t ]
      +  - [ conda/f4pga/xc7/a200t ]
      +
      +
      +
    • +
    • Argument substitution is supported through ${arg}. +If any of the items in the list is a dictionary, instead of a string, it is used as an argument in the substitution +phase. +If the same argument is provided multiple times, a cross-product of the arguments and the lists is produced:

      +
      images:
      +  - sim/${prj}-slim
      +  - sim/${prj}
      +  - prj: scipy
      +  - prj: octave
      +
      +
      +
      images:
      +  - pkg/nextpnr/${arch}
      +  - nextpnr/${arch}
      +  - nextpnr/${prj}
      +  - { arch: ice40, prj: icestorm   }
      +  - { arch: ecp5,  prj: prjtrellis }
      +
      +
      +
    • +
    +
  • +
  • exclude: optionally, declare combinations of sys and images which should be excluded from the produced +cross-products. +For example:

    +
    images:
    +  - pkg/nextpnr/${arch}
    +  - nextpnr/${arch}
    +  - nextpnr/${prj}
    +  - { arch: ecp5,  prj: prjtrellis }
    +  - { arch: nexus, prj: prjoxide   }
    +sys: *SysDebianAmd64
    +exclude:
    +  - sys: { debian/buster: [amd64] }
    +    params: { arch: nexus, prj: prjoxide }
    +
    +
    +
  • +
+
+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/dev/pyHDLC_Reference.html b/dev/pyHDLC_Reference.html new file mode 100644 index 000000000..0b76e2d1e --- /dev/null +++ b/dev/pyHDLC_Reference.html @@ -0,0 +1,427 @@ + + + + + + + pyHDLC Reference — HDL Containers: Building and deploying container images for open source Electronic Design Automation latest documentation + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+ + +
+ +
+
+ +
+
+ +
+

pyHDLC Reference

+
+

Functions

+
+
+pyHDLC.BuildImage(image: Union[str, List[str]], registry: str = 'gcr.io/hdl-containers', collection: str = 'debian/bullseye', architecture: str = 'amd64', dockerfile: str = None, target: str = None, argimg: str = None, pkg: bool = False, dry: bool = False, default: bool = False, test: bool = False) None
+

Build and optionally test container image(s).

+
+
Parameters:
+
    +
  • image – Bare image name(s), without registry, collection or architecture. +The supported syntax for each image name is name[#location], where the optional location is ignored during +the build if provided (it’s used for testing only, see TestImage()).

  • +
  • registry – Optionally, set the prefix of the registry.

  • +
  • collection – Optionally, set the collection to build the image from.

  • +
  • architecture – Optionally, set the architecture to build the image for.

  • +
  • dockerfile – Optionally, set the Dockerfile to build the image with.

  • +
  • target – Optionally, set the target stage in the dockerfile.

  • +
  • argimg – Optionally, set the build argument IMAGE.

  • +
  • pkg – Optionally, specify explicitly whether the image to be built is a package image.

  • +
  • dry – Do not build the image, just print the command(s) that would be executed.

  • +
  • default – Instead of providing all of the parameters, get them from the YAML configuration file.

  • +
  • test – Test the image(s) after building.

  • +
+
+
+
+ +
+
+pyHDLC.GenerateJobList(name: str, fmt: str = 'gha', dry: bool = False) None
+

Generate list of jobs for a named task.

+
+
Parameters:
+
    +
  • name – Identifier to extract jobs from the YAML configuration file.

  • +
  • fmt – Output format (by default, print to GITHUB_OUTPUT).

  • +
  • dry – Do not set the output, just print the list of jobs.

  • +
+
+
+
+ +
+
+pyHDLC.PullImage(image: Union[str, List[str]], registry: str = 'gcr.io/hdl-containers', collection: str = 'debian/bullseye', architecture: str = 'amd64', dry: bool = False) None
+

Pull container image(s) from registry.

+
+
Parameters:
+
    +
  • image – Bare image name(s), without registry, collection or architecture. +The supported syntax for each image name is name[#location], where the optional location is ignored if +provided (it’s used in TestImage() only).

  • +
  • registry – Optionally, set the prefix of the registry.

  • +
  • collection – Optionally, set the collection to pull the image for.

  • +
  • architecture – Optionally, set the architecture to pull the image for.

  • +
  • dry – Do not pull the image, just print the command that would be executed.

  • +
+
+
+
+ +
+
+pyHDLC.PushImage(image: Union[str, List[str]], registry: str = 'gcr.io/hdl-containers', collection: str = 'debian/bullseye', architecture: str = 'amd64', dry: bool = False, mirror: Union[str, List[str]] = None) None
+

Push container image(s) to registry/registries.

+
+
Parameters:
+
    +
  • image – Bare image name(s), without registry, collection or architecture. +The supported syntax for each image name is name[#location], where the optional location is ignored if +provided (it’s used in TestImage() only).

  • +
  • registry – Optionally, set the prefix of the registry.

  • +
  • collection – Optionally, set the collection to push the image from.

  • +
  • architecture – Optionally, set the architecture to push the image for.

  • +
  • dry – Do not push the image, just print the command(s) that would be executed.

  • +
  • mirror

    List of additional registry/registries to push to. Supported placeholders:

    +
      +
    • #A: architecture

    • +
    • #C: collection

    • +
    +

  • +
+
+
+
+ +
+
+pyHDLC.TestImage(image: Union[str, List[str]], registry: str = 'gcr.io/hdl-containers', collection: str = 'debian/bullseye', architecture: str = 'amd64', dry: bool = False) None
+

Test container image(s).

+
+
Parameters:
+
    +
  • image – Bare image name(s), without registry, collection or architecture. +The supported syntax for each image name is name[#<DirName>], where the optional <DirName> is used as the +location in package images to copy the content from.

  • +
  • registry – Optionally, set the prefix of the registry.

  • +
  • collection – Optionally, set the collection to test the image from.

  • +
  • architecture – Optionally, set the architecture to test the image for.

  • +
  • dry – Do not test the image, just print the command(s) that would be executed.

  • +
+
+
+
+ +
+
+

Dataclasses

+
+
+class pyHDLC.Config(HDLC: int = None, anchors: ~typing.Dict = <factory>, defaults: ~pyHDLC.ConfigDefaults = <factory>, jobs: ~pyHDLC.ConfigJobs = <factory>)
+

Configuration containing global defaults, image building argument overrides and job/task list declarations. +See YAML Configuration File.

+
+
+HDLC: int = None
+

Version of the configuration file syntax.

+
+ +
+
+anchors: Dict
+

Placeholder for anchors used to reduce verbosity. This field is resolved by the loader and ignored by the analyzer.

+
+ +
+
+defaults: ConfigDefaults
+

Default global parameters and images which need explicitly overriding build argument defaults.

+
+ +
+
+jobs: ConfigJobs
+

List of jobs/tasks to be used in CI to dynamically spawn jobs.

+
+ +
+ +
+
+class pyHDLC.ConfigDefaultImageItem(dockerfile: str = None, target: str = None, argimg: str = None)
+

Optionally overridable fields for image build argument defaults.

+
+
+argimg: str = None
+

The base IMAGE to pass as a build-arg to docker build.

+
+ +
+
+dockerfile: str = None
+

The dockerfile to pass to docker build.

+
+ +
+
+target: str = None
+

The target stage to pass to docker build.

+
+ +
+ +
+
+class pyHDLC.ConfigDefaults(registry: str = 'gcr.io/hdl-containers', collection: str = 'debian/bullseye', architecture: str = 'amd64', images: Dict[str, ConfigDefaultImageItem] = None)
+

Default global parameters and images which need explicitly overriding build argument defaults. +See Defaults.

+
+
+architecture: str = 'amd64'
+

Default architecture.

+
+ +
+
+collection: str = 'debian/bullseye'
+

Default collection.

+
+ +
+
+images: Dict[str, ConfigDefaultImageItem] = None
+

Allows override default image build arguments.

+
+ +
+
+registry: str = 'gcr.io/hdl-containers'
+

Default registry prefix.

+
+ +
+ +
+
+class pyHDLC.ConfigJobs(default: ~typing.Dict[str, ~typing.Dict[str, ~typing.List[str]]] = <factory>, pkgonly: ~typing.Dict[str, ~typing.Dict[str, ~typing.List[str]]] = <factory>, runonly: ~typing.Dict[str, ~typing.Dict[str, ~typing.List[str]]] = <factory>, custom: ~typing.Dict[str, ~pyHDLC.ConfigJobsCustomItem] = <factory>)
+

List of jobs/tasks to be used in CI to dynamically spawn jobs. +See Jobs.

+
+
+custom: Dict[str, ConfigJobsCustomItem]
+

Declare the lists of jobs/tasks as cross-products (exclude is supported).

+
+ +
+
+default: Dict[str, Dict[str, List[str]]]
+

Build two images for each collection and architecture, a regular image and a package image.

+
+ +
+
+pkgonly: Dict[str, Dict[str, List[str]]]
+

Build a package image for each collection and architecture.

+
+ +
+
+runonly: Dict[str, Dict[str, List[str]]]
+

Build a regular image for each collection and architecture.

+
+ +
+ +
+
+class pyHDLC.ConfigJobsCustomExcludeItem(sys: Dict[str, List[str]], params: Dict[str, str])
+

An exclusion rule for a list of taks generated through a cross-product.

+
+
+params: Dict[str, str]
+

Combination of argument values to exclude.

+
+ +
+
+sys: Dict[str, List[str]]
+

Collection(s) and architecture(s).

+
+ +
+ +
+
+class pyHDLC.ConfigJobsCustomItem(images: ~typing.List[~typing.Any], sys: ~typing.Dict[str, ~typing.List[str]], exclude: ~typing.List[~pyHDLC.ConfigJobsCustomExcludeItem] = <factory>)
+

A custom list of jobs/tasks defined by combining lists of images and system, optionally applying exclusion rules.

+
+
+exclude: List[ConfigJobsCustomExcludeItem]
+

Optionally, declare combinations of sys and images which should be excluded from the produced cross-products.

+
+ +
+
+images: List[Any]
+

Either a list or a list of lists of image names. +Argument substitution is supported through ${arg}.

+
+ +
+
+sys: Dict[str, List[str]]
+

Collection(s) and architecture(s).

+
+ +
+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/genindex.html b/genindex.html new file mode 100644 index 000000000..e46f75039 --- /dev/null +++ b/genindex.html @@ -0,0 +1,642 @@ + + + + + + Index — HDL Containers: Building and deploying container images for open source Electronic Design Automation latest documentation + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+ + +
+ +
+
+ +
+
+ + +

Index

+ +
+ Symbols + | B + | C + | G + | I + | M + | N + | P + | T + +
+

Symbols

+ + + +
+ +

B

+ + +
+ +

C

+ + +
+ +

G

+ + +
+ +

I

+ + +
+ +

M

+ + +
    +
  • + module + +
  • +
+ +

N

+ + +
+ +

P

+ + + +
+ +

T

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

© Copyright 2019-2023, Unai Martinez-Corral and contributors.

+
Built with Sphinx using a + theme + provided by Build the Docs. + + +
+
+
+
+
+ + + + \ No newline at end of file diff --git a/index.html b/index.html new file mode 100644 index 000000000..7e7941bfc --- /dev/null +++ b/index.html @@ -0,0 +1,147 @@ + + + + + + + HDL Containers — HDL Containers: Building and deploying container images for open source Electronic Design Automation latest documentation + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+ + +
+
+ +
+

HDL Containers

+

+'hdl/containers GitHub repository' +'Code License' +'Documentation License' +'hdl/community on gitter.im'


_images/banner_path.svg +
+ +

This repository contains scripts and recipes for building, testing and deploying OCI +images (aka Docker | Podman images) including open source +Electronic Design Automation (EDA) tooling. +All the images are pushed to gcr.io/hdl-containers, and mirrored to +ghcr.io/hdl and hub.docker.com/u/hdlc:

+

+'Google Container Registry' 'GitHub Container Registry' 'Docker Hub'

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

© Copyright 2019-2023, Unai Martinez-Corral and contributors.

+
Built with Sphinx using a + theme + provided by Build the Docs. + + +
+
+
+
+
+ + + + \ No newline at end of file diff --git a/objects.inv b/objects.inv new file mode 100644 index 000000000..61e3c6a5d Binary files /dev/null and b/objects.inv differ diff --git a/py-modindex.html b/py-modindex.html new file mode 100644 index 000000000..f0ce4580a --- /dev/null +++ b/py-modindex.html @@ -0,0 +1,153 @@ + + + + + + Python Module Index — HDL Containers: Building and deploying container images for open source Electronic Design Automation latest documentation + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+ + +
+
    +
  • »
  • +
  • Python Module Index
  • +
  • +
  • +
+
+
+ +
+
+ + +

Python Module Index

+ +
+ p +
+ + + + + + + +
 
+ p
+ pyHDLC +
+ + +
+
+
+ +
+ +
+

© Copyright 2019-2023, Unai Martinez-Corral and contributors.

+
Built with Sphinx using a + theme + provided by Build the Docs. + + +
+
+
+
+
+ + + + \ No newline at end of file diff --git a/search.html b/search.html new file mode 100644 index 000000000..099b0075f --- /dev/null +++ b/search.html @@ -0,0 +1,150 @@ + + + + + + Search — HDL Containers: Building and deploying container images for open source Electronic Design Automation latest documentation + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+ + +
+
    +
  • »
  • +
  • Search
  • +
  • +
  • +
+
+
+ +
+
+ + + + +
+ +
+ +
+
+
+ +
+ +
+

© Copyright 2019-2023, Unai Martinez-Corral and contributors.

+
Built with Sphinx using a + theme + provided by Build the Docs. + + +
+
+
+
+
+ + + + + + + + + \ No newline at end of file diff --git a/searchindex.js b/searchindex.js new file mode 100644 index 000000000..a3f34bcc2 --- /dev/null +++ b/searchindex.js @@ -0,0 +1 @@ +Search.setIndex({"docnames": ["About", "CollectionsAndArchitectures", "Doc-License", "License", "References", "ToolsAndImages", "dev/CI", "dev/Contributing", "dev/GraphGeneration", "dev/Graphs", "dev/PackageImages", "dev/Tasks", "dev/Utils", "dev/pyHDLC_Reference", "index", "ug/AllInOne", "ug/FineGrained", "ug/GUI", "ug/USBIP", "ug/index"], "filenames": ["About.rst", "CollectionsAndArchitectures.rst", "Doc-License.rst", "License.rst", "References.rst", "ToolsAndImages.rst", "dev/CI.rst", "dev/Contributing.rst", "dev/GraphGeneration.rst", "dev/Graphs.rst", "dev/PackageImages.rst", "dev/Tasks.rst", "dev/Utils.rst", "dev/pyHDLC_Reference.rst", "index.rst", "ug/AllInOne.rst", "ug/FineGrained.rst", "ug/GUI.rst", "ug/USBIP.rst", "ug/index.rst"], "titles": ["About", "Collections and architectures", "Creative Commons Attribution 4.0 International", "Apache License 2.0", "References", "Tools and images", "Continuous Integration (CI)", "Contributing", "Graph generation/parsing", "Graphs", "Package images", "Tasks", "Utils", "pyHDLC Reference", "HDL Containers", "All-in-one images", "Fine-grained pulling", "Tools with GUI", "USB/IP protocol support for Docker Desktop", "Introduction"], "terms": {"unai": 0, "martinez": 0, "corral": 0, "github": [0, 5, 6, 7, 11, 12, 15, 19], "gitlab": 0, "twitter": 0, "contributor": [0, 3, 5, 6, 9, 10, 12], "thi": [0, 1, 2, 3, 5, 6, 7, 8, 9, 10, 12, 13, 14, 15, 16, 19], "project": [0, 2, 3, 4, 7, 9, 10, 11, 12, 16, 18, 19], "start": [0, 18], "earli": [0, 18], "2017": 0, "repositori": [0, 1, 6, 7, 12, 14, 16], "gh": [0, 4, 7, 8, 12, 15, 16, 17, 18, 19], "ghdl": [0, 4, 5, 12, 16], "which": [0, 1, 2, 3, 5, 6, 7, 8, 9, 10, 12, 13, 16, 19], "wa": [0, 3, 5, 7, 10], "name": [0, 1, 3, 6, 7, 9, 11, 12, 13, 15, 16, 18, 19], "tgingold": 0, "back": 0, "The": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 16, 18], "main": [0, 5, 7, 12], "purpos": [0, 2, 3, 8, 10, 19], "test": [0, 5, 6, 7, 9, 13, 14, 18, 19], "multipl": [0, 1, 7, 8, 9, 10, 12, 15, 16, 17], "gnu": [0, 10, 17, 18], "linux": [0, 4, 7, 10, 17, 18], "distribut": [0, 2, 3, 7, 10], "debian": [0, 1, 7, 9, 12, 13], "ubuntu": 0, "fedora": 0, "sinc": [0, 6, 7, 8, 10, 12, 16, 18], "travi": 0, "ci": [0, 4, 7, 8, 12, 13, 15, 16, 19], "support": [0, 3, 4, 6, 7, 8, 10, 12, 13, 16, 17, 19], "onli": [0, 1, 2, 3, 5, 7, 10, 13, 16, 18], "docker": [0, 1, 4, 7, 8, 11, 12, 13, 14, 15, 17, 19], "For": [0, 2, 3, 7, 8, 9, 12, 18, 19], "each": [0, 1, 3, 6, 7, 9, 10, 12, 13, 16, 19], "target": [0, 5, 7, 12, 13, 15], "platform": [0, 11], "two": [0, 6, 7, 8, 12, 13], "imag": [0, 1, 2, 4, 6, 7, 9, 11, 12, 13, 14, 16, 18, 19], "were": [0, 8], "us": [0, 1, 3, 4, 5, 6, 7, 8, 9, 10, 12, 13, 15, 16, 17, 18, 19], "one": [0, 1, 2, 3, 6, 7, 8, 12, 18, 19], "build": [0, 1, 4, 6, 7, 8, 10, 13, 14, 15, 18], "anoth": [0, 12], "later": 0, "most": [0, 2, 6, 8, 10, 12, 18], "relat": [0, 2, 9, 17], "sourc": [0, 3, 5, 7, 8, 9, 12, 14, 15, 16, 17, 18], "split": 0, "There": [0, 6, 8, 12, 16, 18], "some": [0, 1, 5, 6, 7, 8, 9, 10, 12, 15], "addit": [0, 2, 7, 12, 13, 16], "simul": [0, 6], "tool": [0, 1, 4, 6, 7, 8, 9, 10, 11, 12, 14, 15, 16, 18, 19], "ad": [0, 7, 10, 12, 18], "vunit": [0, 5], "gtkwave": [0, 5, 17], "includ": [0, 2, 3, 6, 7, 10, 14, 15, 18], "languag": [0, 3, 8], "server": [0, 4, 17, 18], "also": [0, 2, 3, 6, 8, 15, 16], "when": [0, 1, 5, 7, 8, 10, 12, 18], "experiment": [0, 8], "synthesi": [0, 6, 16], "2019": 0, "provid": [0, 1, 2, 3, 4, 5, 6, 7, 12, 13, 15, 16, 17, 19], "plugin": [0, 5], "yosi": [0, 5, 12, 16], "contain": [0, 3, 5, 7, 8, 9, 10, 11, 12, 13, 15, 16, 17, 18, 19], "complet": 0, "open": [0, 7, 8, 14, 16, 17, 18], "bitstream": [0, 15], "gener": [0, 3, 5, 6, 7, 12, 13, 15], "formal": [0, 6, 7, 9, 12, 15], "verif": 0, "workflow": [0, 1, 6, 7, 9, 15, 16, 19], "request": [0, 2, 6, 7], "contribut": [0, 2], "those": [0, 2, 3, 5, 6, 7, 8, 9, 10, 12, 16, 18, 19], "nextpnr": [0, 5, 12, 16, 17], "icestorm": [0, 5, 12, 16], "prjtrelli": [0, 5, 12], "symbiyosi": 0, "etc": [0, 12], "At": [0, 6], "point": [0, 7], "had": 0, "much": [0, 5], "content": [0, 2, 3, 8, 10, 11, 12, 13], "non": [0, 2, 3, 8, 12], "resourc": [0, 2, 5, 16], "In": [0, 2, 3, 5, 6, 7, 9, 10, 11, 12, 16, 18, 19], "second": [0, 6, 8], "half": 0, "share": [0, 1, 2, 3, 7, 18, 19], "develop": [0, 4, 5, 6, 18, 19], "effort": 0, "propos": 0, "maintain": [0, 9], "yosyshq": 0, "1287": 0, "librecor": [0, 16], "33": 0, "went": 0, "unfortun": [0, 8], "unnot": 0, "same": [0, 3, 6, 7, 8, 12, 16, 18], "time": [0, 2, 7, 12], "f4pga": [0, 9, 12], "aim": 0, "gather": 0, "an": [0, 2, 3, 5, 7, 8, 10, 12, 13, 16, 17, 18, 19], "integr": [0, 1, 2, 7, 19], "eda": [0, 4, 5, 10, 14, 16], "solut": [0, 7, 8, 18, 19], "howev": [0, 1, 2, 3, 5, 6, 7, 8, 10, 11, 12, 17, 18, 19], "did": [0, 18], "have": [0, 1, 2, 3, 7, 8], "offici": [0, 2, 19], "help": [0, 9, 10], "want": [0, 8, 15, 17], "initi": 0, "creat": [0, 2, 7, 9, 10, 11, 12], "move": [0, 2, 19], "all": [0, 2, 3, 5, 6, 7, 8, 9, 10, 12, 13, 14, 16, 19], "part": [0, 2, 3], "from": [0, 2, 3, 5, 6, 7, 8, 10, 12, 13, 15, 16, 18], "partial": [0, 16], "still": [0, 2], "i": [0, 1, 2, 3, 5, 6, 7, 8, 9, 10, 11, 12, 13, 15, 16, 17, 18, 19], "focus": 0, "verilog": [0, 5], "scope": 0, "widen": 0, "vhdl": [0, 15], "publish": [0, 1, 2, 11, 18], "2020": 0, "parallel": 0, "form": [0, 2, 3], "dbhi": 0, "qu": 0, "see": [0, 1, 3, 5, 6, 7, 8, 9, 11, 12, 13, 15, 16, 18, 19], "qemu": 0, "user": [0, 1, 7, 10, 12, 15, 17, 18, 19], "static": 0, "generalis": 0, "multiarch": 0, "multi": [0, 7], "architectur": [0, 5, 7, 10, 12, 13, 15, 16, 19], "manifest": 0, "continu": [0, 1, 7, 19], "servic": [0, 2, 3, 7, 11], "amd64": [0, 1, 12, 13], "host": [0, 7, 17, 18], "sai": 0, "action": [0, 5, 6, 7, 11, 12, 15], "current": [0, 7, 8, 11], "foreign": 0, "until": 0, "end": 0, "limit": [0, 5, 16], "fpga": [0, 4, 5], "through": [0, 2, 3, 5, 6, 7, 8, 9, 10, 11, 12, 13, 18, 19], "io": [0, 1, 7, 8, 11, 12, 13, 14, 15, 16, 18], "2021": 0, "asic": [0, 6, 9], "ar": [0, 1, 2, 3, 5, 6, 7, 8, 9, 10, 11, 12, 14, 15, 16, 17, 18, 19], "other": [0, 1, 3, 5, 7, 8, 9, 10, 11, 12, 16, 17, 18, 19], "registri": [0, 1, 5, 7, 10, 11, 12, 13, 19], "well": [0, 2, 19], "gcr": [0, 1, 7, 11, 12, 13, 14, 15, 16], "ghcr": [0, 1, 11, 14], "organis": [1, 11], "built": [1, 5, 7, 10, 12, 13, 16, 18], "A": [1, 2, 3, 4, 7, 12, 13], "set": [1, 2, 5, 6, 7, 8, 10, 11, 12, 13, 17], "common": [1, 3, 6, 7, 12, 15], "ancestor": 1, "base": [1, 2, 3, 4, 5, 6, 7, 9, 10, 12, 13, 16, 18, 19], "layer": [1, 6, 12, 16], "allow": [1, 2, 5, 8, 12, 13, 16, 18], "reduc": [1, 2, 8, 12, 13], "bandwidth": 1, "disk": [1, 5, 8], "usag": [1, 7, 10, 12, 18], "pull": [1, 5, 6, 7, 13, 19], "sever": [1, 2, 6, 7, 16], "them": [1, 2, 8, 12, 13, 16, 19], "doc": [1, 6, 7, 9, 11, 12, 15, 18, 19], "com": [1, 4, 6, 7, 11, 12, 14, 15, 16, 18, 19], "about": [1, 6, 7, 12, 18], "storag": [1, 18], "driver": [1, 18], "bookworm": [1, 7, 12], "slim": [1, 5, 12], "bullsey": [1, 7, 12, 13], "default": [1, 5, 7, 8, 10, 11, 13, 17, 18], "rockylinux": 1, "8": [1, 5, 7, 9], "deprec": 1, "none": [1, 8, 12, 13], "remov": [1, 2, 7, 11, 18], "buster": [1, 9, 12], "cento": [1, 9], "7": [1, 5, 9], "arm32v7": 1, "arm64v8": 1, "ppc64le": 1, "s390x": 1, "mips64l": 1, "riscv64": 1, "both": [1, 19], "field": [1, 3, 12, 13, 19], "architecur": 1, "option": [1, 7, 8, 13, 16, 17, 18], "becaus": [1, 2, 5, 8, 12, 17], "mirror": [1, 12, 13, 14], "pkg": [1, 4, 7, 10, 12, 13], "tag": [1, 12, 19], "document": [1, 2, 3, 6, 7, 8, 10, 16, 19], "without": [1, 2, 3, 7, 12, 13, 19], "prefix": [1, 7, 10, 12, 13, 19], "henc": [1, 7, 8, 9, 10, 15, 19], "list": [1, 3, 6, 7, 11, 12, 13, 18], "abov": [1, 2, 3], "need": [1, 2, 7, 8, 10, 11, 12, 13, 18, 19], "actual": [1, 7], "guid": [1, 7], "further": [1, 5, 7], "detail": [1, 5, 6, 7, 9, 12, 18], "tabl": [1, 5, 7], "show": [1, 12], "avail": [1, 2, 3, 9, 11, 12, 15, 18, 19], "subset": [1, 12], "brows": [1, 12], "find": [1, 7, 12], "than": [1, 2, 4, 5], "local": [2, 3, 6, 7, 8, 10, 12, 19], "copi": [2, 3, 7, 8, 10, 12, 13, 18], "cc": 2, "BY": 2, "appli": [2, 8, 13], "corpor": 2, "law": [2, 3], "firm": 2, "doe": [2, 3, 8, 18], "legal": [2, 3], "advic": 2, "lawyer": 2, "client": [2, 4, 8, 18], "relationship": 2, "make": [2, 3, 4, 7, 10, 15, 16, 17], "its": [2, 3], "inform": [2, 3, 8], "basi": [2, 3], "give": [2, 3, 8], "regard": [2, 3, 12], "ani": [2, 3, 7, 8, 12, 13, 16, 18], "materi": 2, "under": [2, 3, 7], "damag": [2, 3], "result": [2, 3, 5, 8, 10, 18], "fullest": 2, "extent": 2, "possibl": [2, 3, 8, 18], "standard": [2, 7, 10], "creator": 2, "holder": 2, "mai": [2, 3], "origin": [2, 3], "work": [2, 7, 8], "authorship": [2, 3], "subject": [2, 3], "copyright": 2, "certain": 2, "specifi": [2, 12, 13], "below": [2, 3, 5, 8, 12], "follow": [2, 3, 5, 6, 8, 12, 16], "consider": 2, "exhaust": 2, "do": [2, 3, 7, 8, 10, 11, 12, 13, 18], "our": 2, "licensor": [2, 3], "intend": 2, "author": [2, 3], "permiss": [2, 3, 18], "wai": 2, "otherwis": [2, 3, 12], "restrict": 2, "irrevoc": [2, 3], "should": [2, 3, 7, 8, 10, 12, 13, 18], "read": [2, 6], "understand": [2, 9, 10], "thei": [2, 7, 8, 10, 12, 19], "choos": [2, 3], "befor": [2, 7, 12], "secur": [2, 17], "necessari": [2, 7], "so": [2, 6, 8], "can": [2, 6, 7, 8, 9, 12, 15, 16, 18], "reus": [2, 12], "expect": [2, 7, 10, 12, 15, 19], "clearli": 2, "mark": [2, 3, 5], "except": [2, 3, 5, 10], "more": [2, 3, 7, 12], "By": [2, 5, 12, 17], "grant": 2, "If": [2, 3, 7, 12], "": [2, 3, 4, 5, 7, 8, 9, 12, 13, 15, 18], "reason": [2, 3], "exampl": [2, 3, 4, 12, 15, 16, 19], "applic": [2, 3, 17], "regul": 2, "ha": [2, 3], "special": [2, 3], "ask": 2, "chang": [2, 3], "describ": [2, 3, 9], "although": [2, 8], "requir": [2, 3, 7, 8, 10, 11, 12, 18], "you": [2, 3, 7, 8, 18], "encourag": 2, "respect": [2, 12], "where": [2, 3, 7, 9, 12, 13, 18], "exercis": [2, 3], "defin": [2, 3, 6, 7, 8, 12, 13], "accept": 2, "agre": [2, 3], "bound": 2, "To": [2, 3, 7], "contract": [2, 3], "your": [2, 7], "benefit": 2, "receiv": [2, 3], "adapt": [2, 7], "mean": [2, 3], "similar": [2, 7, 8, 12], "deriv": [2, 3], "upon": 2, "translat": [2, 3], "alter": 2, "arrang": 2, "transform": [2, 3], "modifi": [2, 3, 10], "manner": 2, "held": 2, "music": 2, "perform": [2, 3], "sound": 2, "record": 2, "alwai": 2, "produc": [2, 7, 12, 13], "synch": 2, "accord": [2, 12], "close": 2, "broadcast": 2, "how": [2, 9, 16, 18], "label": 2, "categor": 2, "b": 2, "effect": 2, "technolog": 2, "measur": 2, "absenc": 2, "proper": 2, "circumv": 2, "fulfil": 2, "oblig": [2, 3], "articl": 2, "11": 2, "wipo": 2, "treati": 2, "adopt": 2, "decemb": 2, "20": 2, "1996": 2, "agreement": [2, 3], "fair": 2, "deal": 2, "artist": 2, "literari": 2, "individu": [2, 3], "entiti": [2, 3], "process": [2, 4], "reproduct": [2, 3], "displai": [2, 3], "dissemin": 2, "commun": [2, 3, 19], "import": [2, 3, 12], "member": 2, "access": [2, 18], "place": [2, 3, 15], "chosen": 2, "direct": [2, 3, 9], "96": 2, "9": [2, 9], "ec": 2, "european": 2, "parliament": 2, "council": 2, "march": 2, "protect": 2, "amend": 2, "succeed": 2, "essenti": 2, "equival": [2, 6], "anywher": 2, "world": 2, "correspond": [2, 5, 7, 9, 10, 12, 18], "herebi": [2, 3], "worldwid": [2, 3], "royalti": [2, 3], "free": [2, 3, 18], "sublicens": [2, 3], "exclus": [2, 3, 13], "reproduc": [2, 3, 8], "whole": [2, 3, 11], "avoid": 2, "doubt": 2, "compli": [2, 3], "media": [2, 3], "format": [2, 3, 5, 8, 9, 12, 13], "technic": [2, 8], "modif": [2, 3], "whether": [2, 3, 9, 13], "now": [2, 18], "known": [2, 8], "hereaft": 2, "waiv": 2, "assert": [2, 3], "forbid": 2, "simpli": 2, "never": 2, "downstream": 2, "recipi": [2, 3], "offer": [2, 3], "everi": 2, "automat": [2, 8], "No": 2, "impos": 2, "differ": [2, 3, 6, 8, 9, 10, 12], "endors": 2, "noth": [2, 3], "constitut": [2, 3], "constru": [2, 3], "impli": [2, 3], "connect": [2, 18], "sponsor": 2, "statu": [2, 7], "design": [2, 3, 14, 16], "moral": 2, "nor": 2, "privaci": 2, "person": 2, "patent": 2, "trademark": 2, "collect": [2, 7, 9, 10, 12, 13, 15, 16, 19], "directli": [2, 18], "societi": 2, "voluntari": 2, "waivabl": 2, "statutori": 2, "compulsori": 2, "scheme": 2, "case": [2, 7, 8, 10, 15], "expressli": 2, "reserv": 2, "made": [2, 3], "must": [2, 3, 10], "retain": [2, 3], "suppli": 2, "identif": [2, 3], "pseudonym": 2, "notic": [2, 3], "refer": [2, 6, 7, 8, 12], "uri": 2, "hyperlink": 2, "practic": [2, 6, 9, 19], "indic": [2, 3], "previou": 2, "text": [2, 3, 5, 8], "satisfi": [2, 8], "medium": [2, 3], "context": [2, 6], "prevent": [2, 18], "extract": [2, 12, 13], "substanti": 2, "portion": 2, "supplement": 2, "replac": [2, 3, 8, 15, 18], "unless": [2, 3], "separ": [2, 3, 10], "undertaken": 2, "represent": [2, 8], "kind": [2, 3, 6, 7, 8, 12], "concern": 2, "express": [2, 3], "titl": [2, 3], "merchant": [2, 3], "fit": [2, 3, 8, 9, 19], "particular": [2, 3], "infring": [2, 3], "latent": 2, "defect": 2, "accuraci": 2, "presenc": 2, "error": [2, 8], "discover": 2, "full": [2, 15, 17, 18], "event": [2, 3, 6], "liabl": [2, 3], "theori": [2, 3], "neglig": [2, 3, 8], "indirect": [2, 3], "incident": [2, 3], "consequenti": [2, 3], "punit": 2, "exemplari": 2, "loss": [2, 3], "cost": 2, "expens": 2, "aris": [2, 3], "out": [2, 3], "even": [2, 3], "been": [2, 3], "advis": [2, 3], "shall": [2, 3], "approxim": [2, 5], "absolut": 2, "waiver": 2, "here": [2, 7], "fail": 2, "reinstat": 2, "date": [2, 3], "violat": 2, "cure": 2, "within": [2, 3], "30": [2, 5], "dai": 2, "discoveri": 2, "affect": 2, "seek": 2, "remedi": 2, "stop": 2, "surviv": 2, "state": [2, 3, 18], "herein": [2, 3], "independ": 2, "could": [2, 18], "lawfulli": 2, "provis": 2, "deem": 2, "unenforc": 2, "reform": 2, "minimum": 2, "enforc": 2, "cannot": [2, 3, 17], "remain": [2, 3], "failur": [2, 3], "consent": 2, "privileg": [2, 18], "immun": 2, "jurisdict": 2, "parti": [2, 3], "notwithstand": [2, 3], "elect": 2, "instanc": [2, 7, 9, 12, 15], "consid": 2, "permit": 2, "polici": 2, "creativecommon": 2, "org": [2, 3, 4, 8, 12, 18], "logo": 2, "prior": 2, "written": [2, 3, 8], "unauthor": 2, "paragraph": 2, "contact": 2, "version": [3, 5, 7, 13], "configur": [3, 6, 7, 8, 13, 18], "file": [3, 6, 11, 13, 18], "januari": 3, "2004": 3, "term": 3, "AND": 3, "condit": [3, 12], "FOR": 3, "section": 3, "owner": 3, "union": [3, 13], "act": [3, 8], "control": 3, "power": 3, "caus": 3, "manag": [3, 5, 11, 16], "ii": 3, "ownership": 3, "fifti": 3, "percent": 3, "50": 3, "outstand": 3, "iii": 3, "benefici": 3, "prefer": 3, "softwar": 3, "code": [3, 10], "object": 3, "mechan": [3, 6], "compil": 3, "convers": [3, 12], "type": [3, 7, 9, 12, 13], "attach": 3, "editori": 3, "revis": 3, "annot": 3, "elabor": 3, "repres": [3, 9], "mere": 3, "link": [3, 8, 18], "bind": [3, 7, 18], "interfac": [3, 6, 17], "thereof": 3, "intention": 3, "submit": 3, "inclus": 3, "behalf": 3, "electron": [3, 14, 16], "verbal": 3, "sent": 3, "mail": [3, 11], "system": [3, 4, 5, 13], "issu": [3, 7, 8, 10, 18], "track": [3, 9], "discuss": 3, "improv": [3, 16], "exclud": [3, 12, 13], "conspicu": 3, "write": [3, 7, 8, 19], "Not": 3, "whom": 3, "subsequ": 3, "incorpor": 3, "perpetu": 3, "charg": 3, "prepar": [3, 15], "publicli": [3, 12], "sell": 3, "transfer": 3, "claim": 3, "necessarili": 3, "alon": 3, "combin": [3, 12, 13, 16], "institut": 3, "litig": 3, "against": 3, "cross": [3, 4, 12, 13], "counterclaim": 3, "lawsuit": 3, "alleg": 3, "contributori": 3, "termin": [3, 8, 12], "meet": 3, "carri": 3, "promin": 3, "attribut": 3, "pertain": 3, "readabl": 3, "least": [3, 7], "along": [3, 7, 15, 16, 18], "wherev": 3, "third": 3, "normal": 3, "appear": 3, "add": [3, 7, 8, 18], "own": 3, "alongsid": 3, "addendum": 3, "statement": [3, 7, 8], "explicitli": [3, 6, 7, 8, 10, 12, 13], "supersed": 3, "execut": [3, 5, 6, 8, 12, 13, 16, 17, 18], "trade": 3, "product": [3, 8, 12, 13], "customari": 3, "AS": [3, 7], "OR": 3, "OF": 3, "either": [3, 5, 7, 8, 12, 13, 18], "sole": 3, "respons": 3, "determin": 3, "appropri": 3, "assum": [3, 15], "risk": 3, "associ": 3, "tort": 3, "deliber": 3, "grossli": 3, "charact": 3, "inabl": 3, "goodwil": 3, "stoppag": 3, "comput": 3, "malfunct": 3, "commerci": 3, "while": 3, "fee": 3, "indemn": 3, "right": [3, 12], "consist": 3, "indemnifi": 3, "defend": 3, "hold": [3, 15], "harmless": 3, "incur": 3, "boilerpl": 3, "enclos": 3, "bracket": 3, "identifi": [3, 12, 13, 18], "don": [3, 7, 8], "t": [3, 7, 8, 12, 18], "comment": 3, "syntax": [3, 6, 7, 12, 13, 15], "we": [3, 8, 18], "recommend": [3, 6, 7, 15, 16, 19], "class": [3, 13], "descript": 3, "print": [3, 8, 12, 13], "page": [3, 12], "easier": 3, "archiv": 3, "yyyi": 3, "complianc": 3, "obtain": 3, "http": [3, 11, 15, 18], "www": [3, 18], "specif": [3, 5, 11, 12, 19], "govern": 3, "hadolint": 4, "haskel": 4, "dockerfil": [4, 9, 10, 12, 13, 19], "linter": 4, "0x01be": 4, "rudder": 4, "mluckydwy": 4, "hw": 4, "limerainn": 4, "alpin3": 4, "ulx3": 4, "vmunoz82": 4, "eda_tool": 4, "ein": 4, "elid": 4, "cdsteinkuehl": 4, "quartusbuildvm": 4, "setup": [4, 5, 6, 11, 12, 15], "hackfin": 4, "mk": 4, "rfdonnelli": 4, "questa": 4, "symbiflow": 4, "env": 4, "bit": [4, 15], "ly": 4, "edda": 4, "conda": [4, 12, 15], "spec": 4, "dev": [4, 7, 18], "environ": [4, 7, 10, 12, 15, 16, 17, 19], "rather": 4, "15": [4, 5], "im": [4, 19], "tomu": [4, 19], "fomu": [4, 19], "toolchain": [4, 5, 15], "antmicro": [4, 5], "runner": 4, "googlecontainertool": 4, "chainguard": 4, "melang": 4, "apko": 4, "manual": [4, 6, 8, 18], "dockertool": 4, "nix": 4, "tutori": [4, 18], "run": [4, 7, 12, 15, 16, 17, 18], "infrastructur": 4, "lcci": 4, "lccitool": 4, "lccidock": 4, "openroad": [4, 5], "efabless": 4, "openlan": 4, "foss": 4, "hpretl": 4, "iic": 4, "osic": 4, "mabrain": 4, "openanalogdesign": 4, "risc": 4, "v": [4, 12, 15, 16, 18], "bring": 4, "up": [4, 6, 17], "tracker": 4, "step": [4, 6, 15], "layout": 4, "cmo": 4, "invert": 4, "skywat": [4, 5], "technologi": 4, "skw": 4, "130nm": 4, "salrashid123": 4, "gcr_stat": 4, "gregsrambl": 4, "cloud": [4, 11], "4": [4, 9, 18], "word": 4, "cheat": 4, "sheet": 4, "go": [4, 11], "containerregistri": 4, "cmd": [4, 7], "crane": 4, "readm": [4, 18], "md": [4, 7], "gw0": [4, 18], "alpin": [4, 18], "kernel": [4, 18], "modul": [4, 8, 18], "virtualher": [4, 18], "window": [4, 17, 18], "consol": 4, "api": [4, 8], "hub": [4, 14, 15, 18], "r": [4, 12], "latest": [5, 18], "branch": [5, 8], "master": 5, "Then": [5, 6, 7, 8], "smoke": [5, 7], "success": 5, "updat": [5, 7, 8, 11], "instal": [5, 7, 10, 12, 18], "packag": [5, 7, 12, 13, 18], "readi": [5, 7, 12, 15, 16], "f": [5, 12], "p": [5, 7, 12], "apicula": 5, "arachn": 5, "pnr": [5, 6], "boolector": 5, "cocotb": 5, "cvc": 5, "graphviz": [5, 8, 9], "irsim": 5, "magic": 5, "iverilog": 5, "klayout": [5, 17], "netgen": 5, "nvc": 5, "openfpgaload": 5, "openocd": 5, "pono": 5, "prjoxid": [5, 12], "superprov": 5, "sby": 5, "veribl": 5, "veril": 5, "vtr": 5, "yices2": 5, "xschem": 5, "xyce": 5, "z3": 5, "compos": [5, 7, 19], "imul": 5, "icaru": 5, "osvvm": 5, "top": [5, 7, 15], "sim": [5, 9, 12], "matplotlib": 5, "numpi": 5, "osvb": 5, "scipi": [5, 12], "octav": [5, 12], "gnuplot": 5, "mplement": 5, "ice40": [5, 12, 16], "ecp5": [5, 12], "nexu": [5, 12], "impl": [5, 7, 9, 15], "ormal": 5, "solver": 5, "depend": [5, 7, 9, 10, 12, 16], "python": [5, 6, 7, 8, 12], "3": [5, 7, 9, 12, 16], "2": [5, 9], "rogram": 5, "ecosystem": [5, 7, 9, 10, 12], "vendor": 5, "found": [5, 18], "hdl": [5, 7, 11, 12, 13, 15, 16, 18, 19], "complement": [5, 12], "miniconda": [5, 15], "On": [5, 7, 8, 18], "guidelin": [5, 7, 19], "fpga_fam": 5, "xc7": [5, 12, 15], "definit": [5, 7, 15], "xc7a50t": 5, "xc7a100t": 5, "xc7a200t": 5, "xc7z010": 5, "xc7z020": 5, "famili": 5, "due": 5, "hard": 5, "eo": [5, 15], "s3": [5, 15], "compress": 5, "ratio": 5, "veri": [5, 8, 10, 18], "high": 5, "compar": 5, "That": [5, 7, 8, 9, 12, 18, 19], "signific": 5, "amount": 5, "data": [5, 6, 12], "better": [5, 10], "binari": 5, "As": [5, 6, 7, 8, 10, 15, 18], "size": [5, 8], "gb": 5, "a50t": [5, 12], "6": [5, 9], "a100t": [5, 12, 15], "5": [5, 9], "a200t": [5, 12], "z010": 5, "z020": 5, "18": 5, "would": [5, 8, 13], "ngspice": 5, "googl": [5, 11], "pdk": 5, "374": 5, "bitman": 5, "ecpprog": 5, "fujprog": 5, "netlistsvg": [5, 8], "ecpdap": 5, "lsoracl": 5, "opensourcetcad": 5, "moment": 6, "trigger": 6, "between": [6, 7, 9, 12, 18], "repo": [6, 7], "push": [6, 7, 11, 13, 14], "cron": 6, "job": [6, 7, 13], "lint": 6, "prog": [6, 7, 18], "command": [6, 7, 12, 13, 16, 18], "util": [6, 7, 8, 10], "pyhdlc": [6, 8], "exactli": 6, "debug": [6, 8], "complex": [6, 8, 12, 18], "around": [6, 12, 19], "order": [6, 7, 10, 11, 12, 18], "precis": 6, "decid": 6, "shown": [6, 8, 9, 19], "fig": [6, 9], "12": 6, "wrapper": [6, 12, 16], "pytool": [6, 15], "explain": [6, 7, 9, 15, 18], "releas": 6, "composit": 6, "three": [6, 7, 12], "reusabl": [6, 7], "first": [6, 7, 8], "matrix": [6, 8], "task": [6, 7, 12, 13], "job_id": 6, "output": [6, 8, 9, 12, 13], "dynam": [6, 13], "dispatch": 6, "call": [6, 10, 16], "intern": [6, 18], "dozen": 6, "per": [6, 7, 10, 12], "group": [6, 7, 12], "hardcod": 6, "input": 6, "schedul": 6, "orchestr": 6, "yaml": [6, 7, 8, 13], "strongli": 6, "runtim": [7, 18], "These": [7, 9, 10, 15, 16], "rocki": 7, "ca": 7, "certif": 7, "curl": 7, "clang": 7, "cmake": [7, 15], "libboost": 7, "python3": 7, "scratch": [7, 10], "upload": 7, "pre": [7, 10], "asset": [7, 10], "therefor": [7, 8, 10, 12, 16, 19], "realli": 7, "se": [7, 10], "meant": [7, 8], "fact": [7, 12, 16], "merg": 7, "extend": [7, 12], "pleas": [7, 9, 18], "check": [7, 18], "let": [7, 8, 18], "u": [7, 8, 14, 18], "know": [7, 8, 18], "chat": [7, 8, 10], "someon": 7, "might": [7, 8, 9, 10, 18], "alreadi": [7, 15], "mani": [7, 8, 10, 19], "workload": 7, "aid": 7, "nonetheless": 7, "stage": [7, 8, 12, 13], "global": [7, 13], "argument": [7, 12, 13], "path": [7, 12, 15], "One": [7, 8], "custom": [7, 8, 12, 13], "locat": [7, 10, 12, 13], "destdir": [7, 10], "artifact": [7, 10, 18], "stage_nam": 7, "standalon": 7, "final": 7, "intermedi": [7, 10], "after": [7, 12, 13], "regular": [7, 12, 13, 16], "arg": [7, 12, 13], "apt": 7, "get": [7, 8, 13], "qq": 7, "debian_frontend": 7, "noninteract": 7, "y": [7, 18], "autoclean": 7, "clean": 7, "autoremov": 7, "rm": [7, 11, 12, 15, 16, 18], "rf": 7, "var": [7, 12], "lib": [7, 18], "git": [7, 15], "clone": [7, 15], "repository_url": 7, "tmp": 7, "cd": [7, 15], "j": [7, 8], "nproc": 7, "opt": [7, 10], "typic": [7, 10, 16, 19], "hand": [7, 8, 18], "subdir": [7, 9, 12, 18], "directori": [7, 12], "shell": [7, 12, 16, 18], "structur": 7, "builkit": 7, "mount": [7, 8], "featur": [7, 8, 15, 17, 18], "helper": [7, 12, 17], "strategi": [7, 16, 19], "decoupl": 7, "makedepend": 7, "mkdir": 7, "bash": 7, "arrai": 7, "extens": 7, "ctx": 7, "usr": [7, 10], "man": 7, "man1": 7, "reli": 7, "engin": 7, "analysi": [7, 8], "prune": 7, "furthermor": [7, 12], "enabl": [7, 18], "docker_buildkit": 7, "1": [7, 15, 18], "variabl": [7, 8, 10, 16, 19], "daemon": 7, "true": 7, "json": [7, 8, 11, 15], "mobi": [7, 8], "frontend": 7, "cach": [7, 19], "tmpf": 7, "secret": [7, 11], "ssh": 7, "apart": 7, "line": [7, 10], "recent": 7, "recip": [7, 10, 14], "exist": [7, 9, 10], "colour": [7, 8, 9, 10, 12, 15, 16], "brown": [7, 12, 15], "graph": [7, 10, 12, 15, 16], "tool_nam": [7, 10, 12, 16], "new": [7, 11, 16], "Be": 7, "care": 7, "suggest": [7, 19], "config": [7, 11, 12, 13, 18], "yml": [7, 12, 19], "overrid": [7, 13, 16], "ensur": [7, 18], "awesom": 7, "shield": 7, "badg": 7, "edit": [7, 8], "ciworkflow": 7, "conf": 7, "py": [7, 8, 16], "autogener": 7, "prone": 8, "ideal": 8, "auto": 8, "analys": 8, "trivial": 8, "diagram": 8, "larg": 8, "dataset": 8, "visual": 8, "hierarch": 8, "net": [8, 15], "willing": 8, "programmat": 8, "golang": 8, "dag": 8, "level": 8, "hierarchi": 8, "e": [8, 11, 18], "nest": 8, "cluster": 8, "node": 8, "port": [8, 18], "svg": 8, "style": 8, "shape": 8, "collaps": 8, "html": 8, "site": 8, "web": [8, 19], "far": 8, "windler": 8, "dotgraph": 8, "blockdiag": 8, "gephi": 8, "1594": 8, "aafigur": 8, "draw": 8, "jgraph": 8, "mxgraph": 8, "yed": 8, "texampl": 8, "tikz": 8, "ajstark": 8, "svgo": 8, "kieler": 8, "elkj": 8, "nic30": 8, "d3": 8, "hwschemat": 8, "nturlei": 8, "dagrej": 8, "dagr": 8, "graphdracula": 8, "probabl": 8, "interest": 8, "constraint": [8, 15], "editor": 8, "freewar": 8, "sdk": 8, "paid": 8, "toolkit": 8, "seem": [8, 10, 18], "interact": [8, 12], "feel": 8, "overkil": 8, "gui": [8, 12], "similarli": [8, 16], "librari": [8, 12], "done": 8, "plumb": 8, "increas": 8, "mainten": 8, "burden": 8, "instead": [8, 10, 12, 13], "last": 8, "resort": 8, "suitabl": 8, "demo": 8, "easi": 8, "side": 8, "achiev": 8, "yet": [8, 9, 10, 18], "straightforward": 8, "dot": 8, "illustr": 8, "advanc": [8, 11], "view": 8, "eclips": 8, "elk": 8, "rtsy": 8, "informatik": 8, "uni": 8, "kiel": 8, "de": 8, "elkliv": 8, "elkgraph": 8, "sprotti": 8, "cumbersom": 8, "edg": 8, "across": 8, "given": [8, 12], "map": [8, 9], "pymap": 8, "progress": 8, "generatemap": 8, "report": 8, "function": [8, 12], "elkjsgraph": 8, "try": [8, 17, 18], "join": 8, "awar": [8, 18], "asottil": 8, "wrap": [8, 16], "parser": 8, "semant": 8, "particularli": 8, "expand": 8, "nekto": 8, "piec": 9, "togeth": 9, "daunt": 9, "newcom": 9, "fortun": [9, 18], "travel": 9, "digraph": 9, "render": 9, "figur": 9, "subgraph": 9, "synth": 9, "arrow": 9, "legend": 9, "10": [9, 17, 18], "singl": [9, 12, 18, 19], "virtual": [9, 12, 15, 18, 19], "aggreg": 9, "miss": [9, 10, 18], "info": 9, "onc": [10, 12], "moreov": 10, "desir": [10, 12], "keep": [10, 19], "blue": 10, "runnabl": [10, 12], "mislead": 10, "correct": 10, "empti": [10, 12], "otherhow": 10, "taken": 10, "unset": [10, 12], "potenti": 10, "mix": 10, "temporari": [10, 12], "despit": 10, "being": [10, 12], "patch": 10, "script": [10, 12, 14, 16, 17, 18], "upstream": 10, "sometim": 10, "makefil": [10, 19], "hesit": 10, "reach": 10, "token": 11, "enough": 11, "gcp": 11, "cli": 11, "gcloud": 11, "period": 11, "kei": [11, 12], "outdat": 11, "ones": 11, "workspac": 11, "project_id": 11, "account": 11, "iam": 11, "note": 11, "gserviceaccount": 11, "save": [11, 18], "keyfil": 11, "gcr_json_kei": 11, "organ": 11, "expir": 11, "delet": 11, "key_id": 11, "authent": [11, 17], "bin": 12, "sh": [12, 18], "pip": 12, "txt": 12, "venv": 12, "virtualenv": 12, "activ": [12, 15], "easili": 12, "n": [12, 18], "happi": 12, "hack": 12, "noexec": 12, "paramet": [12, 13], "h": 12, "c": [12, 13, 15, 18], "argimg": [12, 13], "d": [12, 18], "q": [12, 16], "messag": 12, "exit": 12, "arch": 12, "pass": [12, 13, 18], "preprend": 12, "gha": [12, 13], "m": [12, 18], "placehold": [12, 13], "dirnam": [12, 13], "convent": 12, "subnam": 12, "_": 12, "submodul": 12, "fine": [12, 15, 19], "grain": [12, 15, 19], "cover": 12, "too": [12, 18], "It": [12, 18], "insid": [12, 18], "escap": 12, "green": [12, 16], "busybox": [12, 18], "altern": [12, 17], "wagoodman": 12, "dive": 12, "lightweight": [12, 19], "nice": 12, "explor": 12, "download": 12, "tarbal": 12, "zipfil": 12, "sock": 12, "dockerd": 12, "overriden": 12, "envvar": 12, "hdl_registri": 12, "convenienv": 12, "keyword": 12, "match": 12, "anchor": [12, 13], "ignor": [12, 13], "analyz": [12, 13], "verbos": [12, 13], "resolv": [12, 13], "loader": [12, 13], "blog": 12, "daemonl": 12, "dataclass": 12, "obviou": 12, "clarif": 12, "met": 12, "dictionari": 12, "four": 12, "pkgonli": [12, 13], "runonli": [12, 13], "declar": [12, 13], "sy": [12, 13], "sequenti": 12, "min": 12, "substitut": [12, 13], "item": 12, "string": 12, "phase": 12, "prj": 12, "sysdebianamd64": 12, "param": [12, 13], "buildimag": 13, "str": 13, "bool": 13, "fals": 13, "dry": 13, "bare": 13, "dure": 13, "testimag": 13, "just": 13, "generatejoblist": 13, "fmt": 13, "github_output": 13, "pullimag": 13, "pushimag": 13, "hdlc": [13, 14], "int": 13, "dict": 13, "factori": 13, "configdefault": 13, "configjob": 13, "spawn": 13, "configdefaultimageitem": 13, "configjobscustomitem": 13, "configjobscustomexcludeitem": 13, "rule": 13, "tak": 13, "valu": 13, "deploi": 14, "oci": [14, 17], "aka": [14, 18], "podman": 14, "autom": [14, 16], "larger": 15, "registry_prefix": [15, 16], "main_usag": 15, "approach": [15, 16, 19], "who": 15, "less": 15, "familiar": 15, "quick": 15, "machin": [15, 18, 19], "coher": 15, "unix": 15, "tmeissner": 15, "formal_hw_verif": 15, "stnolt": 15, "neorv32": 15, "implement": [15, 18], "learn": 15, "referenc": 15, "xilinx": 15, "quicklog": 15, "devic": [15, 18], "straightawai": 15, "chipsalli": 15, "pwd": [15, 16], "wrk": [15, 16], "w": [15, 16], "root": [15, 16], "c3d4dd1d97cc": 15, "arty_100": 15, "picosoc_demo": 15, "l": [15, 18], "fasm": 15, "log": 15, "pack": 15, "packing_pin_util": 15, "rpt": 15, "pre_pack": 15, "report_tim": 15, "report_unconstrained_tim": 15, "rout": 15, "eblif": 15, "ioplac": 15, "carry_fixup": 15, "carry_fixup_out": 15, "post_abc9": 15, "ilang": 15, "pre_abc9": 15, "post_rout": 15, "sdc": 15, "top_io": 15, "top_synth": 15, "premap": 15, "successfulli": [16, 18], "involv": 16, "retriev": [16, 18], "few": [16, 18], "blink": 16, "showcas": [16, 19], "antonblanchard": 16, "microwatt": 16, "marph91": 16, "icestick": [16, 18], "remot": [16, 18], "container_engin": [16, 19], "container_arg": 16, "icepack": 16, "clitool": 16, "pyedaa": 16, "welcom": 16, "edalize_launch": 16, "olofk": 16, "search": 16, "el_dock": 16, "olofkindgren": 16, "blogspot": 16, "0": 16, "221": 16, "carlosedp": 16, "runm": 16, "299": 16, "graphic": 17, "x11": 17, "wayland": 17, "visibl": 17, "mviereck": 17, "x11docker": 17, "runx": 17, "desktop": 17, "cooki": 17, "like": [17, 18], "msys2": [17, 18], "mingw64": 17, "vcxsrv": 17, "journal": 17, "hardwar": 17, "subsystem": 18, "wsl": 18, "microsoft": 18, "5158": 18, "arbitrari": 18, "board": 18, "program": 18, "mingw": 18, "nevertheless": 18, "over": 18, "network": 18, "usbip": 18, "companion": 18, "userspac": 18, "underli": 18, "hyper": 18, "vm": 18, "ship": 18, "win": 18, "mac": 18, "customis": 18, "nativ": 18, "unprivileg": 18, "ko": 18, "rel": 18, "dist": 18, "load": 18, "insert": 18, "core": 18, "vhci": 18, "hcd": 18, "vhcli": 18, "x86_64": 18, "previous": 18, "select": [18, 19], "procedur": 18, "restart": 18, "perman": 18, "stc": 18, "accordingli": 18, "winpti": 18, "pid": 18, "nsenter": 18, "renod": 18, "rtfd": 18, "en": 18, "vhusbdwin64": 18, "ex": 18, "firewal": 18, "block": 18, "vhclient": 18, "lsusb": 18, "7575": 18, "sleep": 18, "hostnam": 18, "bug": 18, "4548": 18, "workaround": 18, "sibl": 18, "iceprog": 18, "ftdi": 18, "evalu": 18, "kit": 18, "preferredli": 18, "cezuni": 18, "quit": 18, "serial": 18, "hub4com": 18, "com0com": 18, "rfc2217": 18, "socat": 18, "tty": 18, "comx": 18, "ttysi": 18, "app": 18, "rem": 18, "com2tcp": 18, "bat": 18, "x": 18, "pty": 18, "tcp": [18, 19], "pyseri": 18, "bridg": 18, "rfc": 18, "2217": 18, "espressif": 18, "esp": 18, "idf": 18, "204": 18, "small": 19, "best": 19, "microservic": 19, "ip": 19, "scale": 19, "balanc": 19, "globe": 19, "camp": 19, "filesystem": 19, "pipe": 19, "treat": 19, "containt": 19, "put": 19, "heavi": 19, "frequent": 19, "workstat": 19, "paradigm": 19, "workshop": 19, "didact": 19}, "objects": {"": [[13, 0, 0, "-", "pyHDLC"]], "pyHDLC": [[13, 1, 1, "", "BuildImage"], [13, 1, 1, "", "GenerateJobList"], [13, 1, 1, "", "PullImage"], [13, 1, 1, "", "PushImage"], [13, 1, 1, "", "TestImage"], [12, 2, 1, "cmdoption-pyHDLC-n", "--noexec"], [12, 2, 1, "cmdoption-pyHDLC-n", "-n"]], "pyHDLC-build": [[12, 2, 1, "cmdoption-pyHDLC-build-a", "--arch"], [12, 2, 1, "cmdoption-pyHDLC-build-i", "--argimg"], [12, 2, 1, "cmdoption-pyHDLC-build-c", "--collection"], [12, 2, 1, "cmdoption-pyHDLC-build-d", "--default"], [12, 2, 1, "cmdoption-pyHDLC-build-f", "--dockerfile"], [12, 2, 1, "cmdoption-pyHDLC-build-h", "--help"], [12, 2, 1, "cmdoption-pyHDLC-build-p", "--pkg"], [12, 2, 1, "cmdoption-pyHDLC-build-r", "--registry"], [12, 2, 1, "cmdoption-pyHDLC-build-t", "--target"], [12, 2, 1, "cmdoption-pyHDLC-build-q", "--test"], [12, 2, 1, "cmdoption-pyHDLC-build-a", "-a"], [12, 2, 1, "cmdoption-pyHDLC-build-c", "-c"], [12, 2, 1, "cmdoption-pyHDLC-build-d", "-d"], [12, 2, 1, "cmdoption-pyHDLC-build-f", "-f"], [12, 2, 1, "cmdoption-pyHDLC-build-h", "-h"], [12, 2, 1, "cmdoption-pyHDLC-build-i", "-i"], [12, 2, 1, "cmdoption-pyHDLC-build-p", "-p"], [12, 2, 1, "cmdoption-pyHDLC-build-q", "-q"], [12, 2, 1, "cmdoption-pyHDLC-build-r", "-r"], [12, 2, 1, "cmdoption-pyHDLC-build-t", "-t"], [12, 2, 1, "cmdoption-pyHDLC-build-arg-image", "image"]], "pyHDLC-help": [[12, 2, 1, "cmdoption-pyHDLC-help-h", "--help"], [12, 2, 1, "cmdoption-pyHDLC-help-h", "-h"], [12, 2, 1, "cmdoption-pyHDLC-help-arg-command", "command"]], "pyHDLC-jobs": [[12, 2, 1, "cmdoption-pyHDLC-jobs-f", "--format"], [12, 2, 1, "cmdoption-pyHDLC-jobs-h", "--help"], [12, 2, 1, "cmdoption-pyHDLC-jobs-f", "-f"], [12, 2, 1, "cmdoption-pyHDLC-jobs-h", "-h"], [12, 2, 1, "cmdoption-pyHDLC-jobs-arg-name", "name"]], "pyHDLC-pull": [[12, 2, 1, "cmdoption-pyHDLC-pull-a", "--arch"], [12, 2, 1, "cmdoption-pyHDLC-pull-c", "--collection"], [12, 2, 1, "cmdoption-pyHDLC-pull-h", "--help"], [12, 2, 1, "cmdoption-pyHDLC-pull-r", "--registry"], [12, 2, 1, "cmdoption-pyHDLC-pull-a", "-a"], [12, 2, 1, "cmdoption-pyHDLC-pull-c", "-c"], [12, 2, 1, "cmdoption-pyHDLC-pull-h", "-h"], [12, 2, 1, "cmdoption-pyHDLC-pull-r", "-r"], [12, 2, 1, "cmdoption-pyHDLC-pull-arg-image", "image"]], "pyHDLC-push": [[12, 2, 1, "cmdoption-pyHDLC-push-a", "--arch"], [12, 2, 1, "cmdoption-pyHDLC-push-c", "--collection"], [12, 2, 1, "cmdoption-pyHDLC-push-h", "--help"], [12, 2, 1, "cmdoption-pyHDLC-push-m", "--mirror"], [12, 2, 1, "cmdoption-pyHDLC-push-r", "--registry"], [12, 2, 1, "cmdoption-pyHDLC-push-a", "-a"], [12, 2, 1, "cmdoption-pyHDLC-push-c", "-c"], [12, 2, 1, "cmdoption-pyHDLC-push-h", "-h"], [12, 2, 1, "cmdoption-pyHDLC-push-m", "-m"], [12, 2, 1, "cmdoption-pyHDLC-push-r", "-r"], [12, 2, 1, "cmdoption-pyHDLC-push-arg-image", "image"]], "pyHDLC-test": [[12, 2, 1, "cmdoption-pyHDLC-test-a", "--arch"], [12, 2, 1, "cmdoption-pyHDLC-test-c", "--collection"], [12, 2, 1, "cmdoption-pyHDLC-test-h", "--help"], [12, 2, 1, "cmdoption-pyHDLC-test-r", "--registry"], [12, 2, 1, "cmdoption-pyHDLC-test-a", "-a"], [12, 2, 1, "cmdoption-pyHDLC-test-c", "-c"], [12, 2, 1, "cmdoption-pyHDLC-test-h", "-h"], [12, 2, 1, "cmdoption-pyHDLC-test-r", "-r"], [12, 2, 1, "cmdoption-pyHDLC-test-arg-image", "image"]]}, "objtypes": {"0": "py:module", "1": "py:function", "2": "std:cmdoption"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "function", "Python function"], "2": ["std", "cmdoption", "program option"]}, "titleterms": {"about": 0, "context": 0, "hdl": [0, 14], "organis": 0, "collect": 1, "architectur": 1, "creativ": 2, "common": 2, "attribut": 2, "4": [2, 3], "0": [2, 3], "intern": 2, "us": 2, "public": 2, "licens": [2, 3], "section": 2, "1": [2, 3], "definit": [2, 3], "2": [2, 3], "scope": 2, "3": [2, 3], "condit": 2, "sui": 2, "generi": 2, "databas": 2, "right": 2, "5": [2, 3], "disclaim": [2, 3], "warranti": [2, 3], "limit": [2, 3], "liabil": [2, 3], "6": [2, 3], "term": 2, "termin": 2, "7": [2, 3], "other": 2, "8": [2, 3], "interpret": 2, "apach": 3, "grant": 3, "copyright": 3, "patent": 3, "redistribut": 3, "submiss": 3, "contribut": [3, 7], "trademark": 3, "9": 3, "accept": 3, "addit": 3, "appendix": 3, "how": 3, "appli": 3, "your": 3, "work": 3, "refer": [4, 13], "f4pga": [4, 5, 15], "distroless": 4, "wolfi": 4, "nixo": 4, "librecor": 4, "asic": 4, "googl": 4, "contain": [4, 14], "regisri": 4, "gcr": 4, "usb": [4, 18], "ip": [4, 18], "tool": [5, 17], "imag": [5, 10, 15], "includ": 5, "multipl": 5, "conda": 5, "To": 5, "do": 5, "continu": 6, "integr": 6, "ci": 6, "statu": 6, "structur": 6, "dockerfil": [7, 8], "singl": 7, "file": [7, 8, 12], "exampl": [7, 18], "hdlc": 7, "script": 7, "buildkit": 7, "step": 7, "checklist": 7, "graph": [8, 9], "gener": 8, "pars": 8, "read": 8, "github": 8, "action": 8, "workflow": 8, "packag": 10, "task": 11, "credenti": 11, "util": 12, "pyhdlc": [12, 13], "option": 12, "build": 12, "help": 12, "job": 12, "pull": [12, 16], "push": 12, "test": 12, "smoke": 12, "inspect": 12, "yaml": 12, "configur": 12, "default": 12, "function": 13, "dataclass": 13, "all": 15, "one": 15, "fine": 16, "grain": 16, "makefil": 16, "python": 16, "launcher": 16, "eda\u00b2": 16, "": 16, "docker": [16, 18], "abstract": 16, "edal": 16, "pyfpga": 16, "openflow": 16, "gui": 17, "protocol": 18, "support": 18, "desktop": 18, "session": 18, "altern": 18, "introduct": 19}, "envversion": {"sphinx.domains.c": 2, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 8, "sphinx.domains.index": 1, "sphinx.domains.javascript": 2, "sphinx.domains.math": 2, "sphinx.domains.python": 3, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.intersphinx": 1, "sphinx": 57}, "alltitles": {"About": [[0, "about"]], "Context": [[0, "id1"]], "HDL Organisation": [[0, "hdl-organisation"]], "Collections and architectures": [[1, "collections-and-architectures"]], "Creative Commons Attribution 4.0 International": [[2, "creative-commons-attribution-4-0-international"]], "Using Creative Commons Public Licenses": [[2, "using-creative-commons-public-licenses"]], "Creative Commons Attribution 4.0 International Public License": [[2, "creative-commons-attribution-4-0-international-public-license"]], "Section 1 \u2013 Definitions": [[2, "section-1-definitions"]], "Section 2 \u2013 Scope": [[2, "section-2-scope"]], "Section 3 \u2013 License Conditions": [[2, "section-3-license-conditions"]], "Section 4 \u2013 Sui Generis Database Rights": [[2, "section-4-sui-generis-database-rights"]], "Section 5 \u2013 Disclaimer of Warranties and Limitation of Liability": [[2, "section-5-disclaimer-of-warranties-and-limitation-of-liability"]], "Section 6 \u2013 Term and Termination": [[2, "section-6-term-and-termination"]], "Section 7 \u2013 Other Terms and Conditions": [[2, "section-7-other-terms-and-conditions"]], "Section 8 \u2013 Interpretation": [[2, "section-8-interpretation"]], "Apache License 2.0": [[3, "apache-license-2-0"]], "1. Definitions": [[3, "definitions"]], "2. Grant of Copyright License": [[3, "grant-of-copyright-license"]], "3. Grant of Patent License": [[3, "grant-of-patent-license"]], "4. Redistribution": [[3, "redistribution"]], "5. Submission of Contributions": [[3, "submission-of-contributions"]], "6. Trademarks": [[3, "trademarks"]], "7. Disclaimer of Warranty": [[3, "disclaimer-of-warranty"]], "8. Limitation of Liability": [[3, "limitation-of-liability"]], "9. Accepting Warranty or Additional Liability": [[3, "accepting-warranty-or-additional-liability"]], "Appendix: How to apply the Apache License to your work": [[3, "appendix-how-to-apply-the-apache-license-to-your-work"]], "References": [[4, "references"]], "F4PGA": [[4, "f4pga"], [15, "f4pga"]], "distroless": [[4, "distroless"]], "Wolfi": [[4, "wolfi"]], "NixOS": [[4, "nixos"]], "LibreCores": [[4, "librecores"]], "ASIC": [[4, "asic"]], "Google Container Regisry (GCR)": [[4, "google-container-regisry-gcr"]], "USB/IP": [[4, "usb-ip"]], "Tools and images": [[5, "tools-and-images"]], "Images including multiple tools": [[5, "images-including-multiple-tools"]], "F4PGA (Conda)": [[5, "f4pga-conda"]], "To Do": [[5, "to-do"]], "Continuous Integration (CI)": [[6, "continuous-integration-ci"]], "Status": [[6, "status"]], "Structure": [[6, "structure"]], "Contributing": [[7, "contributing"]], "Dockerfiles": [[7, "dockerfiles"]], "Single-file example": [[7, "single-file-example"]], "Example with HDLC script": [[7, "example-with-hdlc-script"]], "BuildKit": [[7, "buildkit"]], "Step by step checklist": [[7, "step-by-step-checklist"]], "Graph generation/parsing": [[8, "graph-generation-parsing"]], "Reading dockerfiles": [[8, "reading-dockerfiles"]], "Reading GitHub Actions workflow files": [[8, "reading-github-actions-workflow-files"]], "Graphs": [[9, "graphs"]], "Package images": [[10, "package-images"]], "Tasks": [[11, "tasks"]], "Credentials": [[11, "credentials"]], "Utils": [[12, "utils"]], "pyHDLC": [[12, "pyhdlc"]], "options": [[12, "options"]], "pyHDLC build": [[12, "pyhdlc-build"]], "pyHDLC help": [[12, "pyhdlc-help"]], "pyHDLC jobs": [[12, "pyhdlc-jobs"]], "pyHDLC pull": [[12, "pyhdlc-pull"]], "pyHDLC push": [[12, "pyhdlc-push"]], "pyHDLC test": [[12, "pyhdlc-test"]], "Smoke-tests": [[12, "smoke-tests"]], "Inspect": [[12, "inspect"]], "YAML Configuration File": [[12, "yaml-configuration-file"]], "Defaults": [[12, "defaults"]], "Jobs": [[12, "jobs"]], "pyHDLC Reference": [[13, "pyhdlc-reference"]], "Functions": [[13, "module-pyHDLC"]], "Dataclasses": [[13, "dataclasses"]], "HDL Containers": [[14, "hdl-containers"]], "All-in-one images": [[15, "all-in-one-images"]], "Fine-grained pulling": [[16, "fine-grained-pulling"]], "Makefiles": [[16, "makefiles"]], "Python launchers": [[16, "python-launchers"]], "EDA\u00b2\u2019s Docker abstraction": [[16, "eda2-s-docker-abstraction"]], "Edalize\u2019s Launcher": [[16, "edalize-s-launcher"]], "PyFPGA\u2019s OpenFlow": [[16, "pyfpga-s-openflow"]], "Tools with GUI": [[17, "tools-with-gui"]], "USB/IP protocol support for Docker Desktop": [[18, "usb-ip-protocol-support-for-docker-desktop"]], "Example session": [[18, "example-session"]], "Alternatives": [[18, "alternatives"]], "Introduction": [[19, "introduction"]]}, "indexentries": {"--arch": [[12, "cmdoption-pyHDLC-build-a"], [12, "cmdoption-pyHDLC-pull-a"], [12, "cmdoption-pyHDLC-push-a"], [12, "cmdoption-pyHDLC-test-a"]], "--argimg": [[12, "cmdoption-pyHDLC-build-i"]], "--collection": [[12, "cmdoption-pyHDLC-build-c"], [12, "cmdoption-pyHDLC-pull-c"], [12, "cmdoption-pyHDLC-push-c"], [12, "cmdoption-pyHDLC-test-c"]], "--default": [[12, "cmdoption-pyHDLC-build-d"]], "--dockerfile": [[12, "cmdoption-pyHDLC-build-f"]], "--format": [[12, "cmdoption-pyHDLC-jobs-f"]], "--help": [[12, "cmdoption-pyHDLC-build-h"], [12, "cmdoption-pyHDLC-help-h"], [12, "cmdoption-pyHDLC-jobs-h"], [12, "cmdoption-pyHDLC-pull-h"], [12, "cmdoption-pyHDLC-push-h"], [12, "cmdoption-pyHDLC-test-h"]], "--mirror": [[12, "cmdoption-pyHDLC-push-m"]], "--noexec": [[12, "cmdoption-pyHDLC-n"]], "--pkg": [[12, "cmdoption-pyHDLC-build-p"]], "--registry": [[12, "cmdoption-pyHDLC-build-r"], [12, "cmdoption-pyHDLC-pull-r"], [12, "cmdoption-pyHDLC-push-r"], [12, "cmdoption-pyHDLC-test-r"]], "--target": [[12, "cmdoption-pyHDLC-build-t"]], "--test": [[12, "cmdoption-pyHDLC-build-q"]], "-a": [[12, "cmdoption-pyHDLC-build-a"], [12, "cmdoption-pyHDLC-pull-a"], [12, "cmdoption-pyHDLC-push-a"], [12, "cmdoption-pyHDLC-test-a"]], "-c": [[12, "cmdoption-pyHDLC-build-c"], [12, "cmdoption-pyHDLC-pull-c"], [12, "cmdoption-pyHDLC-push-c"], [12, "cmdoption-pyHDLC-test-c"]], "-d": [[12, "cmdoption-pyHDLC-build-d"]], "-f": [[12, "cmdoption-pyHDLC-build-f"], [12, "cmdoption-pyHDLC-jobs-f"]], "-h": [[12, "cmdoption-pyHDLC-build-h"], [12, "cmdoption-pyHDLC-help-h"], [12, "cmdoption-pyHDLC-jobs-h"], [12, "cmdoption-pyHDLC-pull-h"], [12, "cmdoption-pyHDLC-push-h"], [12, "cmdoption-pyHDLC-test-h"]], "-i": [[12, "cmdoption-pyHDLC-build-i"]], "-m": [[12, "cmdoption-pyHDLC-push-m"]], "-n": [[12, "cmdoption-pyHDLC-n"]], "-p": [[12, "cmdoption-pyHDLC-build-p"]], "-q": [[12, "cmdoption-pyHDLC-build-q"]], "-r": [[12, "cmdoption-pyHDLC-build-r"], [12, "cmdoption-pyHDLC-pull-r"], [12, "cmdoption-pyHDLC-push-r"], [12, "cmdoption-pyHDLC-test-r"]], "-t": [[12, "cmdoption-pyHDLC-build-t"]], "command": [[12, "cmdoption-pyHDLC-help-arg-command"]], "image": [[12, "cmdoption-pyHDLC-build-arg-image"], [12, "cmdoption-pyHDLC-pull-arg-image"], [12, "cmdoption-pyHDLC-push-arg-image"], [12, "cmdoption-pyHDLC-test-arg-image"]], "name": [[12, "cmdoption-pyHDLC-jobs-arg-name"]], "pyhdlc command line option": [[12, "cmdoption-pyHDLC-n"]], "pyhdlc-build command line option": [[12, "cmdoption-pyHDLC-build-a"], [12, "cmdoption-pyHDLC-build-arg-image"], [12, "cmdoption-pyHDLC-build-c"], [12, "cmdoption-pyHDLC-build-d"], [12, "cmdoption-pyHDLC-build-f"], [12, "cmdoption-pyHDLC-build-h"], [12, "cmdoption-pyHDLC-build-i"], [12, "cmdoption-pyHDLC-build-p"], [12, "cmdoption-pyHDLC-build-q"], [12, "cmdoption-pyHDLC-build-r"], [12, "cmdoption-pyHDLC-build-t"]], "pyhdlc-help command line option": [[12, "cmdoption-pyHDLC-help-arg-command"], [12, "cmdoption-pyHDLC-help-h"]], "pyhdlc-jobs command line option": [[12, "cmdoption-pyHDLC-jobs-arg-name"], [12, "cmdoption-pyHDLC-jobs-f"], [12, "cmdoption-pyHDLC-jobs-h"]], "pyhdlc-pull command line option": [[12, "cmdoption-pyHDLC-pull-a"], [12, "cmdoption-pyHDLC-pull-arg-image"], [12, "cmdoption-pyHDLC-pull-c"], [12, "cmdoption-pyHDLC-pull-h"], [12, "cmdoption-pyHDLC-pull-r"]], "pyhdlc-push command line option": [[12, "cmdoption-pyHDLC-push-a"], [12, "cmdoption-pyHDLC-push-arg-image"], [12, "cmdoption-pyHDLC-push-c"], [12, "cmdoption-pyHDLC-push-h"], [12, "cmdoption-pyHDLC-push-m"], [12, "cmdoption-pyHDLC-push-r"]], "pyhdlc-test command line option": [[12, "cmdoption-pyHDLC-test-a"], [12, "cmdoption-pyHDLC-test-arg-image"], [12, "cmdoption-pyHDLC-test-c"], [12, "cmdoption-pyHDLC-test-h"], [12, "cmdoption-pyHDLC-test-r"]], "buildimage() (in module pyhdlc)": [[13, "pyHDLC.BuildImage"]], "generatejoblist() (in module pyhdlc)": [[13, "pyHDLC.GenerateJobList"]], "pullimage() (in module pyhdlc)": [[13, "pyHDLC.PullImage"]], "pushimage() (in module pyhdlc)": [[13, "pyHDLC.PushImage"]], "testimage() (in module pyhdlc)": [[13, "pyHDLC.TestImage"]], "module": [[13, "module-pyHDLC"]], "pyhdlc": [[13, "module-pyHDLC"]]}}) \ No newline at end of file diff --git a/ug/AllInOne.html b/ug/AllInOne.html new file mode 100644 index 000000000..2b412579b --- /dev/null +++ b/ug/AllInOne.html @@ -0,0 +1,220 @@ + + + + + + + All-in-one images — HDL Containers: Building and deploying container images for open source Electronic Design Automation latest documentation + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+ + +
+ +
+
+ +
+
+ +
+

All-in-one images

+
+

Note

+

These images are coloured BROWN in the Graphs.

+
+

Multiple tools from fine-grained images are included in larger images for common use cases. +These are named REGISTRY_PREFIX/[ARCHITECTURE/][COLLECTION/]MAIN_USAGE. +This is the recommended approach for users who are less familiar with containers and want a quick replacement for +full-featured virtual machines. +Coherently, some common Unix tools (such as make or cmake) are also included in these all-in-one images.

+
    +
  • gh:tmeissner/formal_hw_verification: +the CI workflow uses image REGISTRY_PREFIX/[ARCHITECTURE/][COLLECTION/]formal/all along with GitHub Actions’ +Docker Step syntax.

  • +
  • gh:stnolting/neorv32-setups: +the implementation workflow (for generating bitstreams from VHDL sources) uses image +REGISTRY_PREFIX/[ARCHITECTURE/][COLLECTION/]impl along with GitHub Actions’ Docker Step syntax.

  • +
+ +
+

F4PGA

+

As explained in F4PGA (Conda), multiple ready-to-use images are provided +including Miniconda, F4PGA toolchains and architecture definitions for Xilinx’s xc7 or QuickLogic’s eos-s3 +devices. +These container images are expected to be used as explained in 'f4pga-examples.rtfd.io', assuming that the +environment is prepared already and available in the PATH. +Hence, the Conda environment can be activated straightaway. +See, for instance:

+
:~# git clone https://github.com/chipsalliance/f4pga-examples
+...
+:~# cd f4pga-examples
+
+:~/f4pga-examples# docker run --rm -it \
+  -v /$(pwd)://wrk \
+  -w //wrk \
+  gcr.io/hdl-containers/conda/f4pga/xc7/a100t
+
+...
+(xc7) root@c3d4dd1d97cc:/wrk# TARGET="arty_100" make -C xc7/picosoc_demo/
+...
+(xc7) root@c3d4dd1d97cc:/wrk# ls -1 xc7/picosoc_demo/build/arty_100/
+constraints.place
+fasm.log
+pack.log
+packing_pin_util.rpt
+place.log
+pre_pack.report_timing.setup.rpt
+report_timing.hold.rpt
+report_timing.setup.rpt
+report_unconstrained_timing.hold.rpt
+report_unconstrained_timing.setup.rpt
+route.log
+top.bit
+top.eblif
+top.fasm
+top.ioplace
+top.json
+top.json.carry_fixup.json
+top.json.carry_fixup_out.json
+top.json.post_abc9.ilang
+top.json.pre_abc9.ilang
+top.net
+top.net.post_routing
+top.place
+top.route
+top.sdc
+top_io.json
+top_synth.log
+top_synth.v
+top_synth.v.premap.v
+
+
+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/ug/FineGrained.html b/ug/FineGrained.html new file mode 100644 index 000000000..e248764f4 --- /dev/null +++ b/ug/FineGrained.html @@ -0,0 +1,214 @@ + + + + + + + Fine-grained pulling — HDL Containers: Building and deploying container images for open source Electronic Design Automation latest documentation + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+ + +
+ +
+
+ +
+
+ +
+

Fine-grained pulling

+
+

Note

+

These images are coloured GREEN in the Graphs.

+
+

Ready-to-use images are provided for each tool, which contain the tool and the dependencies for it to run successfully. +These are typically named REGISTRY_PREFIX/[ARCHITECTURE/][COLLECTION/]TOOL_NAME.

+
+

Hint

+

Since all the images in each collection are based on the same root image, pulling multiple images involves retrieving +a few additional layers only. +Therefore, this is the recommended approach for CI or other environments with limited resources.

+
+
+

Makefiles

+ +

Those projects use a partial Makefile such as the following, for optionally wrapping regular tool calls:

+
CONTAINER_ENGINE ?= docker
+
+PWD = $(shell pwd)
+CONTAINER_ARGS = run --rm -v $(PWD):/wrk -w /wrk
+
+GHDL    = $(CONTAINER_ENGINE) $(CONTAINER_ARGS) gcr.io/hdl-containers/ghdl/yosys ghdl
+YOSYS   = $(CONTAINER_ENGINE) $(CONTAINER_ARGS) gcr.io/hdl-containers/ghdl/yosys yosys
+NEXTPNR = $(CONTAINER_ENGINE) $(CONTAINER_ARGS) gcr.io/hdl-containers/nextpnr/ice40 nextpnr-ice40
+ICEPACK = $(CONTAINER_ENGINE) $(CONTAINER_ARGS) gcr.io/hdl-containers/icestorm icepack
+
+
+
+
+

Python launchers

+

There are several EDA tooling management projects which allow wrapping the execution of commands on containers. +Any of them can be used with the containers provided in this repository.

+
+

EDA²’s Docker abstraction

+

Layer CLITool of EDA² (see Electronic Design Automation Abstraction (EDA²) Documentation and The pyEDAA.CLITool Documentation), provides Docker.py to be combined with any +of the tools supported in the same repository.

+
+
+

Edalize’s Launcher

+

Edalize (see Welcome to Edalize’s documentation!) provides EDALIZE_LAUNCHER, which allows overriding each command: +olofk/edalize: search?q=EDALIZE_LAUNCHER. +el_docker is a built-in launcher for Docker. +See also:

+ +
+
+

PyFPGA’s OpenFlow

+

PyFPGA’s OpenFlow (see PyFPGA Documentation and gh:PyFPGA/openflow) allows running tools in containers, similarly to +el_docker. +In fact, OpenFlow can be used along with Edalize’s EDALIZE_LAUNCHER environment variable.

+
+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/ug/GUI.html b/ug/GUI.html new file mode 100644 index 000000000..d11ff9706 --- /dev/null +++ b/ug/GUI.html @@ -0,0 +1,157 @@ + + + + + + + Tools with GUI — HDL Containers: Building and deploying container images for open source Electronic Design Automation latest documentation + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+ + +
+ +
+
+ +
+
+ +
+

Tools with GUI

+

By default, tools with Graphical User Interface (GUI) cannot be used in containers, because there is no graphical +server. +However, there are multiple alternatives for making an X11 or +Wayland server visible to the container. +gh:mviereck/x11docker and gh:mviereck/runx are full-featured helper scripts for setting up the environment and +running GUI applications and desktop environments in OCI containers. +GNU/Linux and Windows hosts are supported, and security related options are provided (such as cookie authentication). +Users of GTKWave, KLayout, nextpnr and other tools will likely want to try x11docker (and runx).

+
+Block diagram of the OSVB +
+

Fig. 1 Execution of KLayout in a container on Windows 10 (MSYS2/MINGW64) with +gh:mviereck/x11docker, gh:mviereck/runx and VcxSrv.

+
+
+ +
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/ug/USBIP.html b/ug/USBIP.html new file mode 100644 index 000000000..cc76376a7 --- /dev/null +++ b/ug/USBIP.html @@ -0,0 +1,265 @@ + + + + + + + USB/IP protocol support for Docker Desktop — HDL Containers: Building and deploying container images for open source Electronic Design Automation latest documentation + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+ + +
+ +
+
+ +
+
+ +
+

USB/IP protocol support for Docker Desktop

+

Virtual Machines used on Windows for running either Windows Subsystem for Linux (WSL) or Docker Desktop by default do +not support sharing USB devices with the containers. +Only those that are identified as storage or COM devices can be bind directly. +See microsoft/WSL#5158. +That prevents using arbitrary drivers inside the containers. +As a result, most container users on Windows do install board programming tools through MSYS2 (see gh:hdl/MINGW-packages).

+

Nevertheless, USB/IP protocol allows passing USB device(s) from server(s) to client(s) over the network. +As explained at kernel.org/doc/readme/tools-usb-usbip-README, +on GNU/Linux, USB/IP is implemented as a few kernel modules with companion userspace tools. +However, the default underlying Hyper-V VM machine (based on Alpine Linux) shipped with +Docker Desktop (aka docker-for-win/docker-for-mac) does not include the required kernel modules. +Fortunately, privileged docker containers allow installing missing kernel modules. +The shell script in usbip/ supports customising the native VM in Docker Desktop for adding +USB over IP support.

+
# Build kernel modules: in an unprivileged `alpine` container, retrieve the corresponding
+# kernel sources, copy runtime config and enable USB/IP features, build `drivers/usb/usbip`
+# and save `*.ko` artifacts to relative subdir `dist` on the host.
+./run.sh -m
+
+# Load/insert kernel modules: use a privileged `busybox` container to load kernel modules
+# `usbip-core.ko` and `vhci-hcd.ko` from relative subdir `dist` on the host to the
+# underlying Hyper-V VM.
+./run.sh -l
+
+# Build image `vhcli`, using `busybox` as a base, and including the
+# [VirtualHere](https://www.virtualhere.com) GNU/Linux client for x86_64 along with the
+# `*.ko` files built previously through `./run.sh -m`.
+./run.sh -v
+
+
+
+

Note

+

For manually selecting configuration options, building and inserting modules, see detailed procedure in +gw0/docker-alpine-kernel-modules#usage.

+
+
+

Note

+

Modules will be removed when the Hyper-V VM is restarted (i.e. when the host or Docker Desktop are restarted). +For a permanent install, modules need to be copied to /lib/modules in the underlying VM, and /stc/modules +needs to be configured accordingly. +Use $(command -v winpty) docker run --rm -it --privileged --pid=host alpine nsenter -t 1 -m -u -n -i sh to access +a shell with full permissions on the VM.

+
+
+

Note

+

USB/IP is supported in Renode too. +See renode.rtfd.io/en/latest/tutorials/usbip.

+
+
+

Example session

+

How to connect a Docker Desktop container to VirtualHere USB Server for Windows.

+
    +
  • Start vhusbdwin64.exe on the host

  • +
  • Ensure that the firewall is not blocking it.

  • +
+
# Start container named 'vhclient'
+./run.sh -s
+# List usb devices available in the container
+./run.sh -e lsusb
+# LIST hubs/devices found by vhclient
+./run.sh -c "LIST"
+# Manually add to the client the hub/server running on the host
+./run.sh -c "MANUAL HUB ADD,host.docker.internal:7575"
+
+sleep 10
+
+./run.sh -c "LIST"
+# Use a remote device in the container
+./run.sh -c "USE,<SERVER HOSTNAME>.1"
+
+sleep 4
+
+# Check that the device is now available in the container
+./run.sh -e lsusb
+
+
+
+

Important

+

There is an issue/bug in Docker Desktop (docker/for-win#4548) that prevents the +container where the USB device is added from seeing it. +The workaround is to execute the board programming tool in a sibling container. +For example: docker run --rm --privileged */prog iceprog -t.

+
+
+
+

Alternatives

+
+

Important

+

Using VirtualHere is the only solution we could successfully use in order to share +FTDI devices (iCEstick Evaluation Kit boards) between a Windows 10 host and a Docker +Desktop container running on the same host. +However, since the USB/IP protocol is open source, we’d like to try any other (preferredly open and free source) +server for Windows along with the default GNU/Linux usbip-tools. +Should you know about any, please let us know!

+

We are aware of gh:cezuni/usbip-win. +However, it seems to be in very early development state and the install procedure is quite complex yet.

+
+

Serial (COM) devices can be shared with open source tools. +On the one hand, hub4com from project +com0com allows to publish a port through a RFC2217 server. +On the other hand, socat can be used to link the network connection to a virtual tty device.

+
                   HOST                                           CONTAINER
+        ---------------------------                 -------------------------------------
+USB <-> | COMX <-> RFC2217 server | <-> network <-> | socat <-> /dev/ttySY <-> app/tool |
+        ---------------------------                 -------------------------------------
+
+
+
> REM On the Windows host
+> com2tcp-rfc2217.bat COM<X> <PORT>
+
+
+
# In the container
+socat pty,link=/dev/ttyS<Y> tcp:host.docker.internal:<PORT>
+
+
+

It might be possible to replace hub4com with gh:pyserial/pyserial. +However, we did not test it.

+ +
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/ug/index.html b/ug/index.html new file mode 100644 index 000000000..ae011b485 --- /dev/null +++ b/ug/index.html @@ -0,0 +1,161 @@ + + + + + + + Introduction — HDL Containers: Building and deploying container images for open source Electronic Design Automation latest documentation + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+ + +
+ +
+
+ +
+
+ +
+

Introduction

+
+

Important

+

Image names and tags in this documentation are provided without the registry prefix. +Hence, REGISTRY/[ARCHITECTURE/][COLLECTION/]* needs to be prefixed to the image names shown in Tools and images.

+
+

Official guidelines and recommendations for using containers suggest keeping them small and specific for each tool/purpose +(see docs.docker.com: Best practices for writing Dockerfiles). +That fits well with the field of web microservices, which communicate through TCP/IP and which need to be composed, +scaled and balanced all around the globe.

+

However, tooling in other camps is expected to communicate using a shared or local filesystem and/or pipes; therefore, +many users treat containters as lightweight virtual machines. +That is, they put all the tools in a single (heavy) container. +Those containers are typically not moved around as frequently as microservices, but cached on developers’ workstations.

+

In this project, both paradigms are supported; fine-grained images are available, as well as all-in-one images.

+
+

Note

+

hdl examples in gh:im-tomu/fomu-workshop showcase a Makefile based solution that supports both strategies: +the fine-grained pulling and the all-in-one approach. +An environment variable (CONTAINER_ENGINE) is used for selecting which approach to use. +For didactic purposes, both of them are used in Continuous Integration (CI). +See im-tomu/fomu-workshop: .github/workflows/test.yml.

+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file