diff --git a/.appveyor.yml b/.appveyor.yml deleted file mode 100644 index 84b744b..0000000 --- a/.appveyor.yml +++ /dev/null @@ -1,43 +0,0 @@ -environment: - - PYTHON_ARCH: "64" - PYTHON: "C:\\Miniconda38-x64" - - matrix: - - PYTHON_VERSION: "3.8" - -install: - # windows config (for installation) - - cmd: "SET PATH=%PYTHON%;%PYTHON%\\Scripts;%PATH%" - - cmd: setlocal - - cmd: set ANACONDA_API_TOKEN= - # conda config - - conda config --set always_yes yes --set changeps1 no - - conda update -q conda - - conda install conda-build anaconda-client - - pip install -i https://pypi.anaconda.org/psyplot/simple --no-deps psyplot-ci-orb - - conda config --add channels conda-forge - - conda config --add channels psyplot - - conda info -a - - conda list - # windows config - - cmd: endlocal - - cmd: 'SET PYTHONWARNINGS=ignore:mode:DeprecationWarning:docutils.io:245' - - cmd: "IF NOT DEFINED APPVEYOR_REPO_TAG_NAME (SET GIT_BRANCH=%APPVEYOR_REPO_BRANCH%)" - - cmd: "IF NOT DEFINED APPVEYOR_REPO_TAG_NAME (conda config --add channels psyplot/label/%APPVEYOR_REPO_BRANCH%)" - -build: off - -test_script: - - cmd: setlocal - - cmd: set ANACONDA_API_TOKEN= - - cmd: conda build ci/conda-recipe --python %PYTHON_VERSION% - - cmd: endlocal - -deploy_script: - - cmd: " - IF NOT DEFINED APPVEYOR_REPO_TAG_NAME ( - deploy-conda-recipe -l %APPVEYOR_REPO_BRANCH% -py %PYTHON_VERSION% ci/conda-recipe - ) ELSE ( - deploy-conda-recipe -py %PYTHON_VERSION% ci/conda-recipe - )" diff --git a/.circleci/config.yml b/.circleci/config.yml deleted file mode 100644 index 3e6d506..0000000 --- a/.circleci/config.yml +++ /dev/null @@ -1,114 +0,0 @@ -version: 2.1 - -orbs: - psyplot: psyplot/psyplot-ci-orb@1.5.24 - mattermost-plugin-notify: nathanaelhoun/mattermost-plugin-notify@1.2.0 - -executors: - default: psyplot/default - macos: psyplot/macos - -parameters: - unit-test-executor: - description: Executor for the unit tests. Can be default or macos - type: string - default: default - deploy-release: - description: Deploy the comment as a new release to github and pypi - type: boolean - default: false - run-tests: - description: Run the test suite - type: boolean - default: true - build_docs: - description: Build the documentation - type: boolean - default: true - -workflows: - build-and-test: - unless: << pipeline.parameters.deploy-release >> - jobs: - - psyplot/install-and-build: - name: install - exec_environment: << pipeline.parameters.unit-test-executor >> - setup_env: true - build_args: "--no-test" - build_docs: << pipeline.parameters.build_docs >> - env_packages: pytest-cov dask pytest-qt - - psyplot/test-parallel: - name: run-tests - parallelism: 1 - pytest_args: --cov=psy_view - run-job: << pipeline.parameters.run-tests >> - requires: - - install - - psyplot/build-docs: - name: test-docs - run-job: << pipeline.parameters.build_docs >> - builders: linkcheck - requires: - - install - - mattermost-plugin-notify/approval-notification: - name: notify-deploy - context: mattermost - message: >- - Hello @all! A workflow on https://app.circleci.com/pipelines/github/psyplot/psy-view is awaiting your approval. - Please check the uploaded docs and builds prior to approval. - requires: - - run-tests - - test-docs - - hold-for-deploy: - type: approval - requires: - - notify-deploy - - psyplot/deploy-pkg: - exec_environment: << pipeline.parameters.unit-test-executor >> - context: anaconda - requires: - - hold-for-deploy - - psyplot/deploy-docs: - fingerprint: "55:98:12:84:96:12:af:75:0c:fc:17:a5:0e:a2:a9:d4" - run-job: << pipeline.parameters.build_docs >> - requires: - - hold-for-deploy - filters: - branches: - only: master - - psyplot/trigger-release-workflow: - context: trigger-release - filters: - branches: - only: master - requires: - - psyplot/deploy-pkg - - psyplot/deploy-docs - publish-release: - when: << pipeline.parameters.deploy-release >> - jobs: - - psyplot/create-tag: - ssh-fingerprints: "55:98:12:84:96:12:af:75:0c:fc:17:a5:0e:a2:a9:d4" - context: psyplot-admin - user-name: psyplot-admin - publish-release: true - publish-version-tag: true - - mattermost-plugin-notify/approval-notification: - name: notify-release - context: mattermost - message: >- - Hello @all! A new release has been created at https://github.com/psyplot/psy-view/releases. - Please review it carefully, publish it and approve the upload to pypi. - requires: - - psyplot/create-tag - - hold-for-pypi: - type: approval - requires: - - notify-release - - psyplot/deploy-pypi: - context: pypi - requires: - - hold-for-pypi - filters: - branches: - only: master diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 231ef5d..0000000 --- a/.gitattributes +++ /dev/null @@ -1 +0,0 @@ -psy_view/_version.py export-subst diff --git a/.github/ISSUE_TEMPLATE/change_feature.md b/.github/ISSUE_TEMPLATE/change_feature.md deleted file mode 100644 index 436208c..0000000 --- a/.github/ISSUE_TEMPLATE/change_feature.md +++ /dev/null @@ -1,17 +0,0 @@ -#### Summary -[Describe the requested change in one or two lines. -This should also be mentioned in the title of this issue.] - -#### Reason -[Why do you think, this is useful?] - -#### Current behaviour -[How is the current behaviour/framework?] - -#### New behaviour -[Provide here some more explanation that goes beyond the summary above -(or delete this paragraph, if everything is explained above), -and describe the changes you would like to see] - -#### Examples -[images, code-snippets or URLs to other repositories] diff --git a/.github/ISSUE_TEMPLATE/new_feature.md b/.github/ISSUE_TEMPLATE/new_feature.md deleted file mode 100644 index cdb2e79..0000000 --- a/.github/ISSUE_TEMPLATE/new_feature.md +++ /dev/null @@ -1,13 +0,0 @@ -#### Summary -[Describe the new requested feature in one or two lines. -This should also be mentioned in the title of this issue.] - -#### Reason -[Why do you think, this is useful?] - -#### Detailed explanation -[Provide here some more explanation that goes beyond the summary above -(or delete this paragraph, if everything is explained above)] - -#### Examples -[images, code-snippets or URLs to other repositories] diff --git a/.github/issue_template.md b/.github/issue_template.md deleted file mode 100644 index e55120c..0000000 --- a/.github/issue_template.md +++ /dev/null @@ -1,30 +0,0 @@ -#### Code Sample, a copy-pastable example if possible - -```python -# Your code here - -``` -#### Problem description - -[this should explain **why** the current behavior is a problem and why the expected output is a better solution.] - -#### Expected Output -What should have been expected? You can hide large error messages within ``
`` tags, e.g. - -
-very long error message -
- -#### Output of ``psyplot -aV`` - -
-# Paste the output of the command ``psyplot -aV`` (ran from the command line) - -
- -#### NOTE -This is a bug report. - -For requesting new features, use [this template](https://github.com/psyplot/psy-view/issues/new?template=new_feature.md&title=NEW+FEATURE:). - -For changing existing features, use [this template](https://github.com/psyplot/psy-view/issues/new?template=change_feature.md&title=CHANGE+FEATURE:). diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md deleted file mode 100644 index 4eb59a1..0000000 --- a/.github/pull_request_template.md +++ /dev/null @@ -1,4 +0,0 @@ - - [ ] Closes #xxxx (remove if there is no corresponding issue, which should only be the case for minor changes) - - [ ] Tests added (for all bug fixes or enhancements) - - [ ] Tests passed (for all non-documentation changes) - - [ ] Fully documented, including `CHANGELOG.rst` for all changes diff --git a/.gitignore b/.gitignore deleted file mode 100644 index b629877..0000000 --- a/.gitignore +++ /dev/null @@ -1,81 +0,0 @@ -# Byte-compiled / optimized / DLL files -__pycache__/ -*.py[cod] - -# C extensions -*.so - -# mypy cache -.mypy_cache - -# Distribution / packaging -.Python -env/ -build/ -develop-eggs/ -dist/ -downloads/ -eggs/ -.eggs/ -lib/ -lib64/ -parts/ -sdist/ -var/ -*.egg-info/ -.installed.cfg -*.egg - -# PyInstaller -# Usually these files are written by a python script from a template -# before PyInstaller builds the exe, so as to inject date/other infos into it. -*.manifest -*.spec - -# Installer logs -pip-log.txt -pip-delete-this-directory.txt - -# Unit test / coverage reports -htmlcov/ -.tox/ -.coverage -.coverage.* -.cache -nosetests.xml -coverage.xml -*,cover -.pytest_cache/ - -# Translations -*.mo -*.pot - -# Django stuff: -*.log - -# Sphinx documentation -docs/api/ -docs/_build/ -docs/index.doctree -docs/docs-*.png -docs/_static/docs-*.png - -# PyBuilder -target/ - -# Spyder project -.spyderproject - -# Example ipython notebook checkpoints -*.ipynb_checkpoints/ - -# rc files -*matplotlibrc -*psyplotguirc.yml -*psyplotrc.yml -*debug_psyplot.log* - -# CI Test files -ci/conda-recipe/recipe_append.yaml - diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 0000000..3e09a4a --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,5 @@ +version: 2 + +python: + version: "3.8" + system_packages: true diff --git a/.vscode/settings.json b/.vscode/settings.json deleted file mode 100644 index 12ff2fd..0000000 --- a/.vscode/settings.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "restructuredtext.confPath": "${workspaceFolder}/docs" -} \ No newline at end of file diff --git a/CHANGELOG.rst b/CHANGELOG.rst deleted file mode 100644 index cc2af11..0000000 --- a/CHANGELOG.rst +++ /dev/null @@ -1,18 +0,0 @@ -v0.1.0 -====== - -Changed -------- -- The plotmethod tabs have now a more intuitive gridlayout (see - `#46 `__) -- When closing the mainwindow of psy-view now, one closes all open windows (i.e. - also the open figures, see - `#47 `__) - -Added ------ -- A widget to control the plot type for mapplot and plot2d (see - `#46 `__) -- A button to reload all plots. This is useful, for instance, if the data on - your disk changed and you just want to update the plot - `#48 `__) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md deleted file mode 100644 index d691b68..0000000 --- a/CONTRIBUTING.md +++ /dev/null @@ -1,5 +0,0 @@ -# Contributing to psy-view - -:+1::tada: First off, thanks for taking the time to contribute! :tada::+1: - -For some guidelines, please see the [contribution guidelines for psyplot](https://github.com/psyplot/psyplot/blob/master/CONTRIBUTING.md). diff --git a/LICENSE b/LICENSE index f288702..1d7ff42 100644 --- a/LICENSE +++ b/LICENSE @@ -1,674 +1,21 @@ - GNU GENERAL PUBLIC LICENSE - Version 3, 29 June 2007 - - Copyright (C) 2007 Free Software Foundation, Inc. - Everyone is permitted to copy and distribute verbatim copies - of this license document, but changing it is not allowed. - - Preamble - - The GNU General Public License is a free, copyleft license for -software and other kinds of works. - - The licenses for most software and other practical works are designed -to take away your freedom to share and change the works. By contrast, -the GNU General Public License is intended to guarantee your freedom to -share and change all versions of a program--to make sure it remains free -software for all its users. We, the Free Software Foundation, use the -GNU General Public License for most of our software; it applies also to -any other work released this way by its authors. You can apply it to -your programs, too. - - When we speak of free software, we are referring to freedom, not -price. Our General Public Licenses are designed to make sure that you -have the freedom to distribute copies of free software (and charge for -them if you wish), that you receive source code or can get it if you -want it, that you can change the software or use pieces of it in new -free programs, and that you know you can do these things. - - To protect your rights, we need to prevent others from denying you -these rights or asking you to surrender the rights. Therefore, you have -certain responsibilities if you distribute copies of the software, or if -you modify it: responsibilities to respect the freedom of others. - - For example, if you distribute copies of such a program, whether -gratis or for a fee, you must pass on to the recipients the same -freedoms that you received. You must make sure that they, too, receive -or can get the source code. And you must show them these terms so they -know their rights. - - Developers that use the GNU GPL protect your rights with two steps: -(1) assert copyright on the software, and (2) offer you this License -giving you legal permission to copy, distribute and/or modify it. - - For the developers' and authors' protection, the GPL clearly explains -that there is no warranty for this free software. For both users' and -authors' sake, the GPL requires that modified versions be marked as -changed, so that their problems will not be attributed erroneously to -authors of previous versions. - - Some devices are designed to deny users access to install or run -modified versions of the software inside them, although the manufacturer -can do so. This is fundamentally incompatible with the aim of -protecting users' freedom to change the software. The systematic -pattern of such abuse occurs in the area of products for individuals to -use, which is precisely where it is most unacceptable. Therefore, we -have designed this version of the GPL to prohibit the practice for those -products. If such problems arise substantially in other domains, we -stand ready to extend this provision to those domains in future versions -of the GPL, as needed to protect the freedom of users. - - Finally, every program is threatened constantly by software patents. -States should not allow patents to restrict development and use of -software on general-purpose computers, but in those that do, we wish to -avoid the special danger that patents applied to a free program could -make it effectively proprietary. To prevent this, the GPL assures that -patents cannot be used to render the program non-free. - - The precise terms and conditions for copying, distribution and -modification follow. - - TERMS AND CONDITIONS - - 0. Definitions. - - "This License" refers to version 3 of the GNU General Public License. - - "Copyright" also means copyright-like laws that apply to other kinds of -works, such as semiconductor masks. - - "The Program" refers to any copyrightable work licensed under this -License. Each licensee is addressed as "you". "Licensees" and -"recipients" may be individuals or organizations. - - To "modify" a work means to copy from or adapt all or part of the work -in a fashion requiring copyright permission, other than the making of an -exact copy. The resulting work is called a "modified version" of the -earlier work or a work "based on" the earlier work. - - A "covered work" means either the unmodified Program or a work based -on the Program. - - To "propagate" a work means to do anything with it that, without -permission, would make you directly or secondarily liable for -infringement under applicable copyright law, except executing it on a -computer or modifying a private copy. Propagation includes copying, -distribution (with or without modification), making available to the -public, and in some countries other activities as well. - - To "convey" a work means any kind of propagation that enables other -parties to make or receive copies. Mere interaction with a user through -a computer network, with no transfer of a copy, is not conveying. - - An interactive user interface displays "Appropriate Legal Notices" -to the extent that it includes a convenient and prominently visible -feature that (1) displays an appropriate copyright notice, and (2) -tells the user that there is no warranty for the work (except to the -extent that warranties are provided), that licensees may convey the -work under this License, and how to view a copy of this License. If -the interface presents a list of user commands or options, such as a -menu, a prominent item in the list meets this criterion. - - 1. Source Code. - - The "source code" for a work means the preferred form of the work -for making modifications to it. "Object code" means any non-source -form of a work. - - A "Standard Interface" means an interface that either is an official -standard defined by a recognized standards body, or, in the case of -interfaces specified for a particular programming language, one that -is widely used among developers working in that language. - - The "System Libraries" of an executable work include anything, other -than the work as a whole, that (a) is included in the normal form of -packaging a Major Component, but which is not part of that Major -Component, and (b) serves only to enable use of the work with that -Major Component, or to implement a Standard Interface for which an -implementation is available to the public in source code form. A -"Major Component", in this context, means a major essential component -(kernel, window system, and so on) of the specific operating system -(if any) on which the executable work runs, or a compiler used to -produce the work, or an object code interpreter used to run it. - - The "Corresponding Source" for a work in object code form means all -the source code needed to generate, install, and (for an executable -work) run the object code and to modify the work, including scripts to -control those activities. However, it does not include the work's -System Libraries, or general-purpose tools or generally available free -programs which are used unmodified in performing those activities but -which are not part of the work. For example, Corresponding Source -includes interface definition files associated with source files for -the work, and the source code for shared libraries and dynamically -linked subprograms that the work is specifically designed to require, -such as by intimate data communication or control flow between those -subprograms and other parts of the work. - - The Corresponding Source need not include anything that users -can regenerate automatically from other parts of the Corresponding -Source. - - The Corresponding Source for a work in source code form is that -same work. - - 2. Basic Permissions. - - All rights granted under this License are granted for the term of -copyright on the Program, and are irrevocable provided the stated -conditions are met. This License explicitly affirms your unlimited -permission to run the unmodified Program. The output from running a -covered work is covered by this License only if the output, given its -content, constitutes a covered work. This License acknowledges your -rights of fair use or other equivalent, as provided by copyright law. - - You may make, run and propagate covered works that you do not -convey, without conditions so long as your license otherwise remains -in force. You may convey covered works to others for the sole purpose -of having them make modifications exclusively for you, or provide you -with facilities for running those works, provided that you comply with -the terms of this License in conveying all material for which you do -not control copyright. Those thus making or running the covered works -for you must do so exclusively on your behalf, under your direction -and control, on terms that prohibit them from making any copies of -your copyrighted material outside their relationship with you. - - Conveying under any other circumstances is permitted solely under -the conditions stated below. Sublicensing is not allowed; section 10 -makes it unnecessary. - - 3. Protecting Users' Legal Rights From Anti-Circumvention Law. - - No covered work shall be deemed part of an effective technological -measure under any applicable law fulfilling obligations under article -11 of the WIPO copyright treaty adopted on 20 December 1996, or -similar laws prohibiting or restricting circumvention of such -measures. - - When you convey a covered work, you waive any legal power to forbid -circumvention of technological measures to the extent such circumvention -is effected by exercising rights under this License with respect to -the covered work, and you disclaim any intention to limit operation or -modification of the work as a means of enforcing, against the work's -users, your or third parties' legal rights to forbid circumvention of -technological measures. - - 4. Conveying Verbatim Copies. - - You may convey verbatim copies of the Program's source code as you -receive it, in any medium, provided that you conspicuously and -appropriately publish on each copy an appropriate copyright notice; -keep intact all notices stating that this License and any -non-permissive terms added in accord with section 7 apply to the code; -keep intact all notices of the absence of any warranty; and give all -recipients a copy of this License along with the Program. - - You may charge any price or no price for each copy that you convey, -and you may offer support or warranty protection for a fee. - - 5. Conveying Modified Source Versions. - - You may convey a work based on the Program, or the modifications to -produce it from the Program, in the form of source code under the -terms of section 4, provided that you also meet all of these conditions: - - a) The work must carry prominent notices stating that you modified - it, and giving a relevant date. - - b) The work must carry prominent notices stating that it is - released under this License and any conditions added under section - 7. This requirement modifies the requirement in section 4 to - "keep intact all notices". - - c) You must license the entire work, as a whole, under this - License to anyone who comes into possession of a copy. This - License will therefore apply, along with any applicable section 7 - additional terms, to the whole of the work, and all its parts, - regardless of how they are packaged. This License gives no - permission to license the work in any other way, but it does not - invalidate such permission if you have separately received it. - - d) If the work has interactive user interfaces, each must display - Appropriate Legal Notices; however, if the Program has interactive - interfaces that do not display Appropriate Legal Notices, your - work need not make them do so. - - A compilation of a covered work with other separate and independent -works, which are not by their nature extensions of the covered work, -and which are not combined with it such as to form a larger program, -in or on a volume of a storage or distribution medium, is called an -"aggregate" if the compilation and its resulting copyright are not -used to limit the access or legal rights of the compilation's users -beyond what the individual works permit. Inclusion of a covered work -in an aggregate does not cause this License to apply to the other -parts of the aggregate. - - 6. Conveying Non-Source Forms. - - You may convey a covered work in object code form under the terms -of sections 4 and 5, provided that you also convey the -machine-readable Corresponding Source under the terms of this License, -in one of these ways: - - a) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by the - Corresponding Source fixed on a durable physical medium - customarily used for software interchange. - - b) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by a - written offer, valid for at least three years and valid for as - long as you offer spare parts or customer support for that product - model, to give anyone who possesses the object code either (1) a - copy of the Corresponding Source for all the software in the - product that is covered by this License, on a durable physical - medium customarily used for software interchange, for a price no - more than your reasonable cost of physically performing this - conveying of source, or (2) access to copy the - Corresponding Source from a network server at no charge. - - c) Convey individual copies of the object code with a copy of the - written offer to provide the Corresponding Source. This - alternative is allowed only occasionally and noncommercially, and - only if you received the object code with such an offer, in accord - with subsection 6b. - - d) Convey the object code by offering access from a designated - place (gratis or for a charge), and offer equivalent access to the - Corresponding Source in the same way through the same place at no - further charge. You need not require recipients to copy the - Corresponding Source along with the object code. If the place to - copy the object code is a network server, the Corresponding Source - may be on a different server (operated by you or a third party) - that supports equivalent copying facilities, provided you maintain - clear directions next to the object code saying where to find the - Corresponding Source. Regardless of what server hosts the - Corresponding Source, you remain obligated to ensure that it is - available for as long as needed to satisfy these requirements. - - e) Convey the object code using peer-to-peer transmission, provided - you inform other peers where the object code and Corresponding - Source of the work are being offered to the general public at no - charge under subsection 6d. - - A separable portion of the object code, whose source code is excluded -from the Corresponding Source as a System Library, need not be -included in conveying the object code work. - - A "User Product" is either (1) a "consumer product", which means any -tangible personal property which is normally used for personal, family, -or household purposes, or (2) anything designed or sold for incorporation -into a dwelling. In determining whether a product is a consumer product, -doubtful cases shall be resolved in favor of coverage. For a particular -product received by a particular user, "normally used" refers to a -typical or common use of that class of product, regardless of the status -of the particular user or of the way in which the particular user -actually uses, or expects or is expected to use, the product. A product -is a consumer product regardless of whether the product has substantial -commercial, industrial or non-consumer uses, unless such uses represent -the only significant mode of use of the product. - - "Installation Information" for a User Product means any methods, -procedures, authorization keys, or other information required to install -and execute modified versions of a covered work in that User Product from -a modified version of its Corresponding Source. The information must -suffice to ensure that the continued functioning of the modified object -code is in no case prevented or interfered with solely because -modification has been made. - - If you convey an object code work under this section in, or with, or -specifically for use in, a User Product, and the conveying occurs as -part of a transaction in which the right of possession and use of the -User Product is transferred to the recipient in perpetuity or for a -fixed term (regardless of how the transaction is characterized), the -Corresponding Source conveyed under this section must be accompanied -by the Installation Information. But this requirement does not apply -if neither you nor any third party retains the ability to install -modified object code on the User Product (for example, the work has -been installed in ROM). - - The requirement to provide Installation Information does not include a -requirement to continue to provide support service, warranty, or updates -for a work that has been modified or installed by the recipient, or for -the User Product in which it has been modified or installed. Access to a -network may be denied when the modification itself materially and -adversely affects the operation of the network or violates the rules and -protocols for communication across the network. - - Corresponding Source conveyed, and Installation Information provided, -in accord with this section must be in a format that is publicly -documented (and with an implementation available to the public in -source code form), and must require no special password or key for -unpacking, reading or copying. - - 7. Additional Terms. - - "Additional permissions" are terms that supplement the terms of this -License by making exceptions from one or more of its conditions. -Additional permissions that are applicable to the entire Program shall -be treated as though they were included in this License, to the extent -that they are valid under applicable law. If additional permissions -apply only to part of the Program, that part may be used separately -under those permissions, but the entire Program remains governed by -this License without regard to the additional permissions. - - When you convey a copy of a covered work, you may at your option -remove any additional permissions from that copy, or from any part of -it. (Additional permissions may be written to require their own -removal in certain cases when you modify the work.) You may place -additional permissions on material, added by you to a covered work, -for which you have or can give appropriate copyright permission. - - Notwithstanding any other provision of this License, for material you -add to a covered work, you may (if authorized by the copyright holders of -that material) supplement the terms of this License with terms: - - a) Disclaiming warranty or limiting liability differently from the - terms of sections 15 and 16 of this License; or - - b) Requiring preservation of specified reasonable legal notices or - author attributions in that material or in the Appropriate Legal - Notices displayed by works containing it; or - - c) Prohibiting misrepresentation of the origin of that material, or - requiring that modified versions of such material be marked in - reasonable ways as different from the original version; or - - d) Limiting the use for publicity purposes of names of licensors or - authors of the material; or - - e) Declining to grant rights under trademark law for use of some - trade names, trademarks, or service marks; or - - f) Requiring indemnification of licensors and authors of that - material by anyone who conveys the material (or modified versions of - it) with contractual assumptions of liability to the recipient, for - any liability that these contractual assumptions directly impose on - those licensors and authors. - - All other non-permissive additional terms are considered "further -restrictions" within the meaning of section 10. If the Program as you -received it, or any part of it, contains a notice stating that it is -governed by this License along with a term that is a further -restriction, you may remove that term. If a license document contains -a further restriction but permits relicensing or conveying under this -License, you may add to a covered work material governed by the terms -of that license document, provided that the further restriction does -not survive such relicensing or conveying. - - If you add terms to a covered work in accord with this section, you -must place, in the relevant source files, a statement of the -additional terms that apply to those files, or a notice indicating -where to find the applicable terms. - - Additional terms, permissive or non-permissive, may be stated in the -form of a separately written license, or stated as exceptions; -the above requirements apply either way. - - 8. Termination. - - You may not propagate or modify a covered work except as expressly -provided under this License. Any attempt otherwise to propagate or -modify it is void, and will automatically terminate your rights under -this License (including any patent licenses granted under the third -paragraph of section 11). - - However, if you cease all violation of this License, then your -license from a particular copyright holder is reinstated (a) -provisionally, unless and until the copyright holder explicitly and -finally terminates your license, and (b) permanently, if the copyright -holder fails to notify you of the violation by some reasonable means -prior to 60 days after the cessation. - - Moreover, your license from a particular copyright holder is -reinstated permanently if the copyright holder notifies you of the -violation by some reasonable means, this is the first time you have -received notice of violation of this License (for any work) from that -copyright holder, and you cure the violation prior to 30 days after -your receipt of the notice. - - Termination of your rights under this section does not terminate the -licenses of parties who have received copies or rights from you under -this License. If your rights have been terminated and not permanently -reinstated, you do not qualify to receive new licenses for the same -material under section 10. - - 9. Acceptance Not Required for Having Copies. - - You are not required to accept this License in order to receive or -run a copy of the Program. Ancillary propagation of a covered work -occurring solely as a consequence of using peer-to-peer transmission -to receive a copy likewise does not require acceptance. However, -nothing other than this License grants you permission to propagate or -modify any covered work. These actions infringe copyright if you do -not accept this License. Therefore, by modifying or propagating a -covered work, you indicate your acceptance of this License to do so. - - 10. Automatic Licensing of Downstream Recipients. - - Each time you convey a covered work, the recipient automatically -receives a license from the original licensors, to run, modify and -propagate that work, subject to this License. You are not responsible -for enforcing compliance by third parties with this License. - - An "entity transaction" is a transaction transferring control of an -organization, or substantially all assets of one, or subdividing an -organization, or merging organizations. If propagation of a covered -work results from an entity transaction, each party to that -transaction who receives a copy of the work also receives whatever -licenses to the work the party's predecessor in interest had or could -give under the previous paragraph, plus a right to possession of the -Corresponding Source of the work from the predecessor in interest, if -the predecessor has it or can get it with reasonable efforts. - - You may not impose any further restrictions on the exercise of the -rights granted or affirmed under this License. For example, you may -not impose a license fee, royalty, or other charge for exercise of -rights granted under this License, and you may not initiate litigation -(including a cross-claim or counterclaim in a lawsuit) alleging that -any patent claim is infringed by making, using, selling, offering for -sale, or importing the Program or any portion of it. - - 11. Patents. - - A "contributor" is a copyright holder who authorizes use under this -License of the Program or a work on which the Program is based. The -work thus licensed is called the contributor's "contributor version". - - A contributor's "essential patent claims" are all patent claims -owned or controlled by the contributor, whether already acquired or -hereafter acquired, that would be infringed by some manner, permitted -by this License, of making, using, or selling its contributor version, -but do not include claims that would be infringed only as a -consequence of further modification of the contributor version. For -purposes of this definition, "control" includes the right to grant -patent sublicenses in a manner consistent with the requirements of -this License. - - Each contributor grants you a non-exclusive, worldwide, royalty-free -patent license under the contributor's essential patent claims, to -make, use, sell, offer for sale, import and otherwise run, modify and -propagate the contents of its contributor version. - - In the following three paragraphs, a "patent license" is any express -agreement or commitment, however denominated, not to enforce a patent -(such as an express permission to practice a patent or covenant not to -sue for patent infringement). To "grant" such a patent license to a -party means to make such an agreement or commitment not to enforce a -patent against the party. - - If you convey a covered work, knowingly relying on a patent license, -and the Corresponding Source of the work is not available for anyone -to copy, free of charge and under the terms of this License, through a -publicly available network server or other readily accessible means, -then you must either (1) cause the Corresponding Source to be so -available, or (2) arrange to deprive yourself of the benefit of the -patent license for this particular work, or (3) arrange, in a manner -consistent with the requirements of this License, to extend the patent -license to downstream recipients. "Knowingly relying" means you have -actual knowledge that, but for the patent license, your conveying the -covered work in a country, or your recipient's use of the covered work -in a country, would infringe one or more identifiable patents in that -country that you have reason to believe are valid. - - If, pursuant to or in connection with a single transaction or -arrangement, you convey, or propagate by procuring conveyance of, a -covered work, and grant a patent license to some of the parties -receiving the covered work authorizing them to use, propagate, modify -or convey a specific copy of the covered work, then the patent license -you grant is automatically extended to all recipients of the covered -work and works based on it. - - A patent license is "discriminatory" if it does not include within -the scope of its coverage, prohibits the exercise of, or is -conditioned on the non-exercise of one or more of the rights that are -specifically granted under this License. You may not convey a covered -work if you are a party to an arrangement with a third party that is -in the business of distributing software, under which you make payment -to the third party based on the extent of your activity of conveying -the work, and under which the third party grants, to any of the -parties who would receive the covered work from you, a discriminatory -patent license (a) in connection with copies of the covered work -conveyed by you (or copies made from those copies), or (b) primarily -for and in connection with specific products or compilations that -contain the covered work, unless you entered into that arrangement, -or that patent license was granted, prior to 28 March 2007. - - Nothing in this License shall be construed as excluding or limiting -any implied license or other defenses to infringement that may -otherwise be available to you under applicable patent law. - - 12. No Surrender of Others' Freedom. - - If conditions are imposed on you (whether by court order, agreement or -otherwise) that contradict the conditions of this License, they do not -excuse you from the conditions of this License. If you cannot convey a -covered work so as to satisfy simultaneously your obligations under this -License and any other pertinent obligations, then as a consequence you may -not convey it at all. For example, if you agree to terms that obligate you -to collect a royalty for further conveying from those to whom you convey -the Program, the only way you could satisfy both those terms and this -License would be to refrain entirely from conveying the Program. - - 13. Use with the GNU Affero General Public License. - - Notwithstanding any other provision of this License, you have -permission to link or combine any covered work with a work licensed -under version 3 of the GNU Affero General Public License into a single -combined work, and to convey the resulting work. The terms of this -License will continue to apply to the part which is the covered work, -but the special requirements of the GNU Affero General Public License, -section 13, concerning interaction through a network will apply to the -combination as such. - - 14. Revised Versions of this License. - - The Free Software Foundation may publish revised and/or new versions of -the GNU General Public License from time to time. Such new versions will -be similar in spirit to the present version, but may differ in detail to -address new problems or concerns. - - Each version is given a distinguishing version number. If the -Program specifies that a certain numbered version of the GNU General -Public License "or any later version" applies to it, you have the -option of following the terms and conditions either of that numbered -version or of any later version published by the Free Software -Foundation. If the Program does not specify a version number of the -GNU General Public License, you may choose any version ever published -by the Free Software Foundation. - - If the Program specifies that a proxy can decide which future -versions of the GNU General Public License can be used, that proxy's -public statement of acceptance of a version permanently authorizes you -to choose that version for the Program. - - Later license versions may give you additional or different -permissions. However, no additional obligations are imposed on any -author or copyright holder as a result of your choosing to follow a -later version. - - 15. Disclaimer of Warranty. - - THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY -APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT -HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY -OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, -THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR -PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM -IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF -ALL NECESSARY SERVICING, REPAIR OR CORRECTION. - - 16. Limitation of Liability. - - IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING -WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS -THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY -GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE -USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF -DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD -PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), -EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF -SUCH DAMAGES. - - 17. Interpretation of Sections 15 and 16. - - If the disclaimer of warranty and limitation of liability provided -above cannot be given local legal effect according to their terms, -reviewing courts shall apply local law that most closely approximates -an absolute waiver of all civil liability in connection with the -Program, unless a warranty or assumption of liability accompanies a -copy of the Program in return for a fee. - - END OF TERMS AND CONDITIONS - - How to Apply These Terms to Your New Programs - - If you develop a new program, and you want it to be of the greatest -possible use to the public, the best way to achieve this is to make it -free software which everyone can redistribute and change under these terms. - - To do so, attach the following notices to the program. It is safest -to attach them to the start of each source file to most effectively -state the exclusion of warranty; and each file should have at least -the "copyright" line and a pointer to where the full notice is found. - - - Copyright (C) - - This program is free software: you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by - the Free Software Foundation, either version 3 of the License, or - (at your option) any later version. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program. If not, see . - -Also add information on how to contact you by electronic and paper mail. - - If the program does terminal interaction, make it output a short -notice like this when it starts in an interactive mode: - - Copyright (C) - This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. - This is free software, and you are welcome to redistribute it - under certain conditions; type `show c' for details. - -The hypothetical commands `show w' and `show c' should show the appropriate -parts of the General Public License. Of course, your program's commands -might be different; for a GUI interface, you would use an "about box". - - You should also get your employer (if you work as a programmer) or school, -if any, to sign a "copyright disclaimer" for the program, if necessary. -For more information on this, and how to apply and follow the GNU GPL, see -. - - The GNU General Public License does not permit incorporating your program -into proprietary programs. If your program is a subroutine library, you -may consider it more useful to permit linking proprietary applications with -the library. If this is what you want to do, use the GNU Lesser General -Public License instead of this License. But first, please read -. +MIT License + +Copyright (c) 2021 Philipp S. Sommer + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/MANIFEST.in b/MANIFEST.in deleted file mode 100644 index 2bf217b..0000000 --- a/MANIFEST.in +++ /dev/null @@ -1,5 +0,0 @@ -include README.rst -include LICENSE -include psy_view/icons/*.png -include versioneer.py -include psy_view/_version.py diff --git a/README.md b/README.md new file mode 100644 index 0000000..805ea07 --- /dev/null +++ b/README.md @@ -0,0 +1,3 @@ +# psy-view-redirect + +Dummy repository for redirecting to from RTD to github diff --git a/README.rst b/README.rst deleted file mode 100644 index 4c30a1a..0000000 --- a/README.rst +++ /dev/null @@ -1,200 +0,0 @@ -========================================= -psy-view: An ncview-like GUI with psyplot -========================================= - -.. start-badges - -.. list-table:: - :stub-columns: 1 - :widths: 10 90 - - * - docs - - |docs| |mybinder| - * - tests - - |circleci| |appveyor| |codecov| - * - package - - |version| |conda| |github| |zenodo| - * - implementations - - |supported-versions| |supported-implementations| - * - get in touch - - |gitter| |mailing-list| |issues| - -.. |docs| image:: https://img.shields.io/github/deployments/psyplot/psy-view/github-pages - :alt: Documentation - :target: http://psyplot.github.io/psy-view/ - -.. |mybinder| image:: https://mybinder.org/badge_logo.svg - :target: https://mybinder.org/v2/gh/psyplot/psy-view/master?urlpath=%2Fdesktop - :alt: mybinder.org - -.. |circleci| image:: https://circleci.com/gh/psyplot/psy-view/tree/master.svg?style=svg - :alt: CircleCI - :target: https://circleci.com/gh/psyplot/psy-view/tree/master - -.. |appveyor| image:: https://ci.appveyor.com/api/projects/status/a7qxvvwt0e41j32h/branch/master?svg=true - :alt: AppVeyor - :target: https://ci.appveyor.com/project/psyplot/psy-view/branch/master - -.. |codecov| image:: https://codecov.io/gh/psyplot/psy-view/branch/master/graph/badge.svg - :alt: Coverage - :target: https://codecov.io/gh/psyplot/psy-view - -.. |conda| image:: https://anaconda.org/conda-forge/psy-view/badges/version.svg - :alt: conda - :target: https://anaconda.org/conda-forge/psy-view - -.. |github| image:: https://img.shields.io/github/release/psyplot/psy-view.svg - :target: https://github.com/psyplot/psy-view/releases/latest - :alt: Latest github release - -.. |version| image:: https://img.shields.io/pypi/v/psy-view.svg?style=flat - :alt: PyPI Package latest release - :target: https://pypi.python.org/pypi/psy-view - -.. |supported-versions| image:: https://img.shields.io/pypi/pyversions/psy-view.svg?style=flat - :alt: Supported versions - :target: https://pypi.python.org/pypi/psy-view - -.. |supported-implementations| image:: https://img.shields.io/pypi/implementation/psy-view.svg?style=flat - :alt: Supported implementations - :target: https://pypi.python.org/pypi/psy-view - -.. |gitter| image:: https://img.shields.io/gitter/room/psyplot/community.svg?style=flat - :target: https://gitter.im/psyplot/community - :alt: Gitter - -.. |mailing-list| image:: https://img.shields.io/badge/join-mailing%20list-brightgreen.svg?style=flat - :target: https://www.listserv.dfn.de/sympa/subscribe/psyplot - :alt: DFN mailing list - -.. |issues| image:: https://img.shields.io/github/issues-raw/psyplot/psy-view.svg?style=flat - :target: https://github.com/psyplot/psy-view/issues - :alt: GitHub issues - -.. |zenodo| image:: https://zenodo.org/badge/249615633.svg - :alt: Zenodo - :target: https://zenodo.org/badge/latestdoi/249615633 - -.. end-badges - -This package defines a viewer application for netCDF files, that is highly -motivated by the ncview_ package but entirely built upon the psyplot framework. -It supports strucutured and unstructured grids and provides an intuitive -graphical user interface to quickly dive into the data inside a netCDF file. - -.. _ncview: http://meteora.ucsd.edu/~pierce/ncview_home_page.html - -**This package is currently under development and we highly appreciate your -feedback! Please try it out yourself and, if you would like to see more features, -find bugs or want to say anything else, please leave your comments and -experiences at https://github.com/psyplot/psy-view/issues or send a mail to -psyplot@hzg.de.** - -.. image:: docs/_static/screenshot.png - :alt: Screenshot - :target: https://github.com/psyplot/psy-view - -Features --------- -Some of the most important features offered by psy-view are: - -- intuitive GUI to select variables, dimensions, slices, etc. and change the - plot -- automatically decodes CF-conventions and supports unstructured grid, such as - ICON_ or UGRID_ -- animation interface -- different projections -- implemented in psyplot-gui_ for full flexibility (if desired) - -.. _ICON: https://mpimet.mpg.de/en/science/modeling-with-icon/icon-configurations -.. _UGRID: http://ugrid-conventions.github.io/ugrid-conventions/ -.. _psyplot-gui: https://psyplot.github.io/psyplot-gui - - -Test it without installation ----------------------------- -You can try the functionalities with some selected example files headless in -your browser by clicking on |mybinder|. Note that it might take a bit to load -and that the speed depends on your WiFi-connection. - - -Installation ------------- -To install the current work-in-progress, please - -1. download Miniconda_ -2. open the terminal (or `Anaconda Prompt` on Windows) and type:: - - conda create -n psyplot -c conda-forge psy-view - - On Linux and OS X, you may instead want to type:: - - $ conda create -n psyplot -c conda-forge --override-channels psy-view - - in order to not mix the anaconda defaults and and conda-forge channel, because - mixing them can sometimes cause incompatibilities. -3. The commands above will installed psy-view and all it's necessary - dependencies into a separate environment. You can activate it via:: - - - conda activate psyplot - -4. Now launch the GUI via typing:: - - psy-view - - or:: - - psy-view - - See ``psy-view --help`` for more options - -.. _Miniconda: https://conda.io/en/latest/miniconda.html - - -As an alternativ to a local installation, you can also run it -headless in you browser by clicking |mybinder| - - -For alternative installation instructions, update information or deinstallation -instructions, please have a look into the `installation docs`_. - -.. _installation docs: https://psyplot.github.io/psy-view/installing.html - - -Get in touch ------------- -Any quesions? Do not hessitate to get in touch with the psyplot developers. - -- Create an issue at the `bug tracker`_ -- Chat with the developers in out `channel on gitter`_ -- Subscribe to the `mailing list`_ and ask for support -- Sent a mail to psyplot@hzg.de - -See also the `code of conduct`_, and our `contribution guide`_ for more -information and a guide about good bug reports. - -.. _bug tracker: https://github.com/psyplot/psy-view -.. _channel on gitter: https://gitter.im/psyplot/community -.. _mailing list: https://www.listserv.dfn.de/sympa/subscribe/psyplot -.. _code of conduct: https://github.com/psyplot/psyplot/blob/master/CODE_OF_CONDUCT.md -.. _contribution guide: https://github.com/psyplot/psyplot/blob/master/CONTRIBUTING.md - - - -Copyright disclaimer --------------------- -Copyright (C) 2020 Philipp S. Sommer - -This program is free software: you can redistribute it and/or modify -it under the terms of the GNU General Public License as published by -the Free Software Foundation, either version 3 of the License, or -(at your option) any later version. - -This program is distributed in the hope that it will be useful, -but WITHOUT ANY WARRANTY; without even the implied warranty of -MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -GNU General Public License for more details. - -You should have received a copy of the GNU General Public License -along with this program. If not, see https://www.gnu.org/licenses/. diff --git a/binder/apt.txt b/binder/apt.txt deleted file mode 100644 index 7d6a1c4..0000000 --- a/binder/apt.txt +++ /dev/null @@ -1,10 +0,0 @@ -dbus-x11 -xfce4 -xfce4-panel -xfce4-session -xfce4-settings -xorg -xubuntu-icon-theme -libxss1 -libpci3 -libasound2 diff --git a/binder/environment.yml b/binder/environment.yml deleted file mode 100644 index 154fd83..0000000 --- a/binder/environment.yml +++ /dev/null @@ -1,18 +0,0 @@ -channels: -- psyplot/label/master -- psyplot -- manics # Used by jupyter-desktop-server -- conda-forge -dependencies: -- psy-maps -- psyplot-gui -- netcdf4 -- pip -- ncview -- matplotlib>=3.3 -- cartopy>=0.18 - -# Required for jupyter-desktop-server -- websockify -- pip: - - jupyter-desktop-server diff --git a/binder/postBuild b/binder/postBuild deleted file mode 100755 index 9cb727e..0000000 --- a/binder/postBuild +++ /dev/null @@ -1,75 +0,0 @@ -#!/bin/bash - -set -euo pipefail - -mkdir -p $HOME/Desktop - -cp -r tests/*.nc $HOME/Desktop - -python -m pip install ./ - -cat > $HOME/Desktop/Psy-View.desktop << EOF -[Desktop Entry] -Version=1.0 -Type=Application -Name=Psy-View -Exec=$(which psy-view) %f -Icon=$HOME/icon/psy-view.svg -Path=$HOME/Desktop -MimeType=application/x-netcdf; -EOF - -cat > $HOME/Desktop/Psyplot.desktop << EOF -[Desktop Entry] -Version=1.0 -Type=Application -Name=Psyplot -Exec=$(which psyplot) %f -Icon=$HOME/icon/psyplot.svg -Path=$HOME/Desktop -MimeType=application/x-netcdf; -EOF - -chmod u+x $HOME/Desktop/Psyplot.desktop $HOME/Desktop/Psy-View.desktop - -# associate default applications -mkdir -p $HOME/.local/share/applications/ -ln -s $HOME/Desktop/Psyplot.desktop $HOME/.local/share/applications/ -ln -s $HOME/Desktop/Psy-View.desktop $HOME/.local/share/applications/ - -cat > $HOME/.config/mimeapps.list << EOF -[Default Applications] -application/x-netcdf=Psy-View.Desktop - -[Added Associations] -application/x-netcdf=Psy-View.desktop;application/x-netcdf=Psyplot.desktop; -EOF - -# create a demo preset -mkdir -p $HOME/.config/psyplot/presets -cat > $HOME/.config/psyplot/presets/EUR-temperature.yml << EOF -clabel: '%(long_name)s %(units)s' -cmap: YlOrRd -datagrid: k- -lonlatbox: Europe -lsm: - coast: - - 0.0 - - 0.0 - - 0.0 - - 1.0 - land: - - 0.6666666666666666 - - 0.3333333333333333 - - 0.0 - - 1.0 - ocean: - - 0.592156862745098 - - 0.7137254901960784 - - 0.8823529411764706 - - 1.0 - res: 50m -title: '%(long_name)s over Europe' -xgrid: false -ygrid: false -EOF diff --git a/ci/conda-recipe/bld.bat b/ci/conda-recipe/bld.bat deleted file mode 100644 index 0579b80..0000000 --- a/ci/conda-recipe/bld.bat +++ /dev/null @@ -1,11 +0,0 @@ -%PYTHON% -m pip install . --no-deps --ignore-installed -vvv -if errorlevel 1 exit 1 - -set MENU_DIR=%PREFIX%\Menu -IF NOT EXIST (%MENU_DIR%) mkdir %MENU_DIR% - -copy %RECIPE_DIR%\psyplot.ico %MENU_DIR%\psyplot.ico -if errorlevel 1 exit 1 - -copy %RECIPE_DIR%\menu-windows.json %MENU_DIR%\psy-view_shortcut.json -if errorlevel 1 exit 1 diff --git a/ci/conda-recipe/build.sh b/ci/conda-recipe/build.sh deleted file mode 100644 index 614ec75..0000000 --- a/ci/conda-recipe/build.sh +++ /dev/null @@ -1,3 +0,0 @@ -#!/bin/bash - -$PYTHON -m pip install . --no-deps --ignore-installed -vvv diff --git a/ci/conda-recipe/logo.png b/ci/conda-recipe/logo.png deleted file mode 100644 index b0d09f5..0000000 Binary files a/ci/conda-recipe/logo.png and /dev/null differ diff --git a/ci/conda-recipe/menu-windows.json b/ci/conda-recipe/menu-windows.json deleted file mode 100644 index dbd5f09..0000000 --- a/ci/conda-recipe/menu-windows.json +++ /dev/null @@ -1,12 +0,0 @@ -{ - "menu_name": "Psyplot", - "menu_items": - [ - { - "name": "Psy-view", - "pywscript": "${PYTHON_SCRIPTS}/psy-view-script.py", - "workdir": "${PERSONALDIR}", - "icon": "${MENU_DIR}/psyplot.ico" - } - ] -} diff --git a/ci/conda-recipe/meta.yaml b/ci/conda-recipe/meta.yaml deleted file mode 100644 index 0dcdf05..0000000 --- a/ci/conda-recipe/meta.yaml +++ /dev/null @@ -1,68 +0,0 @@ -{% set data = load_setup_py_data() %} -{% set name = "psy-view" %} - -package: - name: {{ name|lower }} - version: {{ data.get('version') }} - -source: - path: ../.. - -build: - number: {{ environ.get('GIT_DESCRIBE_NUMBER', 0) }} - string: py{{ environ.get('CONDA_PY') }}{% if environ.get("BUILD_STR_END") %}_{{ environ.get("BUILD_STR_END") }}{% endif %} - entry_points: - - psy-view = psy_view:main - skip: true # [py == 36] - -requirements: - host: - - python - - pip - run: - - python - - psyplot-gui >=1.3.0 - - psy-maps >=1.3.0 - - netcdf4 - -test: - imports: - - psy_view - - psy_view.ds_widget - - requires: - - pytest - - pytest-cov - - pytest-qt - - codecov - - dask - - netcdf4 - - seaborn - - pillow - - psy-maps - source_files: - - tests - - commands: - - psy-view --help - - pytest -sv --cov=psy_view - - codecov - -app: - entry: psy-view - icon: logo.png - summary: Quick-view for netCDF files - type: desk - -about: - home: https://github.com/psyplot/psy-view - license: GPL-3.0 - license_family: GPL - license_file: LICENSE - summary: ncview-like interface to psyplot - - description: | - This package provides a graphical user interface to quickly visualize the - contents of a netCDF file - doc_url: http://psyplot.github.io/psy-view - dev_url: https://github.com/psyplot/psy-view diff --git a/ci/conda-recipe/psyplot.ico b/ci/conda-recipe/psyplot.ico deleted file mode 100644 index 441a5d4..0000000 Binary files a/ci/conda-recipe/psyplot.ico and /dev/null differ diff --git a/docs/Makefile b/docs/Makefile index d4bb2cb..191ffff 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -1,20 +1,192 @@ -# Minimal makefile for Sphinx documentation +# Makefile for Sphinx documentation # -# You can set these variables from the command line, and also -# from the environment for the first two. -SPHINXOPTS ?= -SPHINXBUILD ?= sphinx-build -SOURCEDIR = . +# You can set these variables from the command line. +SPHINXOPTS = +SPHINXBUILD = sphinx-build +PAPER = BUILDDIR = _build -# Put it first so that "make" without argument is like "make help". +# User-friendly check for sphinx-build +ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1) +$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/) +endif + +# Internal variables. +PAPEROPT_a4 = -D latex_paper_size=a4 +PAPEROPT_letter = -D latex_paper_size=letter +ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . +# the i18n builder cannot share the environment and doctrees with the others +I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . + +.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest coverage gettext + help: - @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) + @echo "Please use \`make ' where is one of" + @echo " html to make standalone HTML files" + @echo " dirhtml to make HTML files named index.html in directories" + @echo " singlehtml to make a single large HTML file" + @echo " pickle to make pickle files" + @echo " json to make JSON files" + @echo " htmlhelp to make HTML files and a HTML help project" + @echo " qthelp to make HTML files and a qthelp project" + @echo " applehelp to make an Apple Help Book" + @echo " devhelp to make HTML files and a Devhelp project" + @echo " epub to make an epub" + @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" + @echo " latexpdf to make LaTeX files and run them through pdflatex" + @echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx" + @echo " text to make text files" + @echo " man to make manual pages" + @echo " texinfo to make Texinfo files" + @echo " info to make Texinfo files and run them through makeinfo" + @echo " gettext to make PO message catalogs" + @echo " changes to make an overview of all changed/added/deprecated items" + @echo " xml to make Docutils-native XML files" + @echo " pseudoxml to make pseudoxml-XML files for display purposes" + @echo " linkcheck to check all external links for integrity" + @echo " doctest to run all doctests embedded in the documentation (if enabled)" + @echo " coverage to run coverage check of the documentation (if enabled)" + +clean: + rm -rf $(BUILDDIR)/* + +html: + $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." + +dirhtml: + $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." + +singlehtml: + $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml + @echo + @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." + +pickle: + $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle + @echo + @echo "Build finished; now you can process the pickle files." + +json: + $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json + @echo + @echo "Build finished; now you can process the JSON files." + +htmlhelp: + $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp + @echo + @echo "Build finished; now you can run HTML Help Workshop with the" \ + ".hhp project file in $(BUILDDIR)/htmlhelp." + +qthelp: + $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp + @echo + @echo "Build finished; now you can run "qcollectiongenerator" with the" \ + ".qhcp project file in $(BUILDDIR)/qthelp, like this:" + @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/syplot.qhcp" + @echo "To view the help file:" + @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/syplot.qhc" + +applehelp: + $(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp + @echo + @echo "Build finished. The help book is in $(BUILDDIR)/applehelp." + @echo "N.B. You won't be able to view it unless you put it in" \ + "~/Library/Documentation/Help or install it in your application" \ + "bundle." + +devhelp: + $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp + @echo + @echo "Build finished." + @echo "To view the help file:" + @echo "# mkdir -p $$HOME/.local/share/devhelp/syplot" + @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/syplot" + @echo "# devhelp" + +epub: + $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub + @echo + @echo "Build finished. The epub file is in $(BUILDDIR)/epub." + +latex: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo + @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." + @echo "Run \`make' in that directory to run these through (pdf)latex" \ + "(use \`make latexpdf' here to do that automatically)." + +latexpdf: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo "Running LaTeX files through pdflatex..." + $(MAKE) -C $(BUILDDIR)/latex all-pdf + @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." + +latexpdfja: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo "Running LaTeX files through platex and dvipdfmx..." + $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja + @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." + +text: + $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text + @echo + @echo "Build finished. The text files are in $(BUILDDIR)/text." + +man: + $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man + @echo + @echo "Build finished. The manual pages are in $(BUILDDIR)/man." + +texinfo: + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo + @echo + @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo." + @echo "Run \`make' in that directory to run these through makeinfo" \ + "(use \`make info' here to do that automatically)." + +info: + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo + @echo "Running Texinfo files through makeinfo..." + make -C $(BUILDDIR)/texinfo info + @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo." + +gettext: + $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale + @echo + @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale." + +changes: + $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes + @echo + @echo "The overview file is in $(BUILDDIR)/changes." + +linkcheck: + $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck + @echo + @echo "Link check complete; look for any errors in the above output " \ + "or in $(BUILDDIR)/linkcheck/output.txt." + +doctest: + $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest + @echo "Testing of doctests in the sources finished, look at the " \ + "results in $(BUILDDIR)/doctest/output.txt." + +coverage: + $(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage + @echo "Testing of coverage in the sources finished, look at the " \ + "results in $(BUILDDIR)/coverage/python.txt." -.PHONY: help Makefile +xml: + $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml + @echo + @echo "Build finished. The XML files are in $(BUILDDIR)/xml." -# Catch-all target: route all unknown targets to Sphinx using the new -# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). -%: Makefile - @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) +pseudoxml: + $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml + @echo + @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml." diff --git a/docs/_build/doctrees/api/psy_simple.colors.doctree b/docs/_build/doctrees/api/psy_simple.colors.doctree new file mode 100644 index 0000000..0655a0e Binary files /dev/null and b/docs/_build/doctrees/api/psy_simple.colors.doctree differ diff --git a/docs/_build/doctrees/api/psy_simple.doctree b/docs/_build/doctrees/api/psy_simple.doctree new file mode 100644 index 0000000..5909ea8 Binary files /dev/null and b/docs/_build/doctrees/api/psy_simple.doctree differ diff --git a/docs/_build/doctrees/api/psy_simple.plotters.doctree b/docs/_build/doctrees/api/psy_simple.plotters.doctree new file mode 100644 index 0000000..71da720 Binary files /dev/null and b/docs/_build/doctrees/api/psy_simple.plotters.doctree differ diff --git a/docs/_build/doctrees/api/psy_simple.plugin.doctree b/docs/_build/doctrees/api/psy_simple.plugin.doctree new file mode 100644 index 0000000..7639864 Binary files /dev/null and b/docs/_build/doctrees/api/psy_simple.plugin.doctree differ diff --git a/docs/_build/doctrees/api/psy_simple.widgets.colors.doctree b/docs/_build/doctrees/api/psy_simple.widgets.colors.doctree new file mode 100644 index 0000000..39bbdaf Binary files /dev/null and b/docs/_build/doctrees/api/psy_simple.widgets.colors.doctree differ diff --git a/docs/_build/doctrees/api/psy_simple.widgets.doctree b/docs/_build/doctrees/api/psy_simple.widgets.doctree new file mode 100644 index 0000000..760dac5 Binary files /dev/null and b/docs/_build/doctrees/api/psy_simple.widgets.doctree differ diff --git a/docs/_build/doctrees/api/psy_simple.widgets.texts.doctree b/docs/_build/doctrees/api/psy_simple.widgets.texts.doctree new file mode 100644 index 0000000..f18ecaf Binary files /dev/null and b/docs/_build/doctrees/api/psy_simple.widgets.texts.doctree differ diff --git a/docs/_build/doctrees/changelog.doctree b/docs/_build/doctrees/changelog.doctree new file mode 100644 index 0000000..8fe055a Binary files /dev/null and b/docs/_build/doctrees/changelog.doctree differ diff --git a/docs/_build/doctrees/contribute.doctree b/docs/_build/doctrees/contribute.doctree new file mode 100644 index 0000000..a100bb9 Binary files /dev/null and b/docs/_build/doctrees/contribute.doctree differ diff --git a/docs/_build/doctrees/environment.pickle b/docs/_build/doctrees/environment.pickle new file mode 100644 index 0000000..7d68e54 Binary files /dev/null and b/docs/_build/doctrees/environment.pickle differ diff --git a/docs/_build/doctrees/generated/psyplot.project.plot.barplot.doctree b/docs/_build/doctrees/generated/psyplot.project.plot.barplot.doctree new file mode 100644 index 0000000..2cd53f8 Binary files /dev/null and b/docs/_build/doctrees/generated/psyplot.project.plot.barplot.doctree differ diff --git a/docs/_build/doctrees/generated/psyplot.project.plot.combined.doctree b/docs/_build/doctrees/generated/psyplot.project.plot.combined.doctree new file mode 100644 index 0000000..3b21745 Binary files /dev/null and b/docs/_build/doctrees/generated/psyplot.project.plot.combined.doctree differ diff --git a/docs/_build/doctrees/generated/psyplot.project.plot.density.doctree b/docs/_build/doctrees/generated/psyplot.project.plot.density.doctree new file mode 100644 index 0000000..cd67953 Binary files /dev/null and b/docs/_build/doctrees/generated/psyplot.project.plot.density.doctree differ diff --git a/docs/_build/doctrees/generated/psyplot.project.plot.fldmean.doctree b/docs/_build/doctrees/generated/psyplot.project.plot.fldmean.doctree new file mode 100644 index 0000000..d0f6cd7 Binary files /dev/null and b/docs/_build/doctrees/generated/psyplot.project.plot.fldmean.doctree differ diff --git a/docs/_build/doctrees/generated/psyplot.project.plot.lineplot.doctree b/docs/_build/doctrees/generated/psyplot.project.plot.lineplot.doctree new file mode 100644 index 0000000..7363170 Binary files /dev/null and b/docs/_build/doctrees/generated/psyplot.project.plot.lineplot.doctree differ diff --git a/docs/_build/doctrees/generated/psyplot.project.plot.plot2d.doctree b/docs/_build/doctrees/generated/psyplot.project.plot.plot2d.doctree new file mode 100644 index 0000000..52a3862 Binary files /dev/null and b/docs/_build/doctrees/generated/psyplot.project.plot.plot2d.doctree differ diff --git a/docs/_build/doctrees/generated/psyplot.project.plot.vector.doctree b/docs/_build/doctrees/generated/psyplot.project.plot.vector.doctree new file mode 100644 index 0000000..5840f7d Binary files /dev/null and b/docs/_build/doctrees/generated/psyplot.project.plot.vector.doctree differ diff --git a/docs/_build/doctrees/generated/psyplot.project.plot.violinplot.doctree b/docs/_build/doctrees/generated/psyplot.project.plot.violinplot.doctree new file mode 100644 index 0000000..6a64c11 Binary files /dev/null and b/docs/_build/doctrees/generated/psyplot.project.plot.violinplot.doctree differ diff --git a/docs/_build/doctrees/index.doctree b/docs/_build/doctrees/index.doctree new file mode 100644 index 0000000..35daa10 Binary files /dev/null and b/docs/_build/doctrees/index.doctree differ diff --git a/docs/_build/doctrees/installing.doctree b/docs/_build/doctrees/installing.doctree new file mode 100644 index 0000000..76c5008 Binary files /dev/null and b/docs/_build/doctrees/installing.doctree differ diff --git a/docs/_build/doctrees/plot_methods.doctree b/docs/_build/doctrees/plot_methods.doctree new file mode 100644 index 0000000..d268ebf Binary files /dev/null and b/docs/_build/doctrees/plot_methods.doctree differ diff --git a/docs/_build/html/.buildinfo b/docs/_build/html/.buildinfo new file mode 100644 index 0000000..4b6a178 --- /dev/null +++ b/docs/_build/html/.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: 1d50483337eb779add1fca7e73a4c7f1 +tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/docs/_build/html/_sources/api/psy_simple.colors.rst.txt b/docs/_build/html/_sources/api/psy_simple.colors.rst.txt new file mode 100644 index 0000000..2f81f55 --- /dev/null +++ b/docs/_build/html/_sources/api/psy_simple.colors.rst.txt @@ -0,0 +1,9 @@ +psy\_simple.colors module +========================= + +.. raw:: html + +

+ The documentation of psy-simple is now hosted at, https://psyplot.github.io/psy-simple/api/psy_simple.colors.html. + You should be redirected within 5 seconds. +

diff --git a/docs/_build/html/_sources/api/psy_simple.plotters.rst.txt b/docs/_build/html/_sources/api/psy_simple.plotters.rst.txt new file mode 100644 index 0000000..ca5e961 --- /dev/null +++ b/docs/_build/html/_sources/api/psy_simple.plotters.rst.txt @@ -0,0 +1,10 @@ +psy\_simple.plotters module +=========================== + + +.. raw:: html + +

+ The documentation of psy-simple is now hosted at, https://psyplot.github.io/psy-simple/api/psy_simple.plotters.html. + You should be redirected within 5 seconds. +

diff --git a/docs/_build/html/_sources/api/psy_simple.plugin.rst.txt b/docs/_build/html/_sources/api/psy_simple.plugin.rst.txt new file mode 100644 index 0000000..049df78 --- /dev/null +++ b/docs/_build/html/_sources/api/psy_simple.plugin.rst.txt @@ -0,0 +1,10 @@ +psy\_simple.plugin module +========================= + + +.. raw:: html + +

+ The documentation of psy-simple is now hosted at, https://psyplot.github.io/psy-simple/api/psy_simple.plugin.html. + You should be redirected within 5 seconds. +

diff --git a/docs/_build/html/_sources/api/psy_simple.rst.txt b/docs/_build/html/_sources/api/psy_simple.rst.txt new file mode 100644 index 0000000..6a24f89 --- /dev/null +++ b/docs/_build/html/_sources/api/psy_simple.rst.txt @@ -0,0 +1,32 @@ +API Reference +=================== + + +.. raw:: html + +

+ The documentation of psy-simple is now hosted at, https://psyplot.github.io/psy-simple/api/psy_simple.html. + You should be redirected within 5 seconds. +

+ + +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + :hidden: + + psy_simple.widgets + +Submodules +---------- + +.. toctree:: + :maxdepth: 4 + :hidden: + + psy_simple.base + psy_simple.colors + psy_simple.plotters + psy_simple.plugin diff --git a/docs/_build/html/_sources/api/psy_simple.widgets.colors.rst.txt b/docs/_build/html/_sources/api/psy_simple.widgets.colors.rst.txt new file mode 100644 index 0000000..fbba686 --- /dev/null +++ b/docs/_build/html/_sources/api/psy_simple.widgets.colors.rst.txt @@ -0,0 +1,10 @@ +psy\_simple.widgets.colors module +================================= + + +.. raw:: html + +

+ The documentation of psy-simple is now hosted at, https://psyplot.github.io/psy-simple/api/psy_simple.widgets.colors.html. + You should be redirected within 5 seconds. +

diff --git a/docs/_build/html/_sources/api/psy_simple.widgets.rst.txt b/docs/_build/html/_sources/api/psy_simple.widgets.rst.txt new file mode 100644 index 0000000..2b143ac --- /dev/null +++ b/docs/_build/html/_sources/api/psy_simple.widgets.rst.txt @@ -0,0 +1,20 @@ +psy\_simple.widgets package +=========================== + + +.. raw:: html + +

+ The documentation of psy-simple is now hosted at, https://psyplot.github.io/psy-simple/api/psy_simple.widgets.html. + You should be redirected within 5 seconds. +

+ +Submodules +---------- + +.. toctree:: + :maxdepth: 4 + :hidden: + + psy_simple.widgets.colors + psy_simple.widgets.texts diff --git a/docs/_build/html/_sources/api/psy_simple.widgets.texts.rst.txt b/docs/_build/html/_sources/api/psy_simple.widgets.texts.rst.txt new file mode 100644 index 0000000..44c5806 --- /dev/null +++ b/docs/_build/html/_sources/api/psy_simple.widgets.texts.rst.txt @@ -0,0 +1,9 @@ +psy\_simple.widgets.texts module +================================ + +.. raw:: html + +

+ The documentation of psy-simple is now hosted at, https://psyplot.github.io/psy-simple/api/psy_simple.widgets.texts.html. + You should be redirected within 5 seconds. +

diff --git a/docs/_build/html/_sources/changelog.rst.txt b/docs/_build/html/_sources/changelog.rst.txt new file mode 100644 index 0000000..17cdc29 --- /dev/null +++ b/docs/_build/html/_sources/changelog.rst.txt @@ -0,0 +1,11 @@ +.. _changelog: + +Changelog +********* + +.. raw:: html + +

+ The documentation of psy-simple is now hosted at, https://psyplot.github.io/psy-simple/changelog.html. + You should be redirected within 5 seconds. +

diff --git a/docs/_build/html/_sources/contribute.rst.txt b/docs/_build/html/_sources/contribute.rst.txt new file mode 100644 index 0000000..933074d --- /dev/null +++ b/docs/_build/html/_sources/contribute.rst.txt @@ -0,0 +1,11 @@ +.. _how-to-contribute: + +Contributing to psy-simple +========================== + +.. raw:: html + +

+ The documentation of psy-simple is now hosted at, https://psyplot.github.io/psy-simple/contribute.html. + You should be redirected within 5 seconds. +

diff --git a/docs/_build/html/_sources/generated/psyplot.project.plot.barplot.rst.txt b/docs/_build/html/_sources/generated/psyplot.project.plot.barplot.rst.txt new file mode 100644 index 0000000..15d41ef --- /dev/null +++ b/docs/_build/html/_sources/generated/psyplot.project.plot.barplot.rst.txt @@ -0,0 +1,9 @@ +psyplot.project.plot.barplot +============================ + +.. raw:: html + +

+ The documentation of psy-simple is now hosted at, https://psyplot.github.io/psy-simple/generated/psyplot.project.plot.barplot.html. + You should be redirected within 5 seconds. +

diff --git a/docs/_build/html/_sources/generated/psyplot.project.plot.combined.rst.txt b/docs/_build/html/_sources/generated/psyplot.project.plot.combined.rst.txt new file mode 100644 index 0000000..4451c62 --- /dev/null +++ b/docs/_build/html/_sources/generated/psyplot.project.plot.combined.rst.txt @@ -0,0 +1,9 @@ +psyplot.project.plot.combined +============================= + +.. raw:: html + +

+ The documentation of psy-simple is now hosted at, https://psyplot.github.io/psy-simple/generated/psyplot.project.plot.combined.html. + You should be redirected within 5 seconds. +

diff --git a/docs/_build/html/_sources/generated/psyplot.project.plot.density.rst.txt b/docs/_build/html/_sources/generated/psyplot.project.plot.density.rst.txt new file mode 100644 index 0000000..ad87abf --- /dev/null +++ b/docs/_build/html/_sources/generated/psyplot.project.plot.density.rst.txt @@ -0,0 +1,9 @@ +psyplot.project.plot.density +============================ + +.. raw:: html + +

+ The documentation of psy-simple is now hosted at, https://psyplot.github.io/psy-simple/generated/psyplot.project.plot.density.html. + You should be redirected within 5 seconds. +

diff --git a/docs/_build/html/_sources/generated/psyplot.project.plot.fldmean.rst.txt b/docs/_build/html/_sources/generated/psyplot.project.plot.fldmean.rst.txt new file mode 100644 index 0000000..14706e9 --- /dev/null +++ b/docs/_build/html/_sources/generated/psyplot.project.plot.fldmean.rst.txt @@ -0,0 +1,9 @@ +psyplot.project.plot.fldmean +============================ + +.. raw:: html + +

+ The documentation of psy-simple is now hosted at, https://psyplot.github.io/psy-simple/generated/psyplot.project.plot.fldmean.html. + You should be redirected within 5 seconds. +

diff --git a/docs/_build/html/_sources/generated/psyplot.project.plot.lineplot.rst.txt b/docs/_build/html/_sources/generated/psyplot.project.plot.lineplot.rst.txt new file mode 100644 index 0000000..78f60bb --- /dev/null +++ b/docs/_build/html/_sources/generated/psyplot.project.plot.lineplot.rst.txt @@ -0,0 +1,9 @@ +psyplot.project.plot.lineplot +============================= + +.. raw:: html + +

+ The documentation of psy-simple is now hosted at, https://psyplot.github.io/psy-simple/generated/psyplot.project.plot.lineplot.html. + You should be redirected within 5 seconds. +

diff --git a/docs/_build/html/_sources/generated/psyplot.project.plot.plot2d.rst.txt b/docs/_build/html/_sources/generated/psyplot.project.plot.plot2d.rst.txt new file mode 100644 index 0000000..ba8f43e --- /dev/null +++ b/docs/_build/html/_sources/generated/psyplot.project.plot.plot2d.rst.txt @@ -0,0 +1,9 @@ +psyplot.project.plot.plot2d +=========================== + +.. raw:: html + +

+ The documentation of psy-simple is now hosted at, https://psyplot.github.io/psy-simple/generated/psyplot.project.plot.plot2d.html. + You should be redirected within 5 seconds. +

diff --git a/docs/_build/html/_sources/generated/psyplot.project.plot.vector.rst.txt b/docs/_build/html/_sources/generated/psyplot.project.plot.vector.rst.txt new file mode 100644 index 0000000..cf85af4 --- /dev/null +++ b/docs/_build/html/_sources/generated/psyplot.project.plot.vector.rst.txt @@ -0,0 +1,9 @@ +psyplot.project.plot.vector +=========================== + +.. raw:: html + +

+ The documentation of psy-simple is now hosted at, https://psyplot.github.io/psy-simple/generated/psyplot.project.plot.vector.html. + You should be redirected within 5 seconds. +

diff --git a/docs/_build/html/_sources/generated/psyplot.project.plot.violinplot.rst.txt b/docs/_build/html/_sources/generated/psyplot.project.plot.violinplot.rst.txt new file mode 100644 index 0000000..38b80d9 --- /dev/null +++ b/docs/_build/html/_sources/generated/psyplot.project.plot.violinplot.rst.txt @@ -0,0 +1,10 @@ +psyplot.project.plot.violinplot +=============================== + +.. raw:: html + +

+ The documentation of psy-simple is now hosted at, https://psyplot.github.io/psy-simple/generated/psyplot.project.plot.violinplot.html. + You should be redirected within 5 seconds. +

+ diff --git a/docs/_build/html/_sources/index.rst.txt b/docs/_build/html/_sources/index.rst.txt new file mode 100644 index 0000000..0d9b16f --- /dev/null +++ b/docs/_build/html/_sources/index.rst.txt @@ -0,0 +1,36 @@ +.. psyplot documentation master file, created by + sphinx-quickstart on Wed Sep 22 19:43:59 2021. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +.. _psy-simple: + +psy-simple: The psyplot plugin for simple visualizations +======================================================== + +.. raw:: html + +

+ The documentation of psy-simple is now hosted at, https://psyplot.github.io/psy-simple/. + You should be redirected within 5 seconds. +

+ + +.. toctree:: + :maxdepth: 1 + :hidden: + + installing + plot_methods + contribute + api/psy_simple + changelog + + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff --git a/docs/_build/html/_sources/installing.rst.txt b/docs/_build/html/_sources/installing.rst.txt new file mode 100644 index 0000000..ba56852 --- /dev/null +++ b/docs/_build/html/_sources/installing.rst.txt @@ -0,0 +1,13 @@ +.. _install: + +.. highlight:: bash + +Installation +============ + +.. raw:: html + +

+ The documentation of psy-simple is now hosted at, https://psyplot.github.io/psy-simple/installing.html. + You should be redirected within 5 seconds. +

diff --git a/docs/_build/html/_sources/plot_methods.rst.txt b/docs/_build/html/_sources/plot_methods.rst.txt new file mode 100644 index 0000000..20a661e --- /dev/null +++ b/docs/_build/html/_sources/plot_methods.rst.txt @@ -0,0 +1,25 @@ +.. _plot_methods: + +psyplot plot methods +==================== + +.. raw:: html + +

+ The documentation of psy-simple is now hosted at, https://psyplot.github.io/psy-simple/plot_methods.html. + You should be redirected within 5 seconds. +

+ + + +.. toctree:: + :hidden: + + generated/psyplot.project.plot.lineplot + generated/psyplot.project.plot.vector + generated/psyplot.project.plot.violinplot + generated/psyplot.project.plot.plot2d + generated/psyplot.project.plot.combined + generated/psyplot.project.plot.density + generated/psyplot.project.plot.barplot + generated/psyplot.project.plot.fldmean diff --git a/docs/_build/html/_static/alabaster.css b/docs/_build/html/_static/alabaster.css new file mode 100644 index 0000000..0eddaeb --- /dev/null +++ b/docs/_build/html/_static/alabaster.css @@ -0,0 +1,701 @@ +@import url("basic.css"); + +/* -- page layout ----------------------------------------------------------- */ + +body { + font-family: Georgia, serif; + font-size: 17px; + background-color: #fff; + color: #000; + margin: 0; + padding: 0; +} + + +div.document { + width: 940px; + margin: 30px auto 0 auto; +} + +div.documentwrapper { + float: left; + width: 100%; +} + +div.bodywrapper { + margin: 0 0 0 220px; +} + +div.sphinxsidebar { + width: 220px; + font-size: 14px; + line-height: 1.5; +} + +hr { + border: 1px solid #B1B4B6; +} + +div.body { + background-color: #fff; + color: #3E4349; + padding: 0 30px 0 30px; +} + +div.body > .section { + text-align: left; +} + +div.footer { + width: 940px; + margin: 20px auto 30px auto; + font-size: 14px; + color: #888; + text-align: right; +} + +div.footer a { + color: #888; +} + +p.caption { + font-family: inherit; + font-size: inherit; +} + + +div.relations { + display: none; +} + + +div.sphinxsidebar a { + color: #444; + text-decoration: none; + border-bottom: 1px dotted #999; +} + +div.sphinxsidebar a:hover { + border-bottom: 1px solid #999; +} + +div.sphinxsidebarwrapper { + padding: 18px 10px; +} + +div.sphinxsidebarwrapper p.logo { + padding: 0; + margin: -10px 0 0 0px; + text-align: center; +} + +div.sphinxsidebarwrapper h1.logo { + margin-top: -10px; + text-align: center; + margin-bottom: 5px; + text-align: left; +} + +div.sphinxsidebarwrapper h1.logo-name { + margin-top: 0px; +} + +div.sphinxsidebarwrapper p.blurb { + margin-top: 0; + font-style: normal; +} + +div.sphinxsidebar h3, +div.sphinxsidebar h4 { + font-family: Georgia, serif; + color: #444; + font-size: 24px; + font-weight: normal; + margin: 0 0 5px 0; + padding: 0; +} + +div.sphinxsidebar h4 { + font-size: 20px; +} + +div.sphinxsidebar h3 a { + color: #444; +} + +div.sphinxsidebar p.logo a, +div.sphinxsidebar h3 a, +div.sphinxsidebar p.logo a:hover, +div.sphinxsidebar h3 a:hover { + border: none; +} + +div.sphinxsidebar p { + color: #555; + margin: 10px 0; +} + +div.sphinxsidebar ul { + margin: 10px 0; + padding: 0; + color: #000; +} + +div.sphinxsidebar ul li.toctree-l1 > a { + font-size: 120%; +} + +div.sphinxsidebar ul li.toctree-l2 > a { + font-size: 110%; +} + +div.sphinxsidebar input { + border: 1px solid #CCC; + font-family: Georgia, serif; + font-size: 1em; +} + +div.sphinxsidebar hr { + border: none; + height: 1px; + color: #AAA; + background: #AAA; + + text-align: left; + margin-left: 0; + width: 50%; +} + +div.sphinxsidebar .badge { + border-bottom: none; +} + +div.sphinxsidebar .badge:hover { + border-bottom: none; +} + +/* To address an issue with donation coming after search */ +div.sphinxsidebar h3.donation { + margin-top: 10px; +} + +/* -- body styles ----------------------------------------------------------- */ + +a { + color: #004B6B; + text-decoration: underline; +} + +a:hover { + color: #6D4100; + text-decoration: underline; +} + +div.body h1, +div.body h2, +div.body h3, +div.body h4, +div.body h5, +div.body h6 { + font-family: Georgia, serif; + font-weight: normal; + margin: 30px 0px 10px 0px; + padding: 0; +} + +div.body h1 { margin-top: 0; padding-top: 0; font-size: 240%; } +div.body h2 { font-size: 180%; } +div.body h3 { font-size: 150%; } +div.body h4 { font-size: 130%; } +div.body h5 { font-size: 100%; } +div.body h6 { font-size: 100%; } + +a.headerlink { + color: #DDD; + padding: 0 4px; + text-decoration: none; +} + +a.headerlink:hover { + color: #444; + background: #EAEAEA; +} + +div.body p, div.body dd, div.body li { + line-height: 1.4em; +} + +div.admonition { + margin: 20px 0px; + padding: 10px 30px; + background-color: #EEE; + border: 1px solid #CCC; +} + +div.admonition tt.xref, div.admonition code.xref, div.admonition a tt { + background-color: #FBFBFB; + border-bottom: 1px solid #fafafa; +} + +div.admonition p.admonition-title { + font-family: Georgia, serif; + font-weight: normal; + font-size: 24px; + margin: 0 0 10px 0; + padding: 0; + line-height: 1; +} + +div.admonition p.last { + margin-bottom: 0; +} + +div.highlight { + background-color: #fff; +} + +dt:target, .highlight { + background: #FAF3E8; +} + +div.warning { + background-color: #FCC; + border: 1px solid #FAA; +} + +div.danger { + background-color: #FCC; + border: 1px solid #FAA; + -moz-box-shadow: 2px 2px 4px #D52C2C; + -webkit-box-shadow: 2px 2px 4px #D52C2C; + box-shadow: 2px 2px 4px #D52C2C; +} + +div.error { + background-color: #FCC; + border: 1px solid #FAA; + -moz-box-shadow: 2px 2px 4px #D52C2C; + -webkit-box-shadow: 2px 2px 4px #D52C2C; + box-shadow: 2px 2px 4px #D52C2C; +} + +div.caution { + background-color: #FCC; + border: 1px solid #FAA; +} + +div.attention { + background-color: #FCC; + border: 1px solid #FAA; +} + +div.important { + background-color: #EEE; + border: 1px solid #CCC; +} + +div.note { + background-color: #EEE; + border: 1px solid #CCC; +} + +div.tip { + background-color: #EEE; + border: 1px solid #CCC; +} + +div.hint { + background-color: #EEE; + border: 1px solid #CCC; +} + +div.seealso { + background-color: #EEE; + border: 1px solid #CCC; +} + +div.topic { + background-color: #EEE; +} + +p.admonition-title { + display: inline; +} + +p.admonition-title:after { + content: ":"; +} + +pre, tt, code { + font-family: 'Consolas', 'Menlo', 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', monospace; + font-size: 0.9em; +} + +.hll { + background-color: #FFC; + margin: 0 -12px; + padding: 0 12px; + display: block; +} + +img.screenshot { +} + +tt.descname, tt.descclassname, code.descname, code.descclassname { + font-size: 0.95em; +} + +tt.descname, code.descname { + padding-right: 0.08em; +} + +img.screenshot { + -moz-box-shadow: 2px 2px 4px #EEE; + -webkit-box-shadow: 2px 2px 4px #EEE; + box-shadow: 2px 2px 4px #EEE; +} + +table.docutils { + border: 1px solid #888; + -moz-box-shadow: 2px 2px 4px #EEE; + -webkit-box-shadow: 2px 2px 4px #EEE; + box-shadow: 2px 2px 4px #EEE; +} + +table.docutils td, table.docutils th { + border: 1px solid #888; + padding: 0.25em 0.7em; +} + +table.field-list, table.footnote { + border: none; + -moz-box-shadow: none; + -webkit-box-shadow: none; + box-shadow: none; +} + +table.footnote { + margin: 15px 0; + width: 100%; + border: 1px solid #EEE; + background: #FDFDFD; + font-size: 0.9em; +} + +table.footnote + table.footnote { + margin-top: -15px; + border-top: none; +} + +table.field-list th { + padding: 0 0.8em 0 0; +} + +table.field-list td { + padding: 0; +} + +table.field-list p { + margin-bottom: 0.8em; +} + +/* Cloned from + * https://github.com/sphinx-doc/sphinx/commit/ef60dbfce09286b20b7385333d63a60321784e68 + */ +.field-name { + -moz-hyphens: manual; + -ms-hyphens: manual; + -webkit-hyphens: manual; + hyphens: manual; +} + +table.footnote td.label { + width: .1px; + padding: 0.3em 0 0.3em 0.5em; +} + +table.footnote td { + padding: 0.3em 0.5em; +} + +dl { + margin: 0; + padding: 0; +} + +dl dd { + margin-left: 30px; +} + +blockquote { + margin: 0 0 0 30px; + padding: 0; +} + +ul, ol { + /* Matches the 30px from the narrow-screen "li > ul" selector below */ + margin: 10px 0 10px 30px; + padding: 0; +} + +pre { + background: #EEE; + padding: 7px 30px; + margin: 15px 0px; + line-height: 1.3em; +} + +div.viewcode-block:target { + background: #ffd; +} + +dl pre, blockquote pre, li pre { + margin-left: 0; + padding-left: 30px; +} + +tt, code { + background-color: #ecf0f3; + color: #222; + /* padding: 1px 2px; */ +} + +tt.xref, code.xref, a tt { + background-color: #FBFBFB; + border-bottom: 1px solid #fff; +} + +a.reference { + text-decoration: none; + border-bottom: 1px dotted #004B6B; +} + +/* Don't put an underline on images */ +a.image-reference, a.image-reference:hover { + border-bottom: none; +} + +a.reference:hover { + border-bottom: 1px solid #6D4100; +} + +a.footnote-reference { + text-decoration: none; + font-size: 0.7em; + vertical-align: top; + border-bottom: 1px dotted #004B6B; +} + +a.footnote-reference:hover { + border-bottom: 1px solid #6D4100; +} + +a:hover tt, a:hover code { + background: #EEE; +} + + +@media screen and (max-width: 870px) { + + div.sphinxsidebar { + display: none; + } + + div.document { + width: 100%; + + } + + div.documentwrapper { + margin-left: 0; + margin-top: 0; + margin-right: 0; + margin-bottom: 0; + } + + div.bodywrapper { + margin-top: 0; + margin-right: 0; + margin-bottom: 0; + margin-left: 0; + } + + ul { + margin-left: 0; + } + + li > ul { + /* Matches the 30px from the "ul, ol" selector above */ + margin-left: 30px; + } + + .document { + width: auto; + } + + .footer { + width: auto; + } + + .bodywrapper { + margin: 0; + } + + .footer { + width: auto; + } + + .github { + display: none; + } + + + +} + + + +@media screen and (max-width: 875px) { + + body { + margin: 0; + padding: 20px 30px; + } + + div.documentwrapper { + float: none; + background: #fff; + } + + div.sphinxsidebar { + display: block; + float: none; + width: 102.5%; + margin: 50px -30px -20px -30px; + padding: 10px 20px; + background: #333; + color: #FFF; + } + + div.sphinxsidebar h3, div.sphinxsidebar h4, div.sphinxsidebar p, + div.sphinxsidebar h3 a { + color: #fff; + } + + div.sphinxsidebar a { + color: #AAA; + } + + div.sphinxsidebar p.logo { + display: none; + } + + div.document { + width: 100%; + margin: 0; + } + + div.footer { + display: none; + } + + div.bodywrapper { + margin: 0; + } + + div.body { + min-height: 0; + padding: 0; + } + + .rtd_doc_footer { + display: none; + } + + .document { + width: auto; + } + + .footer { + width: auto; + } + + .footer { + width: auto; + } + + .github { + display: none; + } +} + + +/* misc. */ + +.revsys-inline { + display: none!important; +} + +/* Make nested-list/multi-paragraph items look better in Releases changelog + * pages. Without this, docutils' magical list fuckery causes inconsistent + * formatting between different release sub-lists. + */ +div#changelog > div.section > ul > li > p:only-child { + margin-bottom: 0; +} + +/* Hide fugly table cell borders in ..bibliography:: directive output */ +table.docutils.citation, table.docutils.citation td, table.docutils.citation th { + border: none; + /* Below needed in some edge cases; if not applied, bottom shadows appear */ + -moz-box-shadow: none; + -webkit-box-shadow: none; + box-shadow: none; +} + + +/* relbar */ + +.related { + line-height: 30px; + width: 100%; + font-size: 0.9rem; +} + +.related.top { + border-bottom: 1px solid #EEE; + margin-bottom: 20px; +} + +.related.bottom { + border-top: 1px solid #EEE; +} + +.related ul { + padding: 0; + margin: 0; + list-style: none; +} + +.related li { + display: inline; +} + +nav#rellinks { + float: right; +} + +nav#rellinks li+li:before { + content: "|"; +} + +nav#breadcrumbs li+li:before { + content: "\00BB"; +} + +/* Hide certain items when printing */ +@media print { + div.related { + display: none; + } +} \ No newline at end of file diff --git a/docs/_build/html/_static/basic.css b/docs/_build/html/_static/basic.css new file mode 100644 index 0000000..912859b --- /dev/null +++ b/docs/_build/html/_static/basic.css @@ -0,0 +1,904 @@ +/* + * basic.css + * ~~~~~~~~~ + * + * Sphinx stylesheet -- basic theme. + * + * :copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ + +/* -- main layout ----------------------------------------------------------- */ + +div.clearer { + clear: both; +} + +div.section::after { + display: block; + content: ''; + clear: left; +} + +/* -- relbar ---------------------------------------------------------------- */ + +div.related { + width: 100%; + font-size: 90%; +} + +div.related h3 { + display: none; +} + +div.related ul { + margin: 0; + padding: 0 0 0 10px; + list-style: none; +} + +div.related li { + display: inline; +} + +div.related li.right { + float: right; + margin-right: 5px; +} + +/* -- sidebar --------------------------------------------------------------- */ + +div.sphinxsidebarwrapper { + padding: 10px 5px 0 10px; +} + +div.sphinxsidebar { + float: left; + width: 230px; + margin-left: -100%; + font-size: 90%; + word-wrap: break-word; + overflow-wrap : break-word; +} + +div.sphinxsidebar ul { + list-style: none; +} + +div.sphinxsidebar ul ul, +div.sphinxsidebar ul.want-points { + margin-left: 20px; + list-style: square; +} + +div.sphinxsidebar ul ul { + margin-top: 0; + margin-bottom: 0; +} + +div.sphinxsidebar form { + margin-top: 10px; +} + +div.sphinxsidebar input { + border: 1px solid #98dbcc; + font-family: sans-serif; + font-size: 1em; +} + +div.sphinxsidebar #searchbox form.search { + overflow: hidden; +} + +div.sphinxsidebar #searchbox input[type="text"] { + float: left; + width: 80%; + padding: 0.25em; + box-sizing: border-box; +} + +div.sphinxsidebar #searchbox input[type="submit"] { + float: left; + width: 20%; + border-left: none; + padding: 0.25em; + box-sizing: border-box; +} + + +img { + border: 0; + max-width: 100%; +} + +/* -- search page ----------------------------------------------------------- */ + +ul.search { + margin: 10px 0 0 20px; + padding: 0; +} + +ul.search li { + padding: 5px 0 5px 20px; + background-image: url(file.png); + background-repeat: no-repeat; + background-position: 0 7px; +} + +ul.search li a { + font-weight: bold; +} + +ul.search li 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: 450px; + max-width: 800px; +} + +div.body p, div.body dd, div.body li, div.body blockquote { + -moz-hyphens: auto; + -ms-hyphens: auto; + -webkit-hyphens: auto; + hyphens: auto; +} + +a.headerlink { + visibility: hidden; +} + +a.brackets:before, +span.brackets > a:before{ + content: "["; +} + +a.brackets:after, +span.brackets > a:after { + content: "]"; +} + +h1:hover > a.headerlink, +h2:hover > a.headerlink, +h3:hover > a.headerlink, +h4:hover > a.headerlink, +h5:hover > a.headerlink, +h6:hover > a.headerlink, +dt:hover > a.headerlink, +caption:hover > a.headerlink, +p.caption:hover > a.headerlink, +div.code-block-caption:hover > a.headerlink { + visibility: visible; +} + +div.body p.caption { + text-align: inherit; +} + +div.body td { + text-align: left; +} + +.first { + margin-top: 0 !important; +} + +p.rubric { + margin-top: 30px; + font-weight: bold; +} + +img.align-left, figure.align-left, .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; +} + +div.admonition, div.topic, blockquote { + clear: left; +} + +/* -- topics ---------------------------------------------------------------- */ + +div.topic { + border: 1px solid #ccc; + padding: 7px; + margin: 10px 0 10px 0; +} + +p.topic-title { + font-size: 1.1em; + font-weight: bold; + margin-top: 10px; +} + +/* -- admonitions ----------------------------------------------------------- */ + +div.admonition { + margin-top: 10px; + margin-bottom: 10px; + padding: 7px; +} + +div.admonition dt { + font-weight: bold; +} + +p.admonition-title { + margin: 0px 10px 5px 0px; + font-weight: bold; +} + +div.body p.centered { + text-align: center; + margin-top: 25px; +} + +/* -- content of sidebars/topics/admonitions -------------------------------- */ + +div.sidebar > :last-child, +aside.sidebar > :last-child, +div.topic > :last-child, +div.admonition > :last-child { + margin-bottom: 0; +} + +div.sidebar::after, +aside.sidebar::after, +div.topic::after, +div.admonition::after, +blockquote::after { + display: block; + content: ''; + clear: both; +} + +/* -- tables ---------------------------------------------------------------- */ + +table.docutils { + margin-top: 10px; + margin-bottom: 10px; + border: 0; + border-collapse: collapse; +} + +table.align-center { + margin-left: auto; + margin-right: auto; +} + +table.align-default { + margin-left: auto; + margin-right: auto; +} + +table caption span.caption-number { + font-style: italic; +} + +table caption span.caption-text { +} + +table.docutils td, table.docutils th { + padding: 1px 8px 1px 5px; + border-top: 0; + border-left: 0; + border-right: 0; + border-bottom: 1px solid #aaa; +} + +table.footnote td, table.footnote th { + border: 0 !important; +} + +th { + text-align: left; + padding-right: 5px; +} + +table.citation { + border-left: solid 1px gray; + margin-left: 1px; +} + +table.citation td { + border-bottom: none; +} + +th > :first-child, +td > :first-child { + margin-top: 0px; +} + +th > :last-child, +td > :last-child { + margin-bottom: 0px; +} + +/* -- figures --------------------------------------------------------------- */ + +div.figure, 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; +} + +dl.footnote > dt, +dl.citation > dt { + float: left; + margin-right: 0.5em; +} + +dl.footnote > dd, +dl.citation > dd { + margin-bottom: 0em; +} + +dl.footnote > dd:after, +dl.citation > dd:after { + content: ""; + clear: both; +} + +dl.field-list { + display: grid; + grid-template-columns: fit-content(30%) auto; +} + +dl.field-list > dt { + font-weight: bold; + word-break: break-word; + padding-left: 0.5em; + padding-right: 5px; +} + +dl.field-list > dt:after { + content: ":"; +} + +dl.field-list > dd { + padding-left: 0.5em; + margin-top: 0em; + margin-left: 0em; + margin-bottom: 0em; +} + +dl { + margin-bottom: 15px; +} + +dd > :first-child { + margin-top: 0px; +} + +dd ul, dd table { + margin-bottom: 10px; +} + +dd { + margin-top: 3px; + margin-bottom: 10px; + margin-left: 30px; +} + +dl > dd:last-child, +dl > dd:last-child > :last-child { + margin-bottom: 0; +} + +dt:target, span.highlighted { + background-color: #fbe54e; +} + +rect.highlighted { + fill: #fbe54e; +} + +dl.glossary dt { + font-weight: bold; + font-size: 1.1em; +} + +.versionmodified { + font-style: italic; +} + +.system-message { + background-color: #fda; + padding: 5px; + border: 3px solid red; +} + +.footnote:target { + background-color: #ffa; +} + +.line-block { + display: block; + margin-top: 1em; + margin-bottom: 1em; +} + +.line-block .line-block { + margin-top: 0; + margin-bottom: 0; + margin-left: 1.5em; +} + +.guilabel, .menuselection { + font-family: sans-serif; +} + +.accelerator { + text-decoration: underline; +} + +.classifier { + font-style: oblique; +} + +.classifier:before { + font-style: normal; + margin: 0.5em; + content: ":"; +} + +abbr, acronym { + border-bottom: dotted 1px; + cursor: help; +} + +/* -- code displays --------------------------------------------------------- */ + +pre { + overflow: auto; + overflow-y: hidden; /* fixes display issues on Chrome browsers */ +} + +pre, div[class*="highlight-"] { + clear: both; +} + +span.pre { + -moz-hyphens: none; + -ms-hyphens: none; + -webkit-hyphens: none; + hyphens: none; +} + +div[class*="highlight-"] { + margin: 1em 0; +} + +td.linenos pre { + border: 0; + background-color: transparent; + color: #aaa; +} + +table.highlighttable { + display: block; +} + +table.highlighttable tbody { + display: block; +} + +table.highlighttable tr { + display: flex; +} + +table.highlighttable td { + margin: 0; + padding: 0; +} + +table.highlighttable td.linenos { + padding-right: 0.5em; +} + +table.highlighttable td.code { + flex: 1; + overflow: hidden; +} + +.highlight .hll { + display: block; +} + +div.highlight pre, +table.highlighttable pre { + margin: 0; +} + +div.code-block-caption + div { + margin-top: 0; +} + +div.code-block-caption { + margin-top: 1em; + padding: 2px 5px; + font-size: small; +} + +div.code-block-caption code { + background-color: transparent; +} + +table.highlighttable td.linenos, +span.linenos, +div.highlight span.gp { /* gp: Generic.Prompt */ + user-select: none; + -webkit-user-select: text; /* Safari fallback only */ + -webkit-user-select: none; /* Chrome/Safari */ + -moz-user-select: none; /* Firefox */ + -ms-user-select: none; /* IE10+ */ +} + +div.code-block-caption span.caption-number { + padding: 0.1em 0.3em; + font-style: italic; +} + +div.code-block-caption span.caption-text { +} + +div.literal-block-wrapper { + margin: 1em 0; +} + +code.xref, a code { + background-color: transparent; + font-weight: bold; +} + +h1 code, h2 code, h3 code, h4 code, h5 code, h6 code { + background-color: transparent; +} + +.viewcode-link { + float: right; +} + +.viewcode-back { + float: right; + font-family: sans-serif; +} + +div.viewcode-block:target { + margin: -1px -10px; + padding: 0 10px; +} + +/* -- math display ---------------------------------------------------------- */ + +img.math { + vertical-align: middle; +} + +div.body div.math p { + text-align: center; +} + +span.eqno { + float: right; +} + +span.eqno a.headerlink { + position: absolute; + z-index: 1; +} + +div.math:hover a.headerlink { + visibility: visible; +} + +/* -- printout stylesheet --------------------------------------------------- */ + +@media print { + div.document, + div.documentwrapper, + div.bodywrapper { + margin: 0 !important; + width: 100%; + } + + div.sphinxsidebar, + div.related, + div.footer, + #top-link { + display: none; + } +} \ No newline at end of file diff --git a/docs/_build/html/_static/custom.css b/docs/_build/html/_static/custom.css new file mode 100644 index 0000000..2a924f1 --- /dev/null +++ b/docs/_build/html/_static/custom.css @@ -0,0 +1 @@ +/* This file intentionally left blank. */ diff --git a/docs/_build/html/_static/doctools.js b/docs/_build/html/_static/doctools.js new file mode 100644 index 0000000..8cbf1b1 --- /dev/null +++ b/docs/_build/html/_static/doctools.js @@ -0,0 +1,323 @@ +/* + * doctools.js + * ~~~~~~~~~~~ + * + * Sphinx JavaScript utilities for all documentation. + * + * :copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ + +/** + * select a different prefix for underscore + */ +$u = _.noConflict(); + +/** + * make the code below compatible with browsers without + * an installed firebug like debugger +if (!window.console || !console.firebug) { + var names = ["log", "debug", "info", "warn", "error", "assert", "dir", + "dirxml", "group", "groupEnd", "time", "timeEnd", "count", "trace", + "profile", "profileEnd"]; + window.console = {}; + for (var i = 0; i < names.length; ++i) + window.console[names[i]] = function() {}; +} + */ + +/** + * small helper function to urldecode strings + * + * See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/decodeURIComponent#Decoding_query_parameters_from_a_URL + */ +jQuery.urldecode = function(x) { + if (!x) { + return x + } + return decodeURIComponent(x.replace(/\+/g, ' ')); +}; + +/** + * small helper function to urlencode strings + */ +jQuery.urlencode = encodeURIComponent; + +/** + * This function returns the parsed url parameters of the + * current request. Multiple values per key are supported, + * it will always return arrays of strings for the value parts. + */ +jQuery.getQueryParameters = function(s) { + if (typeof s === 'undefined') + s = document.location.search; + var parts = s.substr(s.indexOf('?') + 1).split('&'); + var result = {}; + for (var i = 0; i < parts.length; i++) { + var tmp = parts[i].split('=', 2); + var key = jQuery.urldecode(tmp[0]); + var value = jQuery.urldecode(tmp[1]); + if (key in result) + result[key].push(value); + else + result[key] = [value]; + } + return result; +}; + +/** + * highlight a given string on a jquery object by wrapping it in + * span elements with the given class name. + */ +jQuery.fn.highlightText = function(text, className) { + function highlight(node, addItems) { + if (node.nodeType === 3) { + var val = node.nodeValue; + var pos = val.toLowerCase().indexOf(text); + if (pos >= 0 && + !jQuery(node.parentNode).hasClass(className) && + !jQuery(node.parentNode).hasClass("nohighlight")) { + var span; + var isInSVG = jQuery(node).closest("body, svg, foreignObject").is("svg"); + if (isInSVG) { + span = document.createElementNS("http://www.w3.org/2000/svg", "tspan"); + } else { + span = document.createElement("span"); + span.className = className; + } + span.appendChild(document.createTextNode(val.substr(pos, text.length))); + node.parentNode.insertBefore(span, node.parentNode.insertBefore( + document.createTextNode(val.substr(pos + text.length)), + node.nextSibling)); + node.nodeValue = val.substr(0, pos); + if (isInSVG) { + var rect = document.createElementNS("http://www.w3.org/2000/svg", "rect"); + var bbox = node.parentElement.getBBox(); + rect.x.baseVal.value = bbox.x; + rect.y.baseVal.value = bbox.y; + rect.width.baseVal.value = bbox.width; + rect.height.baseVal.value = bbox.height; + rect.setAttribute('class', className); + addItems.push({ + "parent": node.parentNode, + "target": rect}); + } + } + } + else if (!jQuery(node).is("button, select, textarea")) { + jQuery.each(node.childNodes, function() { + highlight(this, addItems); + }); + } + } + var addItems = []; + var result = this.each(function() { + highlight(this, addItems); + }); + for (var i = 0; i < addItems.length; ++i) { + jQuery(addItems[i].parent).before(addItems[i].target); + } + return result; +}; + +/* + * backward compatibility for jQuery.browser + * This will be supported until firefox bug is fixed. + */ +if (!jQuery.browser) { + jQuery.uaMatch = function(ua) { + ua = ua.toLowerCase(); + + var match = /(chrome)[ \/]([\w.]+)/.exec(ua) || + /(webkit)[ \/]([\w.]+)/.exec(ua) || + /(opera)(?:.*version|)[ \/]([\w.]+)/.exec(ua) || + /(msie) ([\w.]+)/.exec(ua) || + ua.indexOf("compatible") < 0 && /(mozilla)(?:.*? rv:([\w.]+)|)/.exec(ua) || + []; + + return { + browser: match[ 1 ] || "", + version: match[ 2 ] || "0" + }; + }; + jQuery.browser = {}; + jQuery.browser[jQuery.uaMatch(navigator.userAgent).browser] = true; +} + +/** + * Small JavaScript module for the documentation. + */ +var Documentation = { + + init : function() { + this.fixFirefoxAnchorBug(); + this.highlightSearchWords(); + this.initIndexTable(); + if (DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) { + this.initOnKeyListeners(); + } + }, + + /** + * i18n support + */ + TRANSLATIONS : {}, + PLURAL_EXPR : function(n) { return n === 1 ? 0 : 1; }, + LOCALE : 'unknown', + + // gettext and ngettext don't access this so that the functions + // can safely bound to a different name (_ = Documentation.gettext) + gettext : function(string) { + var translated = Documentation.TRANSLATIONS[string]; + if (typeof translated === 'undefined') + return string; + return (typeof translated === 'string') ? translated : translated[0]; + }, + + ngettext : function(singular, plural, n) { + var translated = Documentation.TRANSLATIONS[singular]; + if (typeof translated === 'undefined') + return (n == 1) ? singular : plural; + return translated[Documentation.PLURALEXPR(n)]; + }, + + addTranslations : function(catalog) { + for (var key in catalog.messages) + this.TRANSLATIONS[key] = catalog.messages[key]; + this.PLURAL_EXPR = new Function('n', 'return +(' + catalog.plural_expr + ')'); + this.LOCALE = catalog.locale; + }, + + /** + * add context elements like header anchor links + */ + addContextElements : function() { + $('div[id] > :header:first').each(function() { + $('\u00B6'). + attr('href', '#' + this.id). + attr('title', _('Permalink to this headline')). + appendTo(this); + }); + $('dt[id]').each(function() { + $('\u00B6'). + attr('href', '#' + this.id). + attr('title', _('Permalink to this definition')). + appendTo(this); + }); + }, + + /** + * workaround a firefox stupidity + * see: https://bugzilla.mozilla.org/show_bug.cgi?id=645075 + */ + fixFirefoxAnchorBug : function() { + if (document.location.hash && $.browser.mozilla) + window.setTimeout(function() { + document.location.href += ''; + }, 10); + }, + + /** + * highlight the search words provided in the url in the text + */ + highlightSearchWords : function() { + var params = $.getQueryParameters(); + var terms = (params.highlight) ? params.highlight[0].split(/\s+/) : []; + if (terms.length) { + var body = $('div.body'); + if (!body.length) { + body = $('body'); + } + window.setTimeout(function() { + $.each(terms, function() { + body.highlightText(this.toLowerCase(), 'highlighted'); + }); + }, 10); + $('') + .appendTo($('#searchbox')); + } + }, + + /** + * init the domain index toggle buttons + */ + initIndexTable : function() { + var togglers = $('img.toggler').click(function() { + var src = $(this).attr('src'); + var idnum = $(this).attr('id').substr(7); + $('tr.cg-' + idnum).toggle(); + if (src.substr(-9) === 'minus.png') + $(this).attr('src', src.substr(0, src.length-9) + 'plus.png'); + else + $(this).attr('src', src.substr(0, src.length-8) + 'minus.png'); + }).css('display', ''); + if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) { + togglers.click(); + } + }, + + /** + * helper function to hide the search marks again + */ + hideSearchWords : function() { + $('#searchbox .highlight-link').fadeOut(300); + $('span.highlighted').removeClass('highlighted'); + }, + + /** + * make the url absolute + */ + makeURL : function(relativeURL) { + return DOCUMENTATION_OPTIONS.URL_ROOT + '/' + relativeURL; + }, + + /** + * get the current relative url + */ + getCurrentURL : function() { + var path = document.location.pathname; + var parts = path.split(/\//); + $.each(DOCUMENTATION_OPTIONS.URL_ROOT.split(/\//), function() { + if (this === '..') + parts.pop(); + }); + var url = parts.join('/'); + return path.substring(url.lastIndexOf('/') + 1, path.length - 1); + }, + + initOnKeyListeners: function() { + $(document).keydown(function(event) { + var activeElementType = document.activeElement.tagName; + // don't navigate when in search box, textarea, dropdown or button + if (activeElementType !== 'TEXTAREA' && activeElementType !== 'INPUT' && activeElementType !== 'SELECT' + && activeElementType !== 'BUTTON' && !event.altKey && !event.ctrlKey && !event.metaKey + && !event.shiftKey) { + switch (event.keyCode) { + case 37: // left + var prevHref = $('link[rel="prev"]').prop('href'); + if (prevHref) { + window.location.href = prevHref; + return false; + } + break; + case 39: // right + var nextHref = $('link[rel="next"]').prop('href'); + if (nextHref) { + window.location.href = nextHref; + return false; + } + break; + } + } + }); + } +}; + +// quick alias for translations +_ = Documentation.gettext; + +$(document).ready(function() { + Documentation.init(); +}); diff --git a/docs/_build/html/_static/documentation_options.js b/docs/_build/html/_static/documentation_options.js new file mode 100644 index 0000000..018c277 --- /dev/null +++ b/docs/_build/html/_static/documentation_options.js @@ -0,0 +1,12 @@ +var DOCUMENTATION_OPTIONS = { + URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'), + VERSION: '1.3.1', + LANGUAGE: 'None', + COLLAPSE_INDEX: false, + BUILDER: 'html', + FILE_SUFFIX: '.html', + LINK_SUFFIX: '.html', + HAS_SOURCE: true, + SOURCELINK_SUFFIX: '.txt', + NAVIGATION_WITH_KEYS: false +}; \ No newline at end of file diff --git a/docs/_build/html/_static/file.png b/docs/_build/html/_static/file.png new file mode 100644 index 0000000..a858a41 Binary files /dev/null and b/docs/_build/html/_static/file.png differ diff --git a/docs/_build/html/_static/jquery-3.5.1.js b/docs/_build/html/_static/jquery-3.5.1.js new file mode 100644 index 0000000..5093733 --- /dev/null +++ b/docs/_build/html/_static/jquery-3.5.1.js @@ -0,0 +1,10872 @@ +/*! + * jQuery JavaScript Library v3.5.1 + * https://jquery.com/ + * + * Includes Sizzle.js + * https://sizzlejs.com/ + * + * Copyright JS Foundation and other contributors + * Released under the MIT license + * https://jquery.org/license + * + * Date: 2020-05-04T22:49Z + */ +( function( global, factory ) { + + "use strict"; + + if ( typeof module === "object" && typeof module.exports === "object" ) { + + // For CommonJS and CommonJS-like environments where a proper `window` + // is present, execute the factory and get jQuery. + // For environments that do not have a `window` with a `document` + // (such as Node.js), expose a factory as module.exports. + // This accentuates the need for the creation of a real `window`. + // e.g. var jQuery = require("jquery")(window); + // See ticket #14549 for more info. + module.exports = global.document ? + factory( global, true ) : + function( w ) { + if ( !w.document ) { + throw new Error( "jQuery requires a window with a document" ); + } + return factory( w ); + }; + } else { + factory( global ); + } + +// Pass this if window is not defined yet +} )( typeof window !== "undefined" ? window : this, function( window, noGlobal ) { + +// Edge <= 12 - 13+, Firefox <=18 - 45+, IE 10 - 11, Safari 5.1 - 9+, iOS 6 - 9.1 +// throw exceptions when non-strict code (e.g., ASP.NET 4.5) accesses strict mode +// arguments.callee.caller (trac-13335). But as of jQuery 3.0 (2016), strict mode should be common +// enough that all such attempts are guarded in a try block. +"use strict"; + +var arr = []; + +var getProto = Object.getPrototypeOf; + +var slice = arr.slice; + +var flat = arr.flat ? function( array ) { + return arr.flat.call( array ); +} : function( array ) { + return arr.concat.apply( [], array ); +}; + + +var push = arr.push; + +var indexOf = arr.indexOf; + +var class2type = {}; + +var toString = class2type.toString; + +var hasOwn = class2type.hasOwnProperty; + +var fnToString = hasOwn.toString; + +var ObjectFunctionString = fnToString.call( Object ); + +var support = {}; + +var isFunction = function isFunction( obj ) { + + // Support: Chrome <=57, Firefox <=52 + // In some browsers, typeof returns "function" for HTML elements + // (i.e., `typeof document.createElement( "object" ) === "function"`). + // We don't want to classify *any* DOM node as a function. + return typeof obj === "function" && typeof obj.nodeType !== "number"; + }; + + +var isWindow = function isWindow( obj ) { + return obj != null && obj === obj.window; + }; + + +var document = window.document; + + + + var preservedScriptAttributes = { + type: true, + src: true, + nonce: true, + noModule: true + }; + + function DOMEval( code, node, doc ) { + doc = doc || document; + + var i, val, + script = doc.createElement( "script" ); + + script.text = code; + if ( node ) { + for ( i in preservedScriptAttributes ) { + + // Support: Firefox 64+, Edge 18+ + // Some browsers don't support the "nonce" property on scripts. + // On the other hand, just using `getAttribute` is not enough as + // the `nonce` attribute is reset to an empty string whenever it + // becomes browsing-context connected. + // See https://github.com/whatwg/html/issues/2369 + // See https://html.spec.whatwg.org/#nonce-attributes + // The `node.getAttribute` check was added for the sake of + // `jQuery.globalEval` so that it can fake a nonce-containing node + // via an object. + val = node[ i ] || node.getAttribute && node.getAttribute( i ); + if ( val ) { + script.setAttribute( i, val ); + } + } + } + doc.head.appendChild( script ).parentNode.removeChild( script ); + } + + +function toType( obj ) { + if ( obj == null ) { + return obj + ""; + } + + // Support: Android <=2.3 only (functionish RegExp) + return typeof obj === "object" || typeof obj === "function" ? + class2type[ toString.call( obj ) ] || "object" : + typeof obj; +} +/* global Symbol */ +// Defining this global in .eslintrc.json would create a danger of using the global +// unguarded in another place, it seems safer to define global only for this module + + + +var + version = "3.5.1", + + // Define a local copy of jQuery + jQuery = function( selector, context ) { + + // The jQuery object is actually just the init constructor 'enhanced' + // Need init if jQuery is called (just allow error to be thrown if not included) + return new jQuery.fn.init( selector, context ); + }; + +jQuery.fn = jQuery.prototype = { + + // The current version of jQuery being used + jquery: version, + + constructor: jQuery, + + // The default length of a jQuery object is 0 + length: 0, + + toArray: function() { + return slice.call( this ); + }, + + // Get the Nth element in the matched element set OR + // Get the whole matched element set as a clean array + get: function( num ) { + + // Return all the elements in a clean array + if ( num == null ) { + return slice.call( this ); + } + + // Return just the one element from the set + return num < 0 ? this[ num + this.length ] : this[ num ]; + }, + + // Take an array of elements and push it onto the stack + // (returning the new matched element set) + pushStack: function( elems ) { + + // Build a new jQuery matched element set + var ret = jQuery.merge( this.constructor(), elems ); + + // Add the old object onto the stack (as a reference) + ret.prevObject = this; + + // Return the newly-formed element set + return ret; + }, + + // Execute a callback for every element in the matched set. + each: function( callback ) { + return jQuery.each( this, callback ); + }, + + map: function( callback ) { + return this.pushStack( jQuery.map( this, function( elem, i ) { + return callback.call( elem, i, elem ); + } ) ); + }, + + slice: function() { + return this.pushStack( slice.apply( this, arguments ) ); + }, + + first: function() { + return this.eq( 0 ); + }, + + last: function() { + return this.eq( -1 ); + }, + + even: function() { + return this.pushStack( jQuery.grep( this, function( _elem, i ) { + return ( i + 1 ) % 2; + } ) ); + }, + + odd: function() { + return this.pushStack( jQuery.grep( this, function( _elem, i ) { + return i % 2; + } ) ); + }, + + eq: function( i ) { + var len = this.length, + j = +i + ( i < 0 ? len : 0 ); + return this.pushStack( j >= 0 && j < len ? [ this[ j ] ] : [] ); + }, + + end: function() { + return this.prevObject || this.constructor(); + }, + + // For internal use only. + // Behaves like an Array's method, not like a jQuery method. + push: push, + sort: arr.sort, + splice: arr.splice +}; + +jQuery.extend = jQuery.fn.extend = function() { + var options, name, src, copy, copyIsArray, clone, + target = arguments[ 0 ] || {}, + i = 1, + length = arguments.length, + deep = false; + + // Handle a deep copy situation + if ( typeof target === "boolean" ) { + deep = target; + + // Skip the boolean and the target + target = arguments[ i ] || {}; + i++; + } + + // Handle case when target is a string or something (possible in deep copy) + if ( typeof target !== "object" && !isFunction( target ) ) { + target = {}; + } + + // Extend jQuery itself if only one argument is passed + if ( i === length ) { + target = this; + i--; + } + + for ( ; i < length; i++ ) { + + // Only deal with non-null/undefined values + if ( ( options = arguments[ i ] ) != null ) { + + // Extend the base object + for ( name in options ) { + copy = options[ name ]; + + // Prevent Object.prototype pollution + // Prevent never-ending loop + if ( name === "__proto__" || target === copy ) { + continue; + } + + // Recurse if we're merging plain objects or arrays + if ( deep && copy && ( jQuery.isPlainObject( copy ) || + ( copyIsArray = Array.isArray( copy ) ) ) ) { + src = target[ name ]; + + // Ensure proper type for the source value + if ( copyIsArray && !Array.isArray( src ) ) { + clone = []; + } else if ( !copyIsArray && !jQuery.isPlainObject( src ) ) { + clone = {}; + } else { + clone = src; + } + copyIsArray = false; + + // Never move original objects, clone them + target[ name ] = jQuery.extend( deep, clone, copy ); + + // Don't bring in undefined values + } else if ( copy !== undefined ) { + target[ name ] = copy; + } + } + } + } + + // Return the modified object + return target; +}; + +jQuery.extend( { + + // Unique for each copy of jQuery on the page + expando: "jQuery" + ( version + Math.random() ).replace( /\D/g, "" ), + + // Assume jQuery is ready without the ready module + isReady: true, + + error: function( msg ) { + throw new Error( msg ); + }, + + noop: function() {}, + + isPlainObject: function( obj ) { + var proto, Ctor; + + // Detect obvious negatives + // Use toString instead of jQuery.type to catch host objects + if ( !obj || toString.call( obj ) !== "[object Object]" ) { + return false; + } + + proto = getProto( obj ); + + // Objects with no prototype (e.g., `Object.create( null )`) are plain + if ( !proto ) { + return true; + } + + // Objects with prototype are plain iff they were constructed by a global Object function + Ctor = hasOwn.call( proto, "constructor" ) && proto.constructor; + return typeof Ctor === "function" && fnToString.call( Ctor ) === ObjectFunctionString; + }, + + isEmptyObject: function( obj ) { + var name; + + for ( name in obj ) { + return false; + } + return true; + }, + + // Evaluates a script in a provided context; falls back to the global one + // if not specified. + globalEval: function( code, options, doc ) { + DOMEval( code, { nonce: options && options.nonce }, doc ); + }, + + each: function( obj, callback ) { + var length, i = 0; + + if ( isArrayLike( obj ) ) { + length = obj.length; + for ( ; i < length; i++ ) { + if ( callback.call( obj[ i ], i, obj[ i ] ) === false ) { + break; + } + } + } else { + for ( i in obj ) { + if ( callback.call( obj[ i ], i, obj[ i ] ) === false ) { + break; + } + } + } + + return obj; + }, + + // results is for internal usage only + makeArray: function( arr, results ) { + var ret = results || []; + + if ( arr != null ) { + if ( isArrayLike( Object( arr ) ) ) { + jQuery.merge( ret, + typeof arr === "string" ? + [ arr ] : arr + ); + } else { + push.call( ret, arr ); + } + } + + return ret; + }, + + inArray: function( elem, arr, i ) { + return arr == null ? -1 : indexOf.call( arr, elem, i ); + }, + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + merge: function( first, second ) { + var len = +second.length, + j = 0, + i = first.length; + + for ( ; j < len; j++ ) { + first[ i++ ] = second[ j ]; + } + + first.length = i; + + return first; + }, + + grep: function( elems, callback, invert ) { + var callbackInverse, + matches = [], + i = 0, + length = elems.length, + callbackExpect = !invert; + + // Go through the array, only saving the items + // that pass the validator function + for ( ; i < length; i++ ) { + callbackInverse = !callback( elems[ i ], i ); + if ( callbackInverse !== callbackExpect ) { + matches.push( elems[ i ] ); + } + } + + return matches; + }, + + // arg is for internal usage only + map: function( elems, callback, arg ) { + var length, value, + i = 0, + ret = []; + + // Go through the array, translating each of the items to their new values + if ( isArrayLike( elems ) ) { + length = elems.length; + for ( ; i < length; i++ ) { + value = callback( elems[ i ], i, arg ); + + if ( value != null ) { + ret.push( value ); + } + } + + // Go through every key on the object, + } else { + for ( i in elems ) { + value = callback( elems[ i ], i, arg ); + + if ( value != null ) { + ret.push( value ); + } + } + } + + // Flatten any nested arrays + return flat( ret ); + }, + + // A global GUID counter for objects + guid: 1, + + // jQuery.support is not used in Core but other projects attach their + // properties to it so it needs to exist. + support: support +} ); + +if ( typeof Symbol === "function" ) { + jQuery.fn[ Symbol.iterator ] = arr[ Symbol.iterator ]; +} + +// Populate the class2type map +jQuery.each( "Boolean Number String Function Array Date RegExp Object Error Symbol".split( " " ), +function( _i, name ) { + class2type[ "[object " + name + "]" ] = name.toLowerCase(); +} ); + +function isArrayLike( obj ) { + + // Support: real iOS 8.2 only (not reproducible in simulator) + // `in` check used to prevent JIT error (gh-2145) + // hasOwn isn't used here due to false negatives + // regarding Nodelist length in IE + var length = !!obj && "length" in obj && obj.length, + type = toType( obj ); + + if ( isFunction( obj ) || isWindow( obj ) ) { + return false; + } + + return type === "array" || length === 0 || + typeof length === "number" && length > 0 && ( length - 1 ) in obj; +} +var Sizzle = +/*! + * Sizzle CSS Selector Engine v2.3.5 + * https://sizzlejs.com/ + * + * Copyright JS Foundation and other contributors + * Released under the MIT license + * https://js.foundation/ + * + * Date: 2020-03-14 + */ +( function( window ) { +var i, + support, + Expr, + getText, + isXML, + tokenize, + compile, + select, + outermostContext, + sortInput, + hasDuplicate, + + // Local document vars + setDocument, + document, + docElem, + documentIsHTML, + rbuggyQSA, + rbuggyMatches, + matches, + contains, + + // Instance-specific data + expando = "sizzle" + 1 * new Date(), + preferredDoc = window.document, + dirruns = 0, + done = 0, + classCache = createCache(), + tokenCache = createCache(), + compilerCache = createCache(), + nonnativeSelectorCache = createCache(), + sortOrder = function( a, b ) { + if ( a === b ) { + hasDuplicate = true; + } + return 0; + }, + + // Instance methods + hasOwn = ( {} ).hasOwnProperty, + arr = [], + pop = arr.pop, + pushNative = arr.push, + push = arr.push, + slice = arr.slice, + + // Use a stripped-down indexOf as it's faster than native + // https://jsperf.com/thor-indexof-vs-for/5 + indexOf = function( list, elem ) { + var i = 0, + len = list.length; + for ( ; i < len; i++ ) { + if ( list[ i ] === elem ) { + return i; + } + } + return -1; + }, + + booleans = "checked|selected|async|autofocus|autoplay|controls|defer|disabled|hidden|" + + "ismap|loop|multiple|open|readonly|required|scoped", + + // Regular expressions + + // http://www.w3.org/TR/css3-selectors/#whitespace + whitespace = "[\\x20\\t\\r\\n\\f]", + + // https://www.w3.org/TR/css-syntax-3/#ident-token-diagram + identifier = "(?:\\\\[\\da-fA-F]{1,6}" + whitespace + + "?|\\\\[^\\r\\n\\f]|[\\w-]|[^\0-\\x7f])+", + + // Attribute selectors: http://www.w3.org/TR/selectors/#attribute-selectors + attributes = "\\[" + whitespace + "*(" + identifier + ")(?:" + whitespace + + + // Operator (capture 2) + "*([*^$|!~]?=)" + whitespace + + + // "Attribute values must be CSS identifiers [capture 5] + // or strings [capture 3 or capture 4]" + "*(?:'((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\"|(" + identifier + "))|)" + + whitespace + "*\\]", + + pseudos = ":(" + identifier + ")(?:\\((" + + + // To reduce the number of selectors needing tokenize in the preFilter, prefer arguments: + // 1. quoted (capture 3; capture 4 or capture 5) + "('((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\")|" + + + // 2. simple (capture 6) + "((?:\\\\.|[^\\\\()[\\]]|" + attributes + ")*)|" + + + // 3. anything else (capture 2) + ".*" + + ")\\)|)", + + // Leading and non-escaped trailing whitespace, capturing some non-whitespace characters preceding the latter + rwhitespace = new RegExp( whitespace + "+", "g" ), + rtrim = new RegExp( "^" + whitespace + "+|((?:^|[^\\\\])(?:\\\\.)*)" + + whitespace + "+$", "g" ), + + rcomma = new RegExp( "^" + whitespace + "*," + whitespace + "*" ), + rcombinators = new RegExp( "^" + whitespace + "*([>+~]|" + whitespace + ")" + whitespace + + "*" ), + rdescend = new RegExp( whitespace + "|>" ), + + rpseudo = new RegExp( pseudos ), + ridentifier = new RegExp( "^" + identifier + "$" ), + + matchExpr = { + "ID": new RegExp( "^#(" + identifier + ")" ), + "CLASS": new RegExp( "^\\.(" + identifier + ")" ), + "TAG": new RegExp( "^(" + identifier + "|[*])" ), + "ATTR": new RegExp( "^" + attributes ), + "PSEUDO": new RegExp( "^" + pseudos ), + "CHILD": new RegExp( "^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\(" + + whitespace + "*(even|odd|(([+-]|)(\\d*)n|)" + whitespace + "*(?:([+-]|)" + + whitespace + "*(\\d+)|))" + whitespace + "*\\)|)", "i" ), + "bool": new RegExp( "^(?:" + booleans + ")$", "i" ), + + // For use in libraries implementing .is() + // We use this for POS matching in `select` + "needsContext": new RegExp( "^" + whitespace + + "*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\(" + whitespace + + "*((?:-\\d)?\\d*)" + whitespace + "*\\)|)(?=[^-]|$)", "i" ) + }, + + rhtml = /HTML$/i, + rinputs = /^(?:input|select|textarea|button)$/i, + rheader = /^h\d$/i, + + rnative = /^[^{]+\{\s*\[native \w/, + + // Easily-parseable/retrievable ID or TAG or CLASS selectors + rquickExpr = /^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/, + + rsibling = /[+~]/, + + // CSS escapes + // http://www.w3.org/TR/CSS21/syndata.html#escaped-characters + runescape = new RegExp( "\\\\[\\da-fA-F]{1,6}" + whitespace + "?|\\\\([^\\r\\n\\f])", "g" ), + funescape = function( escape, nonHex ) { + var high = "0x" + escape.slice( 1 ) - 0x10000; + + return nonHex ? + + // Strip the backslash prefix from a non-hex escape sequence + nonHex : + + // Replace a hexadecimal escape sequence with the encoded Unicode code point + // Support: IE <=11+ + // For values outside the Basic Multilingual Plane (BMP), manually construct a + // surrogate pair + high < 0 ? + String.fromCharCode( high + 0x10000 ) : + String.fromCharCode( high >> 10 | 0xD800, high & 0x3FF | 0xDC00 ); + }, + + // CSS string/identifier serialization + // https://drafts.csswg.org/cssom/#common-serializing-idioms + rcssescape = /([\0-\x1f\x7f]|^-?\d)|^-$|[^\0-\x1f\x7f-\uFFFF\w-]/g, + fcssescape = function( ch, asCodePoint ) { + if ( asCodePoint ) { + + // U+0000 NULL becomes U+FFFD REPLACEMENT CHARACTER + if ( ch === "\0" ) { + return "\uFFFD"; + } + + // Control characters and (dependent upon position) numbers get escaped as code points + return ch.slice( 0, -1 ) + "\\" + + ch.charCodeAt( ch.length - 1 ).toString( 16 ) + " "; + } + + // Other potentially-special ASCII characters get backslash-escaped + return "\\" + ch; + }, + + // Used for iframes + // See setDocument() + // Removing the function wrapper causes a "Permission Denied" + // error in IE + unloadHandler = function() { + setDocument(); + }, + + inDisabledFieldset = addCombinator( + function( elem ) { + return elem.disabled === true && elem.nodeName.toLowerCase() === "fieldset"; + }, + { dir: "parentNode", next: "legend" } + ); + +// Optimize for push.apply( _, NodeList ) +try { + push.apply( + ( arr = slice.call( preferredDoc.childNodes ) ), + preferredDoc.childNodes + ); + + // Support: Android<4.0 + // Detect silently failing push.apply + // eslint-disable-next-line no-unused-expressions + arr[ preferredDoc.childNodes.length ].nodeType; +} catch ( e ) { + push = { apply: arr.length ? + + // Leverage slice if possible + function( target, els ) { + pushNative.apply( target, slice.call( els ) ); + } : + + // Support: IE<9 + // Otherwise append directly + function( target, els ) { + var j = target.length, + i = 0; + + // Can't trust NodeList.length + while ( ( target[ j++ ] = els[ i++ ] ) ) {} + target.length = j - 1; + } + }; +} + +function Sizzle( selector, context, results, seed ) { + var m, i, elem, nid, match, groups, newSelector, + newContext = context && context.ownerDocument, + + // nodeType defaults to 9, since context defaults to document + nodeType = context ? context.nodeType : 9; + + results = results || []; + + // Return early from calls with invalid selector or context + if ( typeof selector !== "string" || !selector || + nodeType !== 1 && nodeType !== 9 && nodeType !== 11 ) { + + return results; + } + + // Try to shortcut find operations (as opposed to filters) in HTML documents + if ( !seed ) { + setDocument( context ); + context = context || document; + + if ( documentIsHTML ) { + + // If the selector is sufficiently simple, try using a "get*By*" DOM method + // (excepting DocumentFragment context, where the methods don't exist) + if ( nodeType !== 11 && ( match = rquickExpr.exec( selector ) ) ) { + + // ID selector + if ( ( m = match[ 1 ] ) ) { + + // Document context + if ( nodeType === 9 ) { + if ( ( elem = context.getElementById( m ) ) ) { + + // Support: IE, Opera, Webkit + // TODO: identify versions + // getElementById can match elements by name instead of ID + if ( elem.id === m ) { + results.push( elem ); + return results; + } + } else { + return results; + } + + // Element context + } else { + + // Support: IE, Opera, Webkit + // TODO: identify versions + // getElementById can match elements by name instead of ID + if ( newContext && ( elem = newContext.getElementById( m ) ) && + contains( context, elem ) && + elem.id === m ) { + + results.push( elem ); + return results; + } + } + + // Type selector + } else if ( match[ 2 ] ) { + push.apply( results, context.getElementsByTagName( selector ) ); + return results; + + // Class selector + } else if ( ( m = match[ 3 ] ) && support.getElementsByClassName && + context.getElementsByClassName ) { + + push.apply( results, context.getElementsByClassName( m ) ); + return results; + } + } + + // Take advantage of querySelectorAll + if ( support.qsa && + !nonnativeSelectorCache[ selector + " " ] && + ( !rbuggyQSA || !rbuggyQSA.test( selector ) ) && + + // Support: IE 8 only + // Exclude object elements + ( nodeType !== 1 || context.nodeName.toLowerCase() !== "object" ) ) { + + newSelector = selector; + newContext = context; + + // qSA considers elements outside a scoping root when evaluating child or + // descendant combinators, which is not what we want. + // In such cases, we work around the behavior by prefixing every selector in the + // list with an ID selector referencing the scope context. + // The technique has to be used as well when a leading combinator is used + // as such selectors are not recognized by querySelectorAll. + // Thanks to Andrew Dupont for this technique. + if ( nodeType === 1 && + ( rdescend.test( selector ) || rcombinators.test( selector ) ) ) { + + // Expand context for sibling selectors + newContext = rsibling.test( selector ) && testContext( context.parentNode ) || + context; + + // We can use :scope instead of the ID hack if the browser + // supports it & if we're not changing the context. + if ( newContext !== context || !support.scope ) { + + // Capture the context ID, setting it first if necessary + if ( ( nid = context.getAttribute( "id" ) ) ) { + nid = nid.replace( rcssescape, fcssescape ); + } else { + context.setAttribute( "id", ( nid = expando ) ); + } + } + + // Prefix every selector in the list + groups = tokenize( selector ); + i = groups.length; + while ( i-- ) { + groups[ i ] = ( nid ? "#" + nid : ":scope" ) + " " + + toSelector( groups[ i ] ); + } + newSelector = groups.join( "," ); + } + + try { + push.apply( results, + newContext.querySelectorAll( newSelector ) + ); + return results; + } catch ( qsaError ) { + nonnativeSelectorCache( selector, true ); + } finally { + if ( nid === expando ) { + context.removeAttribute( "id" ); + } + } + } + } + } + + // All others + return select( selector.replace( rtrim, "$1" ), context, results, seed ); +} + +/** + * Create key-value caches of limited size + * @returns {function(string, object)} Returns the Object data after storing it on itself with + * property name the (space-suffixed) string and (if the cache is larger than Expr.cacheLength) + * deleting the oldest entry + */ +function createCache() { + var keys = []; + + function cache( key, value ) { + + // Use (key + " ") to avoid collision with native prototype properties (see Issue #157) + if ( keys.push( key + " " ) > Expr.cacheLength ) { + + // Only keep the most recent entries + delete cache[ keys.shift() ]; + } + return ( cache[ key + " " ] = value ); + } + return cache; +} + +/** + * Mark a function for special use by Sizzle + * @param {Function} fn The function to mark + */ +function markFunction( fn ) { + fn[ expando ] = true; + return fn; +} + +/** + * Support testing using an element + * @param {Function} fn Passed the created element and returns a boolean result + */ +function assert( fn ) { + var el = document.createElement( "fieldset" ); + + try { + return !!fn( el ); + } catch ( e ) { + return false; + } finally { + + // Remove from its parent by default + if ( el.parentNode ) { + el.parentNode.removeChild( el ); + } + + // release memory in IE + el = null; + } +} + +/** + * Adds the same handler for all of the specified attrs + * @param {String} attrs Pipe-separated list of attributes + * @param {Function} handler The method that will be applied + */ +function addHandle( attrs, handler ) { + var arr = attrs.split( "|" ), + i = arr.length; + + while ( i-- ) { + Expr.attrHandle[ arr[ i ] ] = handler; + } +} + +/** + * Checks document order of two siblings + * @param {Element} a + * @param {Element} b + * @returns {Number} Returns less than 0 if a precedes b, greater than 0 if a follows b + */ +function siblingCheck( a, b ) { + var cur = b && a, + diff = cur && a.nodeType === 1 && b.nodeType === 1 && + a.sourceIndex - b.sourceIndex; + + // Use IE sourceIndex if available on both nodes + if ( diff ) { + return diff; + } + + // Check if b follows a + if ( cur ) { + while ( ( cur = cur.nextSibling ) ) { + if ( cur === b ) { + return -1; + } + } + } + + return a ? 1 : -1; +} + +/** + * Returns a function to use in pseudos for input types + * @param {String} type + */ +function createInputPseudo( type ) { + return function( elem ) { + var name = elem.nodeName.toLowerCase(); + return name === "input" && elem.type === type; + }; +} + +/** + * Returns a function to use in pseudos for buttons + * @param {String} type + */ +function createButtonPseudo( type ) { + return function( elem ) { + var name = elem.nodeName.toLowerCase(); + return ( name === "input" || name === "button" ) && elem.type === type; + }; +} + +/** + * Returns a function to use in pseudos for :enabled/:disabled + * @param {Boolean} disabled true for :disabled; false for :enabled + */ +function createDisabledPseudo( disabled ) { + + // Known :disabled false positives: fieldset[disabled] > legend:nth-of-type(n+2) :can-disable + return function( elem ) { + + // Only certain elements can match :enabled or :disabled + // https://html.spec.whatwg.org/multipage/scripting.html#selector-enabled + // https://html.spec.whatwg.org/multipage/scripting.html#selector-disabled + if ( "form" in elem ) { + + // Check for inherited disabledness on relevant non-disabled elements: + // * listed form-associated elements in a disabled fieldset + // https://html.spec.whatwg.org/multipage/forms.html#category-listed + // https://html.spec.whatwg.org/multipage/forms.html#concept-fe-disabled + // * option elements in a disabled optgroup + // https://html.spec.whatwg.org/multipage/forms.html#concept-option-disabled + // All such elements have a "form" property. + if ( elem.parentNode && elem.disabled === false ) { + + // Option elements defer to a parent optgroup if present + if ( "label" in elem ) { + if ( "label" in elem.parentNode ) { + return elem.parentNode.disabled === disabled; + } else { + return elem.disabled === disabled; + } + } + + // Support: IE 6 - 11 + // Use the isDisabled shortcut property to check for disabled fieldset ancestors + return elem.isDisabled === disabled || + + // Where there is no isDisabled, check manually + /* jshint -W018 */ + elem.isDisabled !== !disabled && + inDisabledFieldset( elem ) === disabled; + } + + return elem.disabled === disabled; + + // Try to winnow out elements that can't be disabled before trusting the disabled property. + // Some victims get caught in our net (label, legend, menu, track), but it shouldn't + // even exist on them, let alone have a boolean value. + } else if ( "label" in elem ) { + return elem.disabled === disabled; + } + + // Remaining elements are neither :enabled nor :disabled + return false; + }; +} + +/** + * Returns a function to use in pseudos for positionals + * @param {Function} fn + */ +function createPositionalPseudo( fn ) { + return markFunction( function( argument ) { + argument = +argument; + return markFunction( function( seed, matches ) { + var j, + matchIndexes = fn( [], seed.length, argument ), + i = matchIndexes.length; + + // Match elements found at the specified indexes + while ( i-- ) { + if ( seed[ ( j = matchIndexes[ i ] ) ] ) { + seed[ j ] = !( matches[ j ] = seed[ j ] ); + } + } + } ); + } ); +} + +/** + * Checks a node for validity as a Sizzle context + * @param {Element|Object=} context + * @returns {Element|Object|Boolean} The input node if acceptable, otherwise a falsy value + */ +function testContext( context ) { + return context && typeof context.getElementsByTagName !== "undefined" && context; +} + +// Expose support vars for convenience +support = Sizzle.support = {}; + +/** + * Detects XML nodes + * @param {Element|Object} elem An element or a document + * @returns {Boolean} True iff elem is a non-HTML XML node + */ +isXML = Sizzle.isXML = function( elem ) { + var namespace = elem.namespaceURI, + docElem = ( elem.ownerDocument || elem ).documentElement; + + // Support: IE <=8 + // Assume HTML when documentElement doesn't yet exist, such as inside loading iframes + // https://bugs.jquery.com/ticket/4833 + return !rhtml.test( namespace || docElem && docElem.nodeName || "HTML" ); +}; + +/** + * Sets document-related variables once based on the current document + * @param {Element|Object} [doc] An element or document object to use to set the document + * @returns {Object} Returns the current document + */ +setDocument = Sizzle.setDocument = function( node ) { + var hasCompare, subWindow, + doc = node ? node.ownerDocument || node : preferredDoc; + + // Return early if doc is invalid or already selected + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( doc == document || doc.nodeType !== 9 || !doc.documentElement ) { + return document; + } + + // Update global variables + document = doc; + docElem = document.documentElement; + documentIsHTML = !isXML( document ); + + // Support: IE 9 - 11+, Edge 12 - 18+ + // Accessing iframe documents after unload throws "permission denied" errors (jQuery #13936) + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( preferredDoc != document && + ( subWindow = document.defaultView ) && subWindow.top !== subWindow ) { + + // Support: IE 11, Edge + if ( subWindow.addEventListener ) { + subWindow.addEventListener( "unload", unloadHandler, false ); + + // Support: IE 9 - 10 only + } else if ( subWindow.attachEvent ) { + subWindow.attachEvent( "onunload", unloadHandler ); + } + } + + // Support: IE 8 - 11+, Edge 12 - 18+, Chrome <=16 - 25 only, Firefox <=3.6 - 31 only, + // Safari 4 - 5 only, Opera <=11.6 - 12.x only + // IE/Edge & older browsers don't support the :scope pseudo-class. + // Support: Safari 6.0 only + // Safari 6.0 supports :scope but it's an alias of :root there. + support.scope = assert( function( el ) { + docElem.appendChild( el ).appendChild( document.createElement( "div" ) ); + return typeof el.querySelectorAll !== "undefined" && + !el.querySelectorAll( ":scope fieldset div" ).length; + } ); + + /* Attributes + ---------------------------------------------------------------------- */ + + // Support: IE<8 + // Verify that getAttribute really returns attributes and not properties + // (excepting IE8 booleans) + support.attributes = assert( function( el ) { + el.className = "i"; + return !el.getAttribute( "className" ); + } ); + + /* getElement(s)By* + ---------------------------------------------------------------------- */ + + // Check if getElementsByTagName("*") returns only elements + support.getElementsByTagName = assert( function( el ) { + el.appendChild( document.createComment( "" ) ); + return !el.getElementsByTagName( "*" ).length; + } ); + + // Support: IE<9 + support.getElementsByClassName = rnative.test( document.getElementsByClassName ); + + // Support: IE<10 + // Check if getElementById returns elements by name + // The broken getElementById methods don't pick up programmatically-set names, + // so use a roundabout getElementsByName test + support.getById = assert( function( el ) { + docElem.appendChild( el ).id = expando; + return !document.getElementsByName || !document.getElementsByName( expando ).length; + } ); + + // ID filter and find + if ( support.getById ) { + Expr.filter[ "ID" ] = function( id ) { + var attrId = id.replace( runescape, funescape ); + return function( elem ) { + return elem.getAttribute( "id" ) === attrId; + }; + }; + Expr.find[ "ID" ] = function( id, context ) { + if ( typeof context.getElementById !== "undefined" && documentIsHTML ) { + var elem = context.getElementById( id ); + return elem ? [ elem ] : []; + } + }; + } else { + Expr.filter[ "ID" ] = function( id ) { + var attrId = id.replace( runescape, funescape ); + return function( elem ) { + var node = typeof elem.getAttributeNode !== "undefined" && + elem.getAttributeNode( "id" ); + return node && node.value === attrId; + }; + }; + + // Support: IE 6 - 7 only + // getElementById is not reliable as a find shortcut + Expr.find[ "ID" ] = function( id, context ) { + if ( typeof context.getElementById !== "undefined" && documentIsHTML ) { + var node, i, elems, + elem = context.getElementById( id ); + + if ( elem ) { + + // Verify the id attribute + node = elem.getAttributeNode( "id" ); + if ( node && node.value === id ) { + return [ elem ]; + } + + // Fall back on getElementsByName + elems = context.getElementsByName( id ); + i = 0; + while ( ( elem = elems[ i++ ] ) ) { + node = elem.getAttributeNode( "id" ); + if ( node && node.value === id ) { + return [ elem ]; + } + } + } + + return []; + } + }; + } + + // Tag + Expr.find[ "TAG" ] = support.getElementsByTagName ? + function( tag, context ) { + if ( typeof context.getElementsByTagName !== "undefined" ) { + return context.getElementsByTagName( tag ); + + // DocumentFragment nodes don't have gEBTN + } else if ( support.qsa ) { + return context.querySelectorAll( tag ); + } + } : + + function( tag, context ) { + var elem, + tmp = [], + i = 0, + + // By happy coincidence, a (broken) gEBTN appears on DocumentFragment nodes too + results = context.getElementsByTagName( tag ); + + // Filter out possible comments + if ( tag === "*" ) { + while ( ( elem = results[ i++ ] ) ) { + if ( elem.nodeType === 1 ) { + tmp.push( elem ); + } + } + + return tmp; + } + return results; + }; + + // Class + Expr.find[ "CLASS" ] = support.getElementsByClassName && function( className, context ) { + if ( typeof context.getElementsByClassName !== "undefined" && documentIsHTML ) { + return context.getElementsByClassName( className ); + } + }; + + /* QSA/matchesSelector + ---------------------------------------------------------------------- */ + + // QSA and matchesSelector support + + // matchesSelector(:active) reports false when true (IE9/Opera 11.5) + rbuggyMatches = []; + + // qSa(:focus) reports false when true (Chrome 21) + // We allow this because of a bug in IE8/9 that throws an error + // whenever `document.activeElement` is accessed on an iframe + // So, we allow :focus to pass through QSA all the time to avoid the IE error + // See https://bugs.jquery.com/ticket/13378 + rbuggyQSA = []; + + if ( ( support.qsa = rnative.test( document.querySelectorAll ) ) ) { + + // Build QSA regex + // Regex strategy adopted from Diego Perini + assert( function( el ) { + + var input; + + // Select is set to empty string on purpose + // This is to test IE's treatment of not explicitly + // setting a boolean content attribute, + // since its presence should be enough + // https://bugs.jquery.com/ticket/12359 + docElem.appendChild( el ).innerHTML = "" + + ""; + + // Support: IE8, Opera 11-12.16 + // Nothing should be selected when empty strings follow ^= or $= or *= + // The test attribute must be unknown in Opera but "safe" for WinRT + // https://msdn.microsoft.com/en-us/library/ie/hh465388.aspx#attribute_section + if ( el.querySelectorAll( "[msallowcapture^='']" ).length ) { + rbuggyQSA.push( "[*^$]=" + whitespace + "*(?:''|\"\")" ); + } + + // Support: IE8 + // Boolean attributes and "value" are not treated correctly + if ( !el.querySelectorAll( "[selected]" ).length ) { + rbuggyQSA.push( "\\[" + whitespace + "*(?:value|" + booleans + ")" ); + } + + // Support: Chrome<29, Android<4.4, Safari<7.0+, iOS<7.0+, PhantomJS<1.9.8+ + if ( !el.querySelectorAll( "[id~=" + expando + "-]" ).length ) { + rbuggyQSA.push( "~=" ); + } + + // Support: IE 11+, Edge 15 - 18+ + // IE 11/Edge don't find elements on a `[name='']` query in some cases. + // Adding a temporary attribute to the document before the selection works + // around the issue. + // Interestingly, IE 10 & older don't seem to have the issue. + input = document.createElement( "input" ); + input.setAttribute( "name", "" ); + el.appendChild( input ); + if ( !el.querySelectorAll( "[name='']" ).length ) { + rbuggyQSA.push( "\\[" + whitespace + "*name" + whitespace + "*=" + + whitespace + "*(?:''|\"\")" ); + } + + // Webkit/Opera - :checked should return selected option elements + // http://www.w3.org/TR/2011/REC-css3-selectors-20110929/#checked + // IE8 throws error here and will not see later tests + if ( !el.querySelectorAll( ":checked" ).length ) { + rbuggyQSA.push( ":checked" ); + } + + // Support: Safari 8+, iOS 8+ + // https://bugs.webkit.org/show_bug.cgi?id=136851 + // In-page `selector#id sibling-combinator selector` fails + if ( !el.querySelectorAll( "a#" + expando + "+*" ).length ) { + rbuggyQSA.push( ".#.+[+~]" ); + } + + // Support: Firefox <=3.6 - 5 only + // Old Firefox doesn't throw on a badly-escaped identifier. + el.querySelectorAll( "\\\f" ); + rbuggyQSA.push( "[\\r\\n\\f]" ); + } ); + + assert( function( el ) { + el.innerHTML = "" + + ""; + + // Support: Windows 8 Native Apps + // The type and name attributes are restricted during .innerHTML assignment + var input = document.createElement( "input" ); + input.setAttribute( "type", "hidden" ); + el.appendChild( input ).setAttribute( "name", "D" ); + + // Support: IE8 + // Enforce case-sensitivity of name attribute + if ( el.querySelectorAll( "[name=d]" ).length ) { + rbuggyQSA.push( "name" + whitespace + "*[*^$|!~]?=" ); + } + + // FF 3.5 - :enabled/:disabled and hidden elements (hidden elements are still enabled) + // IE8 throws error here and will not see later tests + if ( el.querySelectorAll( ":enabled" ).length !== 2 ) { + rbuggyQSA.push( ":enabled", ":disabled" ); + } + + // Support: IE9-11+ + // IE's :disabled selector does not pick up the children of disabled fieldsets + docElem.appendChild( el ).disabled = true; + if ( el.querySelectorAll( ":disabled" ).length !== 2 ) { + rbuggyQSA.push( ":enabled", ":disabled" ); + } + + // Support: Opera 10 - 11 only + // Opera 10-11 does not throw on post-comma invalid pseudos + el.querySelectorAll( "*,:x" ); + rbuggyQSA.push( ",.*:" ); + } ); + } + + if ( ( support.matchesSelector = rnative.test( ( matches = docElem.matches || + docElem.webkitMatchesSelector || + docElem.mozMatchesSelector || + docElem.oMatchesSelector || + docElem.msMatchesSelector ) ) ) ) { + + assert( function( el ) { + + // Check to see if it's possible to do matchesSelector + // on a disconnected node (IE 9) + support.disconnectedMatch = matches.call( el, "*" ); + + // This should fail with an exception + // Gecko does not error, returns false instead + matches.call( el, "[s!='']:x" ); + rbuggyMatches.push( "!=", pseudos ); + } ); + } + + rbuggyQSA = rbuggyQSA.length && new RegExp( rbuggyQSA.join( "|" ) ); + rbuggyMatches = rbuggyMatches.length && new RegExp( rbuggyMatches.join( "|" ) ); + + /* Contains + ---------------------------------------------------------------------- */ + hasCompare = rnative.test( docElem.compareDocumentPosition ); + + // Element contains another + // Purposefully self-exclusive + // As in, an element does not contain itself + contains = hasCompare || rnative.test( docElem.contains ) ? + function( a, b ) { + var adown = a.nodeType === 9 ? a.documentElement : a, + bup = b && b.parentNode; + return a === bup || !!( bup && bup.nodeType === 1 && ( + adown.contains ? + adown.contains( bup ) : + a.compareDocumentPosition && a.compareDocumentPosition( bup ) & 16 + ) ); + } : + function( a, b ) { + if ( b ) { + while ( ( b = b.parentNode ) ) { + if ( b === a ) { + return true; + } + } + } + return false; + }; + + /* Sorting + ---------------------------------------------------------------------- */ + + // Document order sorting + sortOrder = hasCompare ? + function( a, b ) { + + // Flag for duplicate removal + if ( a === b ) { + hasDuplicate = true; + return 0; + } + + // Sort on method existence if only one input has compareDocumentPosition + var compare = !a.compareDocumentPosition - !b.compareDocumentPosition; + if ( compare ) { + return compare; + } + + // Calculate position if both inputs belong to the same document + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + compare = ( a.ownerDocument || a ) == ( b.ownerDocument || b ) ? + a.compareDocumentPosition( b ) : + + // Otherwise we know they are disconnected + 1; + + // Disconnected nodes + if ( compare & 1 || + ( !support.sortDetached && b.compareDocumentPosition( a ) === compare ) ) { + + // Choose the first element that is related to our preferred document + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( a == document || a.ownerDocument == preferredDoc && + contains( preferredDoc, a ) ) { + return -1; + } + + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( b == document || b.ownerDocument == preferredDoc && + contains( preferredDoc, b ) ) { + return 1; + } + + // Maintain original order + return sortInput ? + ( indexOf( sortInput, a ) - indexOf( sortInput, b ) ) : + 0; + } + + return compare & 4 ? -1 : 1; + } : + function( a, b ) { + + // Exit early if the nodes are identical + if ( a === b ) { + hasDuplicate = true; + return 0; + } + + var cur, + i = 0, + aup = a.parentNode, + bup = b.parentNode, + ap = [ a ], + bp = [ b ]; + + // Parentless nodes are either documents or disconnected + if ( !aup || !bup ) { + + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + /* eslint-disable eqeqeq */ + return a == document ? -1 : + b == document ? 1 : + /* eslint-enable eqeqeq */ + aup ? -1 : + bup ? 1 : + sortInput ? + ( indexOf( sortInput, a ) - indexOf( sortInput, b ) ) : + 0; + + // If the nodes are siblings, we can do a quick check + } else if ( aup === bup ) { + return siblingCheck( a, b ); + } + + // Otherwise we need full lists of their ancestors for comparison + cur = a; + while ( ( cur = cur.parentNode ) ) { + ap.unshift( cur ); + } + cur = b; + while ( ( cur = cur.parentNode ) ) { + bp.unshift( cur ); + } + + // Walk down the tree looking for a discrepancy + while ( ap[ i ] === bp[ i ] ) { + i++; + } + + return i ? + + // Do a sibling check if the nodes have a common ancestor + siblingCheck( ap[ i ], bp[ i ] ) : + + // Otherwise nodes in our document sort first + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + /* eslint-disable eqeqeq */ + ap[ i ] == preferredDoc ? -1 : + bp[ i ] == preferredDoc ? 1 : + /* eslint-enable eqeqeq */ + 0; + }; + + return document; +}; + +Sizzle.matches = function( expr, elements ) { + return Sizzle( expr, null, null, elements ); +}; + +Sizzle.matchesSelector = function( elem, expr ) { + setDocument( elem ); + + if ( support.matchesSelector && documentIsHTML && + !nonnativeSelectorCache[ expr + " " ] && + ( !rbuggyMatches || !rbuggyMatches.test( expr ) ) && + ( !rbuggyQSA || !rbuggyQSA.test( expr ) ) ) { + + try { + var ret = matches.call( elem, expr ); + + // IE 9's matchesSelector returns false on disconnected nodes + if ( ret || support.disconnectedMatch || + + // As well, disconnected nodes are said to be in a document + // fragment in IE 9 + elem.document && elem.document.nodeType !== 11 ) { + return ret; + } + } catch ( e ) { + nonnativeSelectorCache( expr, true ); + } + } + + return Sizzle( expr, document, null, [ elem ] ).length > 0; +}; + +Sizzle.contains = function( context, elem ) { + + // Set document vars if needed + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( ( context.ownerDocument || context ) != document ) { + setDocument( context ); + } + return contains( context, elem ); +}; + +Sizzle.attr = function( elem, name ) { + + // Set document vars if needed + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( ( elem.ownerDocument || elem ) != document ) { + setDocument( elem ); + } + + var fn = Expr.attrHandle[ name.toLowerCase() ], + + // Don't get fooled by Object.prototype properties (jQuery #13807) + val = fn && hasOwn.call( Expr.attrHandle, name.toLowerCase() ) ? + fn( elem, name, !documentIsHTML ) : + undefined; + + return val !== undefined ? + val : + support.attributes || !documentIsHTML ? + elem.getAttribute( name ) : + ( val = elem.getAttributeNode( name ) ) && val.specified ? + val.value : + null; +}; + +Sizzle.escape = function( sel ) { + return ( sel + "" ).replace( rcssescape, fcssescape ); +}; + +Sizzle.error = function( msg ) { + throw new Error( "Syntax error, unrecognized expression: " + msg ); +}; + +/** + * Document sorting and removing duplicates + * @param {ArrayLike} results + */ +Sizzle.uniqueSort = function( results ) { + var elem, + duplicates = [], + j = 0, + i = 0; + + // Unless we *know* we can detect duplicates, assume their presence + hasDuplicate = !support.detectDuplicates; + sortInput = !support.sortStable && results.slice( 0 ); + results.sort( sortOrder ); + + if ( hasDuplicate ) { + while ( ( elem = results[ i++ ] ) ) { + if ( elem === results[ i ] ) { + j = duplicates.push( i ); + } + } + while ( j-- ) { + results.splice( duplicates[ j ], 1 ); + } + } + + // Clear input after sorting to release objects + // See https://github.com/jquery/sizzle/pull/225 + sortInput = null; + + return results; +}; + +/** + * Utility function for retrieving the text value of an array of DOM nodes + * @param {Array|Element} elem + */ +getText = Sizzle.getText = function( elem ) { + var node, + ret = "", + i = 0, + nodeType = elem.nodeType; + + if ( !nodeType ) { + + // If no nodeType, this is expected to be an array + while ( ( node = elem[ i++ ] ) ) { + + // Do not traverse comment nodes + ret += getText( node ); + } + } else if ( nodeType === 1 || nodeType === 9 || nodeType === 11 ) { + + // Use textContent for elements + // innerText usage removed for consistency of new lines (jQuery #11153) + if ( typeof elem.textContent === "string" ) { + return elem.textContent; + } else { + + // Traverse its children + for ( elem = elem.firstChild; elem; elem = elem.nextSibling ) { + ret += getText( elem ); + } + } + } else if ( nodeType === 3 || nodeType === 4 ) { + return elem.nodeValue; + } + + // Do not include comment or processing instruction nodes + + return ret; +}; + +Expr = Sizzle.selectors = { + + // Can be adjusted by the user + cacheLength: 50, + + createPseudo: markFunction, + + match: matchExpr, + + attrHandle: {}, + + find: {}, + + relative: { + ">": { dir: "parentNode", first: true }, + " ": { dir: "parentNode" }, + "+": { dir: "previousSibling", first: true }, + "~": { dir: "previousSibling" } + }, + + preFilter: { + "ATTR": function( match ) { + match[ 1 ] = match[ 1 ].replace( runescape, funescape ); + + // Move the given value to match[3] whether quoted or unquoted + match[ 3 ] = ( match[ 3 ] || match[ 4 ] || + match[ 5 ] || "" ).replace( runescape, funescape ); + + if ( match[ 2 ] === "~=" ) { + match[ 3 ] = " " + match[ 3 ] + " "; + } + + return match.slice( 0, 4 ); + }, + + "CHILD": function( match ) { + + /* matches from matchExpr["CHILD"] + 1 type (only|nth|...) + 2 what (child|of-type) + 3 argument (even|odd|\d*|\d*n([+-]\d+)?|...) + 4 xn-component of xn+y argument ([+-]?\d*n|) + 5 sign of xn-component + 6 x of xn-component + 7 sign of y-component + 8 y of y-component + */ + match[ 1 ] = match[ 1 ].toLowerCase(); + + if ( match[ 1 ].slice( 0, 3 ) === "nth" ) { + + // nth-* requires argument + if ( !match[ 3 ] ) { + Sizzle.error( match[ 0 ] ); + } + + // numeric x and y parameters for Expr.filter.CHILD + // remember that false/true cast respectively to 0/1 + match[ 4 ] = +( match[ 4 ] ? + match[ 5 ] + ( match[ 6 ] || 1 ) : + 2 * ( match[ 3 ] === "even" || match[ 3 ] === "odd" ) ); + match[ 5 ] = +( ( match[ 7 ] + match[ 8 ] ) || match[ 3 ] === "odd" ); + + // other types prohibit arguments + } else if ( match[ 3 ] ) { + Sizzle.error( match[ 0 ] ); + } + + return match; + }, + + "PSEUDO": function( match ) { + var excess, + unquoted = !match[ 6 ] && match[ 2 ]; + + if ( matchExpr[ "CHILD" ].test( match[ 0 ] ) ) { + return null; + } + + // Accept quoted arguments as-is + if ( match[ 3 ] ) { + match[ 2 ] = match[ 4 ] || match[ 5 ] || ""; + + // Strip excess characters from unquoted arguments + } else if ( unquoted && rpseudo.test( unquoted ) && + + // Get excess from tokenize (recursively) + ( excess = tokenize( unquoted, true ) ) && + + // advance to the next closing parenthesis + ( excess = unquoted.indexOf( ")", unquoted.length - excess ) - unquoted.length ) ) { + + // excess is a negative index + match[ 0 ] = match[ 0 ].slice( 0, excess ); + match[ 2 ] = unquoted.slice( 0, excess ); + } + + // Return only captures needed by the pseudo filter method (type and argument) + return match.slice( 0, 3 ); + } + }, + + filter: { + + "TAG": function( nodeNameSelector ) { + var nodeName = nodeNameSelector.replace( runescape, funescape ).toLowerCase(); + return nodeNameSelector === "*" ? + function() { + return true; + } : + function( elem ) { + return elem.nodeName && elem.nodeName.toLowerCase() === nodeName; + }; + }, + + "CLASS": function( className ) { + var pattern = classCache[ className + " " ]; + + return pattern || + ( pattern = new RegExp( "(^|" + whitespace + + ")" + className + "(" + whitespace + "|$)" ) ) && classCache( + className, function( elem ) { + return pattern.test( + typeof elem.className === "string" && elem.className || + typeof elem.getAttribute !== "undefined" && + elem.getAttribute( "class" ) || + "" + ); + } ); + }, + + "ATTR": function( name, operator, check ) { + return function( elem ) { + var result = Sizzle.attr( elem, name ); + + if ( result == null ) { + return operator === "!="; + } + if ( !operator ) { + return true; + } + + result += ""; + + /* eslint-disable max-len */ + + return operator === "=" ? result === check : + operator === "!=" ? result !== check : + operator === "^=" ? check && result.indexOf( check ) === 0 : + operator === "*=" ? check && result.indexOf( check ) > -1 : + operator === "$=" ? check && result.slice( -check.length ) === check : + operator === "~=" ? ( " " + result.replace( rwhitespace, " " ) + " " ).indexOf( check ) > -1 : + operator === "|=" ? result === check || result.slice( 0, check.length + 1 ) === check + "-" : + false; + /* eslint-enable max-len */ + + }; + }, + + "CHILD": function( type, what, _argument, first, last ) { + var simple = type.slice( 0, 3 ) !== "nth", + forward = type.slice( -4 ) !== "last", + ofType = what === "of-type"; + + return first === 1 && last === 0 ? + + // Shortcut for :nth-*(n) + function( elem ) { + return !!elem.parentNode; + } : + + function( elem, _context, xml ) { + var cache, uniqueCache, outerCache, node, nodeIndex, start, + dir = simple !== forward ? "nextSibling" : "previousSibling", + parent = elem.parentNode, + name = ofType && elem.nodeName.toLowerCase(), + useCache = !xml && !ofType, + diff = false; + + if ( parent ) { + + // :(first|last|only)-(child|of-type) + if ( simple ) { + while ( dir ) { + node = elem; + while ( ( node = node[ dir ] ) ) { + if ( ofType ? + node.nodeName.toLowerCase() === name : + node.nodeType === 1 ) { + + return false; + } + } + + // Reverse direction for :only-* (if we haven't yet done so) + start = dir = type === "only" && !start && "nextSibling"; + } + return true; + } + + start = [ forward ? parent.firstChild : parent.lastChild ]; + + // non-xml :nth-child(...) stores cache data on `parent` + if ( forward && useCache ) { + + // Seek `elem` from a previously-cached index + + // ...in a gzip-friendly way + node = parent; + outerCache = node[ expando ] || ( node[ expando ] = {} ); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ node.uniqueID ] || + ( outerCache[ node.uniqueID ] = {} ); + + cache = uniqueCache[ type ] || []; + nodeIndex = cache[ 0 ] === dirruns && cache[ 1 ]; + diff = nodeIndex && cache[ 2 ]; + node = nodeIndex && parent.childNodes[ nodeIndex ]; + + while ( ( node = ++nodeIndex && node && node[ dir ] || + + // Fallback to seeking `elem` from the start + ( diff = nodeIndex = 0 ) || start.pop() ) ) { + + // When found, cache indexes on `parent` and break + if ( node.nodeType === 1 && ++diff && node === elem ) { + uniqueCache[ type ] = [ dirruns, nodeIndex, diff ]; + break; + } + } + + } else { + + // Use previously-cached element index if available + if ( useCache ) { + + // ...in a gzip-friendly way + node = elem; + outerCache = node[ expando ] || ( node[ expando ] = {} ); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ node.uniqueID ] || + ( outerCache[ node.uniqueID ] = {} ); + + cache = uniqueCache[ type ] || []; + nodeIndex = cache[ 0 ] === dirruns && cache[ 1 ]; + diff = nodeIndex; + } + + // xml :nth-child(...) + // or :nth-last-child(...) or :nth(-last)?-of-type(...) + if ( diff === false ) { + + // Use the same loop as above to seek `elem` from the start + while ( ( node = ++nodeIndex && node && node[ dir ] || + ( diff = nodeIndex = 0 ) || start.pop() ) ) { + + if ( ( ofType ? + node.nodeName.toLowerCase() === name : + node.nodeType === 1 ) && + ++diff ) { + + // Cache the index of each encountered element + if ( useCache ) { + outerCache = node[ expando ] || + ( node[ expando ] = {} ); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ node.uniqueID ] || + ( outerCache[ node.uniqueID ] = {} ); + + uniqueCache[ type ] = [ dirruns, diff ]; + } + + if ( node === elem ) { + break; + } + } + } + } + } + + // Incorporate the offset, then check against cycle size + diff -= last; + return diff === first || ( diff % first === 0 && diff / first >= 0 ); + } + }; + }, + + "PSEUDO": function( pseudo, argument ) { + + // pseudo-class names are case-insensitive + // http://www.w3.org/TR/selectors/#pseudo-classes + // Prioritize by case sensitivity in case custom pseudos are added with uppercase letters + // Remember that setFilters inherits from pseudos + var args, + fn = Expr.pseudos[ pseudo ] || Expr.setFilters[ pseudo.toLowerCase() ] || + Sizzle.error( "unsupported pseudo: " + pseudo ); + + // The user may use createPseudo to indicate that + // arguments are needed to create the filter function + // just as Sizzle does + if ( fn[ expando ] ) { + return fn( argument ); + } + + // But maintain support for old signatures + if ( fn.length > 1 ) { + args = [ pseudo, pseudo, "", argument ]; + return Expr.setFilters.hasOwnProperty( pseudo.toLowerCase() ) ? + markFunction( function( seed, matches ) { + var idx, + matched = fn( seed, argument ), + i = matched.length; + while ( i-- ) { + idx = indexOf( seed, matched[ i ] ); + seed[ idx ] = !( matches[ idx ] = matched[ i ] ); + } + } ) : + function( elem ) { + return fn( elem, 0, args ); + }; + } + + return fn; + } + }, + + pseudos: { + + // Potentially complex pseudos + "not": markFunction( function( selector ) { + + // Trim the selector passed to compile + // to avoid treating leading and trailing + // spaces as combinators + var input = [], + results = [], + matcher = compile( selector.replace( rtrim, "$1" ) ); + + return matcher[ expando ] ? + markFunction( function( seed, matches, _context, xml ) { + var elem, + unmatched = matcher( seed, null, xml, [] ), + i = seed.length; + + // Match elements unmatched by `matcher` + while ( i-- ) { + if ( ( elem = unmatched[ i ] ) ) { + seed[ i ] = !( matches[ i ] = elem ); + } + } + } ) : + function( elem, _context, xml ) { + input[ 0 ] = elem; + matcher( input, null, xml, results ); + + // Don't keep the element (issue #299) + input[ 0 ] = null; + return !results.pop(); + }; + } ), + + "has": markFunction( function( selector ) { + return function( elem ) { + return Sizzle( selector, elem ).length > 0; + }; + } ), + + "contains": markFunction( function( text ) { + text = text.replace( runescape, funescape ); + return function( elem ) { + return ( elem.textContent || getText( elem ) ).indexOf( text ) > -1; + }; + } ), + + // "Whether an element is represented by a :lang() selector + // is based solely on the element's language value + // being equal to the identifier C, + // or beginning with the identifier C immediately followed by "-". + // The matching of C against the element's language value is performed case-insensitively. + // The identifier C does not have to be a valid language name." + // http://www.w3.org/TR/selectors/#lang-pseudo + "lang": markFunction( function( lang ) { + + // lang value must be a valid identifier + if ( !ridentifier.test( lang || "" ) ) { + Sizzle.error( "unsupported lang: " + lang ); + } + lang = lang.replace( runescape, funescape ).toLowerCase(); + return function( elem ) { + var elemLang; + do { + if ( ( elemLang = documentIsHTML ? + elem.lang : + elem.getAttribute( "xml:lang" ) || elem.getAttribute( "lang" ) ) ) { + + elemLang = elemLang.toLowerCase(); + return elemLang === lang || elemLang.indexOf( lang + "-" ) === 0; + } + } while ( ( elem = elem.parentNode ) && elem.nodeType === 1 ); + return false; + }; + } ), + + // Miscellaneous + "target": function( elem ) { + var hash = window.location && window.location.hash; + return hash && hash.slice( 1 ) === elem.id; + }, + + "root": function( elem ) { + return elem === docElem; + }, + + "focus": function( elem ) { + return elem === document.activeElement && + ( !document.hasFocus || document.hasFocus() ) && + !!( elem.type || elem.href || ~elem.tabIndex ); + }, + + // Boolean properties + "enabled": createDisabledPseudo( false ), + "disabled": createDisabledPseudo( true ), + + "checked": function( elem ) { + + // In CSS3, :checked should return both checked and selected elements + // http://www.w3.org/TR/2011/REC-css3-selectors-20110929/#checked + var nodeName = elem.nodeName.toLowerCase(); + return ( nodeName === "input" && !!elem.checked ) || + ( nodeName === "option" && !!elem.selected ); + }, + + "selected": function( elem ) { + + // Accessing this property makes selected-by-default + // options in Safari work properly + if ( elem.parentNode ) { + // eslint-disable-next-line no-unused-expressions + elem.parentNode.selectedIndex; + } + + return elem.selected === true; + }, + + // Contents + "empty": function( elem ) { + + // http://www.w3.org/TR/selectors/#empty-pseudo + // :empty is negated by element (1) or content nodes (text: 3; cdata: 4; entity ref: 5), + // but not by others (comment: 8; processing instruction: 7; etc.) + // nodeType < 6 works because attributes (2) do not appear as children + for ( elem = elem.firstChild; elem; elem = elem.nextSibling ) { + if ( elem.nodeType < 6 ) { + return false; + } + } + return true; + }, + + "parent": function( elem ) { + return !Expr.pseudos[ "empty" ]( elem ); + }, + + // Element/input types + "header": function( elem ) { + return rheader.test( elem.nodeName ); + }, + + "input": function( elem ) { + return rinputs.test( elem.nodeName ); + }, + + "button": function( elem ) { + var name = elem.nodeName.toLowerCase(); + return name === "input" && elem.type === "button" || name === "button"; + }, + + "text": function( elem ) { + var attr; + return elem.nodeName.toLowerCase() === "input" && + elem.type === "text" && + + // Support: IE<8 + // New HTML5 attribute values (e.g., "search") appear with elem.type === "text" + ( ( attr = elem.getAttribute( "type" ) ) == null || + attr.toLowerCase() === "text" ); + }, + + // Position-in-collection + "first": createPositionalPseudo( function() { + return [ 0 ]; + } ), + + "last": createPositionalPseudo( function( _matchIndexes, length ) { + return [ length - 1 ]; + } ), + + "eq": createPositionalPseudo( function( _matchIndexes, length, argument ) { + return [ argument < 0 ? argument + length : argument ]; + } ), + + "even": createPositionalPseudo( function( matchIndexes, length ) { + var i = 0; + for ( ; i < length; i += 2 ) { + matchIndexes.push( i ); + } + return matchIndexes; + } ), + + "odd": createPositionalPseudo( function( matchIndexes, length ) { + var i = 1; + for ( ; i < length; i += 2 ) { + matchIndexes.push( i ); + } + return matchIndexes; + } ), + + "lt": createPositionalPseudo( function( matchIndexes, length, argument ) { + var i = argument < 0 ? + argument + length : + argument > length ? + length : + argument; + for ( ; --i >= 0; ) { + matchIndexes.push( i ); + } + return matchIndexes; + } ), + + "gt": createPositionalPseudo( function( matchIndexes, length, argument ) { + var i = argument < 0 ? argument + length : argument; + for ( ; ++i < length; ) { + matchIndexes.push( i ); + } + return matchIndexes; + } ) + } +}; + +Expr.pseudos[ "nth" ] = Expr.pseudos[ "eq" ]; + +// Add button/input type pseudos +for ( i in { radio: true, checkbox: true, file: true, password: true, image: true } ) { + Expr.pseudos[ i ] = createInputPseudo( i ); +} +for ( i in { submit: true, reset: true } ) { + Expr.pseudos[ i ] = createButtonPseudo( i ); +} + +// Easy API for creating new setFilters +function setFilters() {} +setFilters.prototype = Expr.filters = Expr.pseudos; +Expr.setFilters = new setFilters(); + +tokenize = Sizzle.tokenize = function( selector, parseOnly ) { + var matched, match, tokens, type, + soFar, groups, preFilters, + cached = tokenCache[ selector + " " ]; + + if ( cached ) { + return parseOnly ? 0 : cached.slice( 0 ); + } + + soFar = selector; + groups = []; + preFilters = Expr.preFilter; + + while ( soFar ) { + + // Comma and first run + if ( !matched || ( match = rcomma.exec( soFar ) ) ) { + if ( match ) { + + // Don't consume trailing commas as valid + soFar = soFar.slice( match[ 0 ].length ) || soFar; + } + groups.push( ( tokens = [] ) ); + } + + matched = false; + + // Combinators + if ( ( match = rcombinators.exec( soFar ) ) ) { + matched = match.shift(); + tokens.push( { + value: matched, + + // Cast descendant combinators to space + type: match[ 0 ].replace( rtrim, " " ) + } ); + soFar = soFar.slice( matched.length ); + } + + // Filters + for ( type in Expr.filter ) { + if ( ( match = matchExpr[ type ].exec( soFar ) ) && ( !preFilters[ type ] || + ( match = preFilters[ type ]( match ) ) ) ) { + matched = match.shift(); + tokens.push( { + value: matched, + type: type, + matches: match + } ); + soFar = soFar.slice( matched.length ); + } + } + + if ( !matched ) { + break; + } + } + + // Return the length of the invalid excess + // if we're just parsing + // Otherwise, throw an error or return tokens + return parseOnly ? + soFar.length : + soFar ? + Sizzle.error( selector ) : + + // Cache the tokens + tokenCache( selector, groups ).slice( 0 ); +}; + +function toSelector( tokens ) { + var i = 0, + len = tokens.length, + selector = ""; + for ( ; i < len; i++ ) { + selector += tokens[ i ].value; + } + return selector; +} + +function addCombinator( matcher, combinator, base ) { + var dir = combinator.dir, + skip = combinator.next, + key = skip || dir, + checkNonElements = base && key === "parentNode", + doneName = done++; + + return combinator.first ? + + // Check against closest ancestor/preceding element + function( elem, context, xml ) { + while ( ( elem = elem[ dir ] ) ) { + if ( elem.nodeType === 1 || checkNonElements ) { + return matcher( elem, context, xml ); + } + } + return false; + } : + + // Check against all ancestor/preceding elements + function( elem, context, xml ) { + var oldCache, uniqueCache, outerCache, + newCache = [ dirruns, doneName ]; + + // We can't set arbitrary data on XML nodes, so they don't benefit from combinator caching + if ( xml ) { + while ( ( elem = elem[ dir ] ) ) { + if ( elem.nodeType === 1 || checkNonElements ) { + if ( matcher( elem, context, xml ) ) { + return true; + } + } + } + } else { + while ( ( elem = elem[ dir ] ) ) { + if ( elem.nodeType === 1 || checkNonElements ) { + outerCache = elem[ expando ] || ( elem[ expando ] = {} ); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ elem.uniqueID ] || + ( outerCache[ elem.uniqueID ] = {} ); + + if ( skip && skip === elem.nodeName.toLowerCase() ) { + elem = elem[ dir ] || elem; + } else if ( ( oldCache = uniqueCache[ key ] ) && + oldCache[ 0 ] === dirruns && oldCache[ 1 ] === doneName ) { + + // Assign to newCache so results back-propagate to previous elements + return ( newCache[ 2 ] = oldCache[ 2 ] ); + } else { + + // Reuse newcache so results back-propagate to previous elements + uniqueCache[ key ] = newCache; + + // A match means we're done; a fail means we have to keep checking + if ( ( newCache[ 2 ] = matcher( elem, context, xml ) ) ) { + return true; + } + } + } + } + } + return false; + }; +} + +function elementMatcher( matchers ) { + return matchers.length > 1 ? + function( elem, context, xml ) { + var i = matchers.length; + while ( i-- ) { + if ( !matchers[ i ]( elem, context, xml ) ) { + return false; + } + } + return true; + } : + matchers[ 0 ]; +} + +function multipleContexts( selector, contexts, results ) { + var i = 0, + len = contexts.length; + for ( ; i < len; i++ ) { + Sizzle( selector, contexts[ i ], results ); + } + return results; +} + +function condense( unmatched, map, filter, context, xml ) { + var elem, + newUnmatched = [], + i = 0, + len = unmatched.length, + mapped = map != null; + + for ( ; i < len; i++ ) { + if ( ( elem = unmatched[ i ] ) ) { + if ( !filter || filter( elem, context, xml ) ) { + newUnmatched.push( elem ); + if ( mapped ) { + map.push( i ); + } + } + } + } + + return newUnmatched; +} + +function setMatcher( preFilter, selector, matcher, postFilter, postFinder, postSelector ) { + if ( postFilter && !postFilter[ expando ] ) { + postFilter = setMatcher( postFilter ); + } + if ( postFinder && !postFinder[ expando ] ) { + postFinder = setMatcher( postFinder, postSelector ); + } + return markFunction( function( seed, results, context, xml ) { + var temp, i, elem, + preMap = [], + postMap = [], + preexisting = results.length, + + // Get initial elements from seed or context + elems = seed || multipleContexts( + selector || "*", + context.nodeType ? [ context ] : context, + [] + ), + + // Prefilter to get matcher input, preserving a map for seed-results synchronization + matcherIn = preFilter && ( seed || !selector ) ? + condense( elems, preMap, preFilter, context, xml ) : + elems, + + matcherOut = matcher ? + + // If we have a postFinder, or filtered seed, or non-seed postFilter or preexisting results, + postFinder || ( seed ? preFilter : preexisting || postFilter ) ? + + // ...intermediate processing is necessary + [] : + + // ...otherwise use results directly + results : + matcherIn; + + // Find primary matches + if ( matcher ) { + matcher( matcherIn, matcherOut, context, xml ); + } + + // Apply postFilter + if ( postFilter ) { + temp = condense( matcherOut, postMap ); + postFilter( temp, [], context, xml ); + + // Un-match failing elements by moving them back to matcherIn + i = temp.length; + while ( i-- ) { + if ( ( elem = temp[ i ] ) ) { + matcherOut[ postMap[ i ] ] = !( matcherIn[ postMap[ i ] ] = elem ); + } + } + } + + if ( seed ) { + if ( postFinder || preFilter ) { + if ( postFinder ) { + + // Get the final matcherOut by condensing this intermediate into postFinder contexts + temp = []; + i = matcherOut.length; + while ( i-- ) { + if ( ( elem = matcherOut[ i ] ) ) { + + // Restore matcherIn since elem is not yet a final match + temp.push( ( matcherIn[ i ] = elem ) ); + } + } + postFinder( null, ( matcherOut = [] ), temp, xml ); + } + + // Move matched elements from seed to results to keep them synchronized + i = matcherOut.length; + while ( i-- ) { + if ( ( elem = matcherOut[ i ] ) && + ( temp = postFinder ? indexOf( seed, elem ) : preMap[ i ] ) > -1 ) { + + seed[ temp ] = !( results[ temp ] = elem ); + } + } + } + + // Add elements to results, through postFinder if defined + } else { + matcherOut = condense( + matcherOut === results ? + matcherOut.splice( preexisting, matcherOut.length ) : + matcherOut + ); + if ( postFinder ) { + postFinder( null, results, matcherOut, xml ); + } else { + push.apply( results, matcherOut ); + } + } + } ); +} + +function matcherFromTokens( tokens ) { + var checkContext, matcher, j, + len = tokens.length, + leadingRelative = Expr.relative[ tokens[ 0 ].type ], + implicitRelative = leadingRelative || Expr.relative[ " " ], + i = leadingRelative ? 1 : 0, + + // The foundational matcher ensures that elements are reachable from top-level context(s) + matchContext = addCombinator( function( elem ) { + return elem === checkContext; + }, implicitRelative, true ), + matchAnyContext = addCombinator( function( elem ) { + return indexOf( checkContext, elem ) > -1; + }, implicitRelative, true ), + matchers = [ function( elem, context, xml ) { + var ret = ( !leadingRelative && ( xml || context !== outermostContext ) ) || ( + ( checkContext = context ).nodeType ? + matchContext( elem, context, xml ) : + matchAnyContext( elem, context, xml ) ); + + // Avoid hanging onto element (issue #299) + checkContext = null; + return ret; + } ]; + + for ( ; i < len; i++ ) { + if ( ( matcher = Expr.relative[ tokens[ i ].type ] ) ) { + matchers = [ addCombinator( elementMatcher( matchers ), matcher ) ]; + } else { + matcher = Expr.filter[ tokens[ i ].type ].apply( null, tokens[ i ].matches ); + + // Return special upon seeing a positional matcher + if ( matcher[ expando ] ) { + + // Find the next relative operator (if any) for proper handling + j = ++i; + for ( ; j < len; j++ ) { + if ( Expr.relative[ tokens[ j ].type ] ) { + break; + } + } + return setMatcher( + i > 1 && elementMatcher( matchers ), + i > 1 && toSelector( + + // If the preceding token was a descendant combinator, insert an implicit any-element `*` + tokens + .slice( 0, i - 1 ) + .concat( { value: tokens[ i - 2 ].type === " " ? "*" : "" } ) + ).replace( rtrim, "$1" ), + matcher, + i < j && matcherFromTokens( tokens.slice( i, j ) ), + j < len && matcherFromTokens( ( tokens = tokens.slice( j ) ) ), + j < len && toSelector( tokens ) + ); + } + matchers.push( matcher ); + } + } + + return elementMatcher( matchers ); +} + +function matcherFromGroupMatchers( elementMatchers, setMatchers ) { + var bySet = setMatchers.length > 0, + byElement = elementMatchers.length > 0, + superMatcher = function( seed, context, xml, results, outermost ) { + var elem, j, matcher, + matchedCount = 0, + i = "0", + unmatched = seed && [], + setMatched = [], + contextBackup = outermostContext, + + // We must always have either seed elements or outermost context + elems = seed || byElement && Expr.find[ "TAG" ]( "*", outermost ), + + // Use integer dirruns iff this is the outermost matcher + dirrunsUnique = ( dirruns += contextBackup == null ? 1 : Math.random() || 0.1 ), + len = elems.length; + + if ( outermost ) { + + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + outermostContext = context == document || context || outermost; + } + + // Add elements passing elementMatchers directly to results + // Support: IE<9, Safari + // Tolerate NodeList properties (IE: "length"; Safari: ) matching elements by id + for ( ; i !== len && ( elem = elems[ i ] ) != null; i++ ) { + if ( byElement && elem ) { + j = 0; + + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( !context && elem.ownerDocument != document ) { + setDocument( elem ); + xml = !documentIsHTML; + } + while ( ( matcher = elementMatchers[ j++ ] ) ) { + if ( matcher( elem, context || document, xml ) ) { + results.push( elem ); + break; + } + } + if ( outermost ) { + dirruns = dirrunsUnique; + } + } + + // Track unmatched elements for set filters + if ( bySet ) { + + // They will have gone through all possible matchers + if ( ( elem = !matcher && elem ) ) { + matchedCount--; + } + + // Lengthen the array for every element, matched or not + if ( seed ) { + unmatched.push( elem ); + } + } + } + + // `i` is now the count of elements visited above, and adding it to `matchedCount` + // makes the latter nonnegative. + matchedCount += i; + + // Apply set filters to unmatched elements + // NOTE: This can be skipped if there are no unmatched elements (i.e., `matchedCount` + // equals `i`), unless we didn't visit _any_ elements in the above loop because we have + // no element matchers and no seed. + // Incrementing an initially-string "0" `i` allows `i` to remain a string only in that + // case, which will result in a "00" `matchedCount` that differs from `i` but is also + // numerically zero. + if ( bySet && i !== matchedCount ) { + j = 0; + while ( ( matcher = setMatchers[ j++ ] ) ) { + matcher( unmatched, setMatched, context, xml ); + } + + if ( seed ) { + + // Reintegrate element matches to eliminate the need for sorting + if ( matchedCount > 0 ) { + while ( i-- ) { + if ( !( unmatched[ i ] || setMatched[ i ] ) ) { + setMatched[ i ] = pop.call( results ); + } + } + } + + // Discard index placeholder values to get only actual matches + setMatched = condense( setMatched ); + } + + // Add matches to results + push.apply( results, setMatched ); + + // Seedless set matches succeeding multiple successful matchers stipulate sorting + if ( outermost && !seed && setMatched.length > 0 && + ( matchedCount + setMatchers.length ) > 1 ) { + + Sizzle.uniqueSort( results ); + } + } + + // Override manipulation of globals by nested matchers + if ( outermost ) { + dirruns = dirrunsUnique; + outermostContext = contextBackup; + } + + return unmatched; + }; + + return bySet ? + markFunction( superMatcher ) : + superMatcher; +} + +compile = Sizzle.compile = function( selector, match /* Internal Use Only */ ) { + var i, + setMatchers = [], + elementMatchers = [], + cached = compilerCache[ selector + " " ]; + + if ( !cached ) { + + // Generate a function of recursive functions that can be used to check each element + if ( !match ) { + match = tokenize( selector ); + } + i = match.length; + while ( i-- ) { + cached = matcherFromTokens( match[ i ] ); + if ( cached[ expando ] ) { + setMatchers.push( cached ); + } else { + elementMatchers.push( cached ); + } + } + + // Cache the compiled function + cached = compilerCache( + selector, + matcherFromGroupMatchers( elementMatchers, setMatchers ) + ); + + // Save selector and tokenization + cached.selector = selector; + } + return cached; +}; + +/** + * A low-level selection function that works with Sizzle's compiled + * selector functions + * @param {String|Function} selector A selector or a pre-compiled + * selector function built with Sizzle.compile + * @param {Element} context + * @param {Array} [results] + * @param {Array} [seed] A set of elements to match against + */ +select = Sizzle.select = function( selector, context, results, seed ) { + var i, tokens, token, type, find, + compiled = typeof selector === "function" && selector, + match = !seed && tokenize( ( selector = compiled.selector || selector ) ); + + results = results || []; + + // Try to minimize operations if there is only one selector in the list and no seed + // (the latter of which guarantees us context) + if ( match.length === 1 ) { + + // Reduce context if the leading compound selector is an ID + tokens = match[ 0 ] = match[ 0 ].slice( 0 ); + if ( tokens.length > 2 && ( token = tokens[ 0 ] ).type === "ID" && + context.nodeType === 9 && documentIsHTML && Expr.relative[ tokens[ 1 ].type ] ) { + + context = ( Expr.find[ "ID" ]( token.matches[ 0 ] + .replace( runescape, funescape ), context ) || [] )[ 0 ]; + if ( !context ) { + return results; + + // Precompiled matchers will still verify ancestry, so step up a level + } else if ( compiled ) { + context = context.parentNode; + } + + selector = selector.slice( tokens.shift().value.length ); + } + + // Fetch a seed set for right-to-left matching + i = matchExpr[ "needsContext" ].test( selector ) ? 0 : tokens.length; + while ( i-- ) { + token = tokens[ i ]; + + // Abort if we hit a combinator + if ( Expr.relative[ ( type = token.type ) ] ) { + break; + } + if ( ( find = Expr.find[ type ] ) ) { + + // Search, expanding context for leading sibling combinators + if ( ( seed = find( + token.matches[ 0 ].replace( runescape, funescape ), + rsibling.test( tokens[ 0 ].type ) && testContext( context.parentNode ) || + context + ) ) ) { + + // If seed is empty or no tokens remain, we can return early + tokens.splice( i, 1 ); + selector = seed.length && toSelector( tokens ); + if ( !selector ) { + push.apply( results, seed ); + return results; + } + + break; + } + } + } + } + + // Compile and execute a filtering function if one is not provided + // Provide `match` to avoid retokenization if we modified the selector above + ( compiled || compile( selector, match ) )( + seed, + context, + !documentIsHTML, + results, + !context || rsibling.test( selector ) && testContext( context.parentNode ) || context + ); + return results; +}; + +// One-time assignments + +// Sort stability +support.sortStable = expando.split( "" ).sort( sortOrder ).join( "" ) === expando; + +// Support: Chrome 14-35+ +// Always assume duplicates if they aren't passed to the comparison function +support.detectDuplicates = !!hasDuplicate; + +// Initialize against the default document +setDocument(); + +// Support: Webkit<537.32 - Safari 6.0.3/Chrome 25 (fixed in Chrome 27) +// Detached nodes confoundingly follow *each other* +support.sortDetached = assert( function( el ) { + + // Should return 1, but returns 4 (following) + return el.compareDocumentPosition( document.createElement( "fieldset" ) ) & 1; +} ); + +// Support: IE<8 +// Prevent attribute/property "interpolation" +// https://msdn.microsoft.com/en-us/library/ms536429%28VS.85%29.aspx +if ( !assert( function( el ) { + el.innerHTML = ""; + return el.firstChild.getAttribute( "href" ) === "#"; +} ) ) { + addHandle( "type|href|height|width", function( elem, name, isXML ) { + if ( !isXML ) { + return elem.getAttribute( name, name.toLowerCase() === "type" ? 1 : 2 ); + } + } ); +} + +// Support: IE<9 +// Use defaultValue in place of getAttribute("value") +if ( !support.attributes || !assert( function( el ) { + el.innerHTML = ""; + el.firstChild.setAttribute( "value", "" ); + return el.firstChild.getAttribute( "value" ) === ""; +} ) ) { + addHandle( "value", function( elem, _name, isXML ) { + if ( !isXML && elem.nodeName.toLowerCase() === "input" ) { + return elem.defaultValue; + } + } ); +} + +// Support: IE<9 +// Use getAttributeNode to fetch booleans when getAttribute lies +if ( !assert( function( el ) { + return el.getAttribute( "disabled" ) == null; +} ) ) { + addHandle( booleans, function( elem, name, isXML ) { + var val; + if ( !isXML ) { + return elem[ name ] === true ? name.toLowerCase() : + ( val = elem.getAttributeNode( name ) ) && val.specified ? + val.value : + null; + } + } ); +} + +return Sizzle; + +} )( window ); + + + +jQuery.find = Sizzle; +jQuery.expr = Sizzle.selectors; + +// Deprecated +jQuery.expr[ ":" ] = jQuery.expr.pseudos; +jQuery.uniqueSort = jQuery.unique = Sizzle.uniqueSort; +jQuery.text = Sizzle.getText; +jQuery.isXMLDoc = Sizzle.isXML; +jQuery.contains = Sizzle.contains; +jQuery.escapeSelector = Sizzle.escape; + + + + +var dir = function( elem, dir, until ) { + var matched = [], + truncate = until !== undefined; + + while ( ( elem = elem[ dir ] ) && elem.nodeType !== 9 ) { + if ( elem.nodeType === 1 ) { + if ( truncate && jQuery( elem ).is( until ) ) { + break; + } + matched.push( elem ); + } + } + return matched; +}; + + +var siblings = function( n, elem ) { + var matched = []; + + for ( ; n; n = n.nextSibling ) { + if ( n.nodeType === 1 && n !== elem ) { + matched.push( n ); + } + } + + return matched; +}; + + +var rneedsContext = jQuery.expr.match.needsContext; + + + +function nodeName( elem, name ) { + + return elem.nodeName && elem.nodeName.toLowerCase() === name.toLowerCase(); + +}; +var rsingleTag = ( /^<([a-z][^\/\0>:\x20\t\r\n\f]*)[\x20\t\r\n\f]*\/?>(?:<\/\1>|)$/i ); + + + +// Implement the identical functionality for filter and not +function winnow( elements, qualifier, not ) { + if ( isFunction( qualifier ) ) { + return jQuery.grep( elements, function( elem, i ) { + return !!qualifier.call( elem, i, elem ) !== not; + } ); + } + + // Single element + if ( qualifier.nodeType ) { + return jQuery.grep( elements, function( elem ) { + return ( elem === qualifier ) !== not; + } ); + } + + // Arraylike of elements (jQuery, arguments, Array) + if ( typeof qualifier !== "string" ) { + return jQuery.grep( elements, function( elem ) { + return ( indexOf.call( qualifier, elem ) > -1 ) !== not; + } ); + } + + // Filtered directly for both simple and complex selectors + return jQuery.filter( qualifier, elements, not ); +} + +jQuery.filter = function( expr, elems, not ) { + var elem = elems[ 0 ]; + + if ( not ) { + expr = ":not(" + expr + ")"; + } + + if ( elems.length === 1 && elem.nodeType === 1 ) { + return jQuery.find.matchesSelector( elem, expr ) ? [ elem ] : []; + } + + return jQuery.find.matches( expr, jQuery.grep( elems, function( elem ) { + return elem.nodeType === 1; + } ) ); +}; + +jQuery.fn.extend( { + find: function( selector ) { + var i, ret, + len = this.length, + self = this; + + if ( typeof selector !== "string" ) { + return this.pushStack( jQuery( selector ).filter( function() { + for ( i = 0; i < len; i++ ) { + if ( jQuery.contains( self[ i ], this ) ) { + return true; + } + } + } ) ); + } + + ret = this.pushStack( [] ); + + for ( i = 0; i < len; i++ ) { + jQuery.find( selector, self[ i ], ret ); + } + + return len > 1 ? jQuery.uniqueSort( ret ) : ret; + }, + filter: function( selector ) { + return this.pushStack( winnow( this, selector || [], false ) ); + }, + not: function( selector ) { + return this.pushStack( winnow( this, selector || [], true ) ); + }, + is: function( selector ) { + return !!winnow( + this, + + // If this is a positional/relative selector, check membership in the returned set + // so $("p:first").is("p:last") won't return true for a doc with two "p". + typeof selector === "string" && rneedsContext.test( selector ) ? + jQuery( selector ) : + selector || [], + false + ).length; + } +} ); + + +// Initialize a jQuery object + + +// A central reference to the root jQuery(document) +var rootjQuery, + + // A simple way to check for HTML strings + // Prioritize #id over to avoid XSS via location.hash (#9521) + // Strict HTML recognition (#11290: must start with <) + // Shortcut simple #id case for speed + rquickExpr = /^(?:\s*(<[\w\W]+>)[^>]*|#([\w-]+))$/, + + init = jQuery.fn.init = function( selector, context, root ) { + var match, elem; + + // HANDLE: $(""), $(null), $(undefined), $(false) + if ( !selector ) { + return this; + } + + // Method init() accepts an alternate rootjQuery + // so migrate can support jQuery.sub (gh-2101) + root = root || rootjQuery; + + // Handle HTML strings + if ( typeof selector === "string" ) { + if ( selector[ 0 ] === "<" && + selector[ selector.length - 1 ] === ">" && + selector.length >= 3 ) { + + // Assume that strings that start and end with <> are HTML and skip the regex check + match = [ null, selector, null ]; + + } else { + match = rquickExpr.exec( selector ); + } + + // Match html or make sure no context is specified for #id + if ( match && ( match[ 1 ] || !context ) ) { + + // HANDLE: $(html) -> $(array) + if ( match[ 1 ] ) { + context = context instanceof jQuery ? context[ 0 ] : context; + + // Option to run scripts is true for back-compat + // Intentionally let the error be thrown if parseHTML is not present + jQuery.merge( this, jQuery.parseHTML( + match[ 1 ], + context && context.nodeType ? context.ownerDocument || context : document, + true + ) ); + + // HANDLE: $(html, props) + if ( rsingleTag.test( match[ 1 ] ) && jQuery.isPlainObject( context ) ) { + for ( match in context ) { + + // Properties of context are called as methods if possible + if ( isFunction( this[ match ] ) ) { + this[ match ]( context[ match ] ); + + // ...and otherwise set as attributes + } else { + this.attr( match, context[ match ] ); + } + } + } + + return this; + + // HANDLE: $(#id) + } else { + elem = document.getElementById( match[ 2 ] ); + + if ( elem ) { + + // Inject the element directly into the jQuery object + this[ 0 ] = elem; + this.length = 1; + } + return this; + } + + // HANDLE: $(expr, $(...)) + } else if ( !context || context.jquery ) { + return ( context || root ).find( selector ); + + // HANDLE: $(expr, context) + // (which is just equivalent to: $(context).find(expr) + } else { + return this.constructor( context ).find( selector ); + } + + // HANDLE: $(DOMElement) + } else if ( selector.nodeType ) { + this[ 0 ] = selector; + this.length = 1; + return this; + + // HANDLE: $(function) + // Shortcut for document ready + } else if ( isFunction( selector ) ) { + return root.ready !== undefined ? + root.ready( selector ) : + + // Execute immediately if ready is not present + selector( jQuery ); + } + + return jQuery.makeArray( selector, this ); + }; + +// Give the init function the jQuery prototype for later instantiation +init.prototype = jQuery.fn; + +// Initialize central reference +rootjQuery = jQuery( document ); + + +var rparentsprev = /^(?:parents|prev(?:Until|All))/, + + // Methods guaranteed to produce a unique set when starting from a unique set + guaranteedUnique = { + children: true, + contents: true, + next: true, + prev: true + }; + +jQuery.fn.extend( { + has: function( target ) { + var targets = jQuery( target, this ), + l = targets.length; + + return this.filter( function() { + var i = 0; + for ( ; i < l; i++ ) { + if ( jQuery.contains( this, targets[ i ] ) ) { + return true; + } + } + } ); + }, + + closest: function( selectors, context ) { + var cur, + i = 0, + l = this.length, + matched = [], + targets = typeof selectors !== "string" && jQuery( selectors ); + + // Positional selectors never match, since there's no _selection_ context + if ( !rneedsContext.test( selectors ) ) { + for ( ; i < l; i++ ) { + for ( cur = this[ i ]; cur && cur !== context; cur = cur.parentNode ) { + + // Always skip document fragments + if ( cur.nodeType < 11 && ( targets ? + targets.index( cur ) > -1 : + + // Don't pass non-elements to Sizzle + cur.nodeType === 1 && + jQuery.find.matchesSelector( cur, selectors ) ) ) { + + matched.push( cur ); + break; + } + } + } + } + + return this.pushStack( matched.length > 1 ? jQuery.uniqueSort( matched ) : matched ); + }, + + // Determine the position of an element within the set + index: function( elem ) { + + // No argument, return index in parent + if ( !elem ) { + return ( this[ 0 ] && this[ 0 ].parentNode ) ? this.first().prevAll().length : -1; + } + + // Index in selector + if ( typeof elem === "string" ) { + return indexOf.call( jQuery( elem ), this[ 0 ] ); + } + + // Locate the position of the desired element + return indexOf.call( this, + + // If it receives a jQuery object, the first element is used + elem.jquery ? elem[ 0 ] : elem + ); + }, + + add: function( selector, context ) { + return this.pushStack( + jQuery.uniqueSort( + jQuery.merge( this.get(), jQuery( selector, context ) ) + ) + ); + }, + + addBack: function( selector ) { + return this.add( selector == null ? + this.prevObject : this.prevObject.filter( selector ) + ); + } +} ); + +function sibling( cur, dir ) { + while ( ( cur = cur[ dir ] ) && cur.nodeType !== 1 ) {} + return cur; +} + +jQuery.each( { + parent: function( elem ) { + var parent = elem.parentNode; + return parent && parent.nodeType !== 11 ? parent : null; + }, + parents: function( elem ) { + return dir( elem, "parentNode" ); + }, + parentsUntil: function( elem, _i, until ) { + return dir( elem, "parentNode", until ); + }, + next: function( elem ) { + return sibling( elem, "nextSibling" ); + }, + prev: function( elem ) { + return sibling( elem, "previousSibling" ); + }, + nextAll: function( elem ) { + return dir( elem, "nextSibling" ); + }, + prevAll: function( elem ) { + return dir( elem, "previousSibling" ); + }, + nextUntil: function( elem, _i, until ) { + return dir( elem, "nextSibling", until ); + }, + prevUntil: function( elem, _i, until ) { + return dir( elem, "previousSibling", until ); + }, + siblings: function( elem ) { + return siblings( ( elem.parentNode || {} ).firstChild, elem ); + }, + children: function( elem ) { + return siblings( elem.firstChild ); + }, + contents: function( elem ) { + if ( elem.contentDocument != null && + + // Support: IE 11+ + // elements with no `data` attribute has an object + // `contentDocument` with a `null` prototype. + getProto( elem.contentDocument ) ) { + + return elem.contentDocument; + } + + // Support: IE 9 - 11 only, iOS 7 only, Android Browser <=4.3 only + // Treat the template element as a regular one in browsers that + // don't support it. + if ( nodeName( elem, "template" ) ) { + elem = elem.content || elem; + } + + return jQuery.merge( [], elem.childNodes ); + } +}, function( name, fn ) { + jQuery.fn[ name ] = function( until, selector ) { + var matched = jQuery.map( this, fn, until ); + + if ( name.slice( -5 ) !== "Until" ) { + selector = until; + } + + if ( selector && typeof selector === "string" ) { + matched = jQuery.filter( selector, matched ); + } + + if ( this.length > 1 ) { + + // Remove duplicates + if ( !guaranteedUnique[ name ] ) { + jQuery.uniqueSort( matched ); + } + + // Reverse order for parents* and prev-derivatives + if ( rparentsprev.test( name ) ) { + matched.reverse(); + } + } + + return this.pushStack( matched ); + }; +} ); +var rnothtmlwhite = ( /[^\x20\t\r\n\f]+/g ); + + + +// Convert String-formatted options into Object-formatted ones +function createOptions( options ) { + var object = {}; + jQuery.each( options.match( rnothtmlwhite ) || [], function( _, flag ) { + object[ flag ] = true; + } ); + return object; +} + +/* + * Create a callback list using the following parameters: + * + * options: an optional list of space-separated options that will change how + * the callback list behaves or a more traditional option object + * + * By default a callback list will act like an event callback list and can be + * "fired" multiple times. + * + * Possible options: + * + * once: will ensure the callback list can only be fired once (like a Deferred) + * + * memory: will keep track of previous values and will call any callback added + * after the list has been fired right away with the latest "memorized" + * values (like a Deferred) + * + * unique: will ensure a callback can only be added once (no duplicate in the list) + * + * stopOnFalse: interrupt callings when a callback returns false + * + */ +jQuery.Callbacks = function( options ) { + + // Convert options from String-formatted to Object-formatted if needed + // (we check in cache first) + options = typeof options === "string" ? + createOptions( options ) : + jQuery.extend( {}, options ); + + var // Flag to know if list is currently firing + firing, + + // Last fire value for non-forgettable lists + memory, + + // Flag to know if list was already fired + fired, + + // Flag to prevent firing + locked, + + // Actual callback list + list = [], + + // Queue of execution data for repeatable lists + queue = [], + + // Index of currently firing callback (modified by add/remove as needed) + firingIndex = -1, + + // Fire callbacks + fire = function() { + + // Enforce single-firing + locked = locked || options.once; + + // Execute callbacks for all pending executions, + // respecting firingIndex overrides and runtime changes + fired = firing = true; + for ( ; queue.length; firingIndex = -1 ) { + memory = queue.shift(); + while ( ++firingIndex < list.length ) { + + // Run callback and check for early termination + if ( list[ firingIndex ].apply( memory[ 0 ], memory[ 1 ] ) === false && + options.stopOnFalse ) { + + // Jump to end and forget the data so .add doesn't re-fire + firingIndex = list.length; + memory = false; + } + } + } + + // Forget the data if we're done with it + if ( !options.memory ) { + memory = false; + } + + firing = false; + + // Clean up if we're done firing for good + if ( locked ) { + + // Keep an empty list if we have data for future add calls + if ( memory ) { + list = []; + + // Otherwise, this object is spent + } else { + list = ""; + } + } + }, + + // Actual Callbacks object + self = { + + // Add a callback or a collection of callbacks to the list + add: function() { + if ( list ) { + + // If we have memory from a past run, we should fire after adding + if ( memory && !firing ) { + firingIndex = list.length - 1; + queue.push( memory ); + } + + ( function add( args ) { + jQuery.each( args, function( _, arg ) { + if ( isFunction( arg ) ) { + if ( !options.unique || !self.has( arg ) ) { + list.push( arg ); + } + } else if ( arg && arg.length && toType( arg ) !== "string" ) { + + // Inspect recursively + add( arg ); + } + } ); + } )( arguments ); + + if ( memory && !firing ) { + fire(); + } + } + return this; + }, + + // Remove a callback from the list + remove: function() { + jQuery.each( arguments, function( _, arg ) { + var index; + while ( ( index = jQuery.inArray( arg, list, index ) ) > -1 ) { + list.splice( index, 1 ); + + // Handle firing indexes + if ( index <= firingIndex ) { + firingIndex--; + } + } + } ); + return this; + }, + + // Check if a given callback is in the list. + // If no argument is given, return whether or not list has callbacks attached. + has: function( fn ) { + return fn ? + jQuery.inArray( fn, list ) > -1 : + list.length > 0; + }, + + // Remove all callbacks from the list + empty: function() { + if ( list ) { + list = []; + } + return this; + }, + + // Disable .fire and .add + // Abort any current/pending executions + // Clear all callbacks and values + disable: function() { + locked = queue = []; + list = memory = ""; + return this; + }, + disabled: function() { + return !list; + }, + + // Disable .fire + // Also disable .add unless we have memory (since it would have no effect) + // Abort any pending executions + lock: function() { + locked = queue = []; + if ( !memory && !firing ) { + list = memory = ""; + } + return this; + }, + locked: function() { + return !!locked; + }, + + // Call all callbacks with the given context and arguments + fireWith: function( context, args ) { + if ( !locked ) { + args = args || []; + args = [ context, args.slice ? args.slice() : args ]; + queue.push( args ); + if ( !firing ) { + fire(); + } + } + return this; + }, + + // Call all the callbacks with the given arguments + fire: function() { + self.fireWith( this, arguments ); + return this; + }, + + // To know if the callbacks have already been called at least once + fired: function() { + return !!fired; + } + }; + + return self; +}; + + +function Identity( v ) { + return v; +} +function Thrower( ex ) { + throw ex; +} + +function adoptValue( value, resolve, reject, noValue ) { + var method; + + try { + + // Check for promise aspect first to privilege synchronous behavior + if ( value && isFunction( ( method = value.promise ) ) ) { + method.call( value ).done( resolve ).fail( reject ); + + // Other thenables + } else if ( value && isFunction( ( method = value.then ) ) ) { + method.call( value, resolve, reject ); + + // Other non-thenables + } else { + + // Control `resolve` arguments by letting Array#slice cast boolean `noValue` to integer: + // * false: [ value ].slice( 0 ) => resolve( value ) + // * true: [ value ].slice( 1 ) => resolve() + resolve.apply( undefined, [ value ].slice( noValue ) ); + } + + // For Promises/A+, convert exceptions into rejections + // Since jQuery.when doesn't unwrap thenables, we can skip the extra checks appearing in + // Deferred#then to conditionally suppress rejection. + } catch ( value ) { + + // Support: Android 4.0 only + // Strict mode functions invoked without .call/.apply get global-object context + reject.apply( undefined, [ value ] ); + } +} + +jQuery.extend( { + + Deferred: function( func ) { + var tuples = [ + + // action, add listener, callbacks, + // ... .then handlers, argument index, [final state] + [ "notify", "progress", jQuery.Callbacks( "memory" ), + jQuery.Callbacks( "memory" ), 2 ], + [ "resolve", "done", jQuery.Callbacks( "once memory" ), + jQuery.Callbacks( "once memory" ), 0, "resolved" ], + [ "reject", "fail", jQuery.Callbacks( "once memory" ), + jQuery.Callbacks( "once memory" ), 1, "rejected" ] + ], + state = "pending", + promise = { + state: function() { + return state; + }, + always: function() { + deferred.done( arguments ).fail( arguments ); + return this; + }, + "catch": function( fn ) { + return promise.then( null, fn ); + }, + + // Keep pipe for back-compat + pipe: function( /* fnDone, fnFail, fnProgress */ ) { + var fns = arguments; + + return jQuery.Deferred( function( newDefer ) { + jQuery.each( tuples, function( _i, tuple ) { + + // Map tuples (progress, done, fail) to arguments (done, fail, progress) + var fn = isFunction( fns[ tuple[ 4 ] ] ) && fns[ tuple[ 4 ] ]; + + // deferred.progress(function() { bind to newDefer or newDefer.notify }) + // deferred.done(function() { bind to newDefer or newDefer.resolve }) + // deferred.fail(function() { bind to newDefer or newDefer.reject }) + deferred[ tuple[ 1 ] ]( function() { + var returned = fn && fn.apply( this, arguments ); + if ( returned && isFunction( returned.promise ) ) { + returned.promise() + .progress( newDefer.notify ) + .done( newDefer.resolve ) + .fail( newDefer.reject ); + } else { + newDefer[ tuple[ 0 ] + "With" ]( + this, + fn ? [ returned ] : arguments + ); + } + } ); + } ); + fns = null; + } ).promise(); + }, + then: function( onFulfilled, onRejected, onProgress ) { + var maxDepth = 0; + function resolve( depth, deferred, handler, special ) { + return function() { + var that = this, + args = arguments, + mightThrow = function() { + var returned, then; + + // Support: Promises/A+ section 2.3.3.3.3 + // https://promisesaplus.com/#point-59 + // Ignore double-resolution attempts + if ( depth < maxDepth ) { + return; + } + + returned = handler.apply( that, args ); + + // Support: Promises/A+ section 2.3.1 + // https://promisesaplus.com/#point-48 + if ( returned === deferred.promise() ) { + throw new TypeError( "Thenable self-resolution" ); + } + + // Support: Promises/A+ sections 2.3.3.1, 3.5 + // https://promisesaplus.com/#point-54 + // https://promisesaplus.com/#point-75 + // Retrieve `then` only once + then = returned && + + // Support: Promises/A+ section 2.3.4 + // https://promisesaplus.com/#point-64 + // Only check objects and functions for thenability + ( typeof returned === "object" || + typeof returned === "function" ) && + returned.then; + + // Handle a returned thenable + if ( isFunction( then ) ) { + + // Special processors (notify) just wait for resolution + if ( special ) { + then.call( + returned, + resolve( maxDepth, deferred, Identity, special ), + resolve( maxDepth, deferred, Thrower, special ) + ); + + // Normal processors (resolve) also hook into progress + } else { + + // ...and disregard older resolution values + maxDepth++; + + then.call( + returned, + resolve( maxDepth, deferred, Identity, special ), + resolve( maxDepth, deferred, Thrower, special ), + resolve( maxDepth, deferred, Identity, + deferred.notifyWith ) + ); + } + + // Handle all other returned values + } else { + + // Only substitute handlers pass on context + // and multiple values (non-spec behavior) + if ( handler !== Identity ) { + that = undefined; + args = [ returned ]; + } + + // Process the value(s) + // Default process is resolve + ( special || deferred.resolveWith )( that, args ); + } + }, + + // Only normal processors (resolve) catch and reject exceptions + process = special ? + mightThrow : + function() { + try { + mightThrow(); + } catch ( e ) { + + if ( jQuery.Deferred.exceptionHook ) { + jQuery.Deferred.exceptionHook( e, + process.stackTrace ); + } + + // Support: Promises/A+ section 2.3.3.3.4.1 + // https://promisesaplus.com/#point-61 + // Ignore post-resolution exceptions + if ( depth + 1 >= maxDepth ) { + + // Only substitute handlers pass on context + // and multiple values (non-spec behavior) + if ( handler !== Thrower ) { + that = undefined; + args = [ e ]; + } + + deferred.rejectWith( that, args ); + } + } + }; + + // Support: Promises/A+ section 2.3.3.3.1 + // https://promisesaplus.com/#point-57 + // Re-resolve promises immediately to dodge false rejection from + // subsequent errors + if ( depth ) { + process(); + } else { + + // Call an optional hook to record the stack, in case of exception + // since it's otherwise lost when execution goes async + if ( jQuery.Deferred.getStackHook ) { + process.stackTrace = jQuery.Deferred.getStackHook(); + } + window.setTimeout( process ); + } + }; + } + + return jQuery.Deferred( function( newDefer ) { + + // progress_handlers.add( ... ) + tuples[ 0 ][ 3 ].add( + resolve( + 0, + newDefer, + isFunction( onProgress ) ? + onProgress : + Identity, + newDefer.notifyWith + ) + ); + + // fulfilled_handlers.add( ... ) + tuples[ 1 ][ 3 ].add( + resolve( + 0, + newDefer, + isFunction( onFulfilled ) ? + onFulfilled : + Identity + ) + ); + + // rejected_handlers.add( ... ) + tuples[ 2 ][ 3 ].add( + resolve( + 0, + newDefer, + isFunction( onRejected ) ? + onRejected : + Thrower + ) + ); + } ).promise(); + }, + + // Get a promise for this deferred + // If obj is provided, the promise aspect is added to the object + promise: function( obj ) { + return obj != null ? jQuery.extend( obj, promise ) : promise; + } + }, + deferred = {}; + + // Add list-specific methods + jQuery.each( tuples, function( i, tuple ) { + var list = tuple[ 2 ], + stateString = tuple[ 5 ]; + + // promise.progress = list.add + // promise.done = list.add + // promise.fail = list.add + promise[ tuple[ 1 ] ] = list.add; + + // Handle state + if ( stateString ) { + list.add( + function() { + + // state = "resolved" (i.e., fulfilled) + // state = "rejected" + state = stateString; + }, + + // rejected_callbacks.disable + // fulfilled_callbacks.disable + tuples[ 3 - i ][ 2 ].disable, + + // rejected_handlers.disable + // fulfilled_handlers.disable + tuples[ 3 - i ][ 3 ].disable, + + // progress_callbacks.lock + tuples[ 0 ][ 2 ].lock, + + // progress_handlers.lock + tuples[ 0 ][ 3 ].lock + ); + } + + // progress_handlers.fire + // fulfilled_handlers.fire + // rejected_handlers.fire + list.add( tuple[ 3 ].fire ); + + // deferred.notify = function() { deferred.notifyWith(...) } + // deferred.resolve = function() { deferred.resolveWith(...) } + // deferred.reject = function() { deferred.rejectWith(...) } + deferred[ tuple[ 0 ] ] = function() { + deferred[ tuple[ 0 ] + "With" ]( this === deferred ? undefined : this, arguments ); + return this; + }; + + // deferred.notifyWith = list.fireWith + // deferred.resolveWith = list.fireWith + // deferred.rejectWith = list.fireWith + deferred[ tuple[ 0 ] + "With" ] = list.fireWith; + } ); + + // Make the deferred a promise + promise.promise( deferred ); + + // Call given func if any + if ( func ) { + func.call( deferred, deferred ); + } + + // All done! + return deferred; + }, + + // Deferred helper + when: function( singleValue ) { + var + + // count of uncompleted subordinates + remaining = arguments.length, + + // count of unprocessed arguments + i = remaining, + + // subordinate fulfillment data + resolveContexts = Array( i ), + resolveValues = slice.call( arguments ), + + // the master Deferred + master = jQuery.Deferred(), + + // subordinate callback factory + updateFunc = function( i ) { + return function( value ) { + resolveContexts[ i ] = this; + resolveValues[ i ] = arguments.length > 1 ? slice.call( arguments ) : value; + if ( !( --remaining ) ) { + master.resolveWith( resolveContexts, resolveValues ); + } + }; + }; + + // Single- and empty arguments are adopted like Promise.resolve + if ( remaining <= 1 ) { + adoptValue( singleValue, master.done( updateFunc( i ) ).resolve, master.reject, + !remaining ); + + // Use .then() to unwrap secondary thenables (cf. gh-3000) + if ( master.state() === "pending" || + isFunction( resolveValues[ i ] && resolveValues[ i ].then ) ) { + + return master.then(); + } + } + + // Multiple arguments are aggregated like Promise.all array elements + while ( i-- ) { + adoptValue( resolveValues[ i ], updateFunc( i ), master.reject ); + } + + return master.promise(); + } +} ); + + +// These usually indicate a programmer mistake during development, +// warn about them ASAP rather than swallowing them by default. +var rerrorNames = /^(Eval|Internal|Range|Reference|Syntax|Type|URI)Error$/; + +jQuery.Deferred.exceptionHook = function( error, stack ) { + + // Support: IE 8 - 9 only + // Console exists when dev tools are open, which can happen at any time + if ( window.console && window.console.warn && error && rerrorNames.test( error.name ) ) { + window.console.warn( "jQuery.Deferred exception: " + error.message, error.stack, stack ); + } +}; + + + + +jQuery.readyException = function( error ) { + window.setTimeout( function() { + throw error; + } ); +}; + + + + +// The deferred used on DOM ready +var readyList = jQuery.Deferred(); + +jQuery.fn.ready = function( fn ) { + + readyList + .then( fn ) + + // Wrap jQuery.readyException in a function so that the lookup + // happens at the time of error handling instead of callback + // registration. + .catch( function( error ) { + jQuery.readyException( error ); + } ); + + return this; +}; + +jQuery.extend( { + + // Is the DOM ready to be used? Set to true once it occurs. + isReady: false, + + // A counter to track how many items to wait for before + // the ready event fires. See #6781 + readyWait: 1, + + // Handle when the DOM is ready + ready: function( wait ) { + + // Abort if there are pending holds or we're already ready + if ( wait === true ? --jQuery.readyWait : jQuery.isReady ) { + return; + } + + // Remember that the DOM is ready + jQuery.isReady = true; + + // If a normal DOM Ready event fired, decrement, and wait if need be + if ( wait !== true && --jQuery.readyWait > 0 ) { + return; + } + + // If there are functions bound, to execute + readyList.resolveWith( document, [ jQuery ] ); + } +} ); + +jQuery.ready.then = readyList.then; + +// The ready event handler and self cleanup method +function completed() { + document.removeEventListener( "DOMContentLoaded", completed ); + window.removeEventListener( "load", completed ); + jQuery.ready(); +} + +// Catch cases where $(document).ready() is called +// after the browser event has already occurred. +// Support: IE <=9 - 10 only +// Older IE sometimes signals "interactive" too soon +if ( document.readyState === "complete" || + ( document.readyState !== "loading" && !document.documentElement.doScroll ) ) { + + // Handle it asynchronously to allow scripts the opportunity to delay ready + window.setTimeout( jQuery.ready ); + +} else { + + // Use the handy event callback + document.addEventListener( "DOMContentLoaded", completed ); + + // A fallback to window.onload, that will always work + window.addEventListener( "load", completed ); +} + + + + +// Multifunctional method to get and set values of a collection +// The value/s can optionally be executed if it's a function +var access = function( elems, fn, key, value, chainable, emptyGet, raw ) { + var i = 0, + len = elems.length, + bulk = key == null; + + // Sets many values + if ( toType( key ) === "object" ) { + chainable = true; + for ( i in key ) { + access( elems, fn, i, key[ i ], true, emptyGet, raw ); + } + + // Sets one value + } else if ( value !== undefined ) { + chainable = true; + + if ( !isFunction( value ) ) { + raw = true; + } + + if ( bulk ) { + + // Bulk operations run against the entire set + if ( raw ) { + fn.call( elems, value ); + fn = null; + + // ...except when executing function values + } else { + bulk = fn; + fn = function( elem, _key, value ) { + return bulk.call( jQuery( elem ), value ); + }; + } + } + + if ( fn ) { + for ( ; i < len; i++ ) { + fn( + elems[ i ], key, raw ? + value : + value.call( elems[ i ], i, fn( elems[ i ], key ) ) + ); + } + } + } + + if ( chainable ) { + return elems; + } + + // Gets + if ( bulk ) { + return fn.call( elems ); + } + + return len ? fn( elems[ 0 ], key ) : emptyGet; +}; + + +// Matches dashed string for camelizing +var rmsPrefix = /^-ms-/, + rdashAlpha = /-([a-z])/g; + +// Used by camelCase as callback to replace() +function fcamelCase( _all, letter ) { + return letter.toUpperCase(); +} + +// Convert dashed to camelCase; used by the css and data modules +// Support: IE <=9 - 11, Edge 12 - 15 +// Microsoft forgot to hump their vendor prefix (#9572) +function camelCase( string ) { + return string.replace( rmsPrefix, "ms-" ).replace( rdashAlpha, fcamelCase ); +} +var acceptData = function( owner ) { + + // Accepts only: + // - Node + // - Node.ELEMENT_NODE + // - Node.DOCUMENT_NODE + // - Object + // - Any + return owner.nodeType === 1 || owner.nodeType === 9 || !( +owner.nodeType ); +}; + + + + +function Data() { + this.expando = jQuery.expando + Data.uid++; +} + +Data.uid = 1; + +Data.prototype = { + + cache: function( owner ) { + + // Check if the owner object already has a cache + var value = owner[ this.expando ]; + + // If not, create one + if ( !value ) { + value = {}; + + // We can accept data for non-element nodes in modern browsers, + // but we should not, see #8335. + // Always return an empty object. + if ( acceptData( owner ) ) { + + // If it is a node unlikely to be stringify-ed or looped over + // use plain assignment + if ( owner.nodeType ) { + owner[ this.expando ] = value; + + // Otherwise secure it in a non-enumerable property + // configurable must be true to allow the property to be + // deleted when data is removed + } else { + Object.defineProperty( owner, this.expando, { + value: value, + configurable: true + } ); + } + } + } + + return value; + }, + set: function( owner, data, value ) { + var prop, + cache = this.cache( owner ); + + // Handle: [ owner, key, value ] args + // Always use camelCase key (gh-2257) + if ( typeof data === "string" ) { + cache[ camelCase( data ) ] = value; + + // Handle: [ owner, { properties } ] args + } else { + + // Copy the properties one-by-one to the cache object + for ( prop in data ) { + cache[ camelCase( prop ) ] = data[ prop ]; + } + } + return cache; + }, + get: function( owner, key ) { + return key === undefined ? + this.cache( owner ) : + + // Always use camelCase key (gh-2257) + owner[ this.expando ] && owner[ this.expando ][ camelCase( key ) ]; + }, + access: function( owner, key, value ) { + + // In cases where either: + // + // 1. No key was specified + // 2. A string key was specified, but no value provided + // + // Take the "read" path and allow the get method to determine + // which value to return, respectively either: + // + // 1. The entire cache object + // 2. The data stored at the key + // + if ( key === undefined || + ( ( key && typeof key === "string" ) && value === undefined ) ) { + + return this.get( owner, key ); + } + + // When the key is not a string, or both a key and value + // are specified, set or extend (existing objects) with either: + // + // 1. An object of properties + // 2. A key and value + // + this.set( owner, key, value ); + + // Since the "set" path can have two possible entry points + // return the expected data based on which path was taken[*] + return value !== undefined ? value : key; + }, + remove: function( owner, key ) { + var i, + cache = owner[ this.expando ]; + + if ( cache === undefined ) { + return; + } + + if ( key !== undefined ) { + + // Support array or space separated string of keys + if ( Array.isArray( key ) ) { + + // If key is an array of keys... + // We always set camelCase keys, so remove that. + key = key.map( camelCase ); + } else { + key = camelCase( key ); + + // If a key with the spaces exists, use it. + // Otherwise, create an array by matching non-whitespace + key = key in cache ? + [ key ] : + ( key.match( rnothtmlwhite ) || [] ); + } + + i = key.length; + + while ( i-- ) { + delete cache[ key[ i ] ]; + } + } + + // Remove the expando if there's no more data + if ( key === undefined || jQuery.isEmptyObject( cache ) ) { + + // Support: Chrome <=35 - 45 + // Webkit & Blink performance suffers when deleting properties + // from DOM nodes, so set to undefined instead + // https://bugs.chromium.org/p/chromium/issues/detail?id=378607 (bug restricted) + if ( owner.nodeType ) { + owner[ this.expando ] = undefined; + } else { + delete owner[ this.expando ]; + } + } + }, + hasData: function( owner ) { + var cache = owner[ this.expando ]; + return cache !== undefined && !jQuery.isEmptyObject( cache ); + } +}; +var dataPriv = new Data(); + +var dataUser = new Data(); + + + +// Implementation Summary +// +// 1. Enforce API surface and semantic compatibility with 1.9.x branch +// 2. Improve the module's maintainability by reducing the storage +// paths to a single mechanism. +// 3. Use the same single mechanism to support "private" and "user" data. +// 4. _Never_ expose "private" data to user code (TODO: Drop _data, _removeData) +// 5. Avoid exposing implementation details on user objects (eg. expando properties) +// 6. Provide a clear path for implementation upgrade to WeakMap in 2014 + +var rbrace = /^(?:\{[\w\W]*\}|\[[\w\W]*\])$/, + rmultiDash = /[A-Z]/g; + +function getData( data ) { + if ( data === "true" ) { + return true; + } + + if ( data === "false" ) { + return false; + } + + if ( data === "null" ) { + return null; + } + + // Only convert to a number if it doesn't change the string + if ( data === +data + "" ) { + return +data; + } + + if ( rbrace.test( data ) ) { + return JSON.parse( data ); + } + + return data; +} + +function dataAttr( elem, key, data ) { + var name; + + // If nothing was found internally, try to fetch any + // data from the HTML5 data-* attribute + if ( data === undefined && elem.nodeType === 1 ) { + name = "data-" + key.replace( rmultiDash, "-$&" ).toLowerCase(); + data = elem.getAttribute( name ); + + if ( typeof data === "string" ) { + try { + data = getData( data ); + } catch ( e ) {} + + // Make sure we set the data so it isn't changed later + dataUser.set( elem, key, data ); + } else { + data = undefined; + } + } + return data; +} + +jQuery.extend( { + hasData: function( elem ) { + return dataUser.hasData( elem ) || dataPriv.hasData( elem ); + }, + + data: function( elem, name, data ) { + return dataUser.access( elem, name, data ); + }, + + removeData: function( elem, name ) { + dataUser.remove( elem, name ); + }, + + // TODO: Now that all calls to _data and _removeData have been replaced + // with direct calls to dataPriv methods, these can be deprecated. + _data: function( elem, name, data ) { + return dataPriv.access( elem, name, data ); + }, + + _removeData: function( elem, name ) { + dataPriv.remove( elem, name ); + } +} ); + +jQuery.fn.extend( { + data: function( key, value ) { + var i, name, data, + elem = this[ 0 ], + attrs = elem && elem.attributes; + + // Gets all values + if ( key === undefined ) { + if ( this.length ) { + data = dataUser.get( elem ); + + if ( elem.nodeType === 1 && !dataPriv.get( elem, "hasDataAttrs" ) ) { + i = attrs.length; + while ( i-- ) { + + // Support: IE 11 only + // The attrs elements can be null (#14894) + if ( attrs[ i ] ) { + name = attrs[ i ].name; + if ( name.indexOf( "data-" ) === 0 ) { + name = camelCase( name.slice( 5 ) ); + dataAttr( elem, name, data[ name ] ); + } + } + } + dataPriv.set( elem, "hasDataAttrs", true ); + } + } + + return data; + } + + // Sets multiple values + if ( typeof key === "object" ) { + return this.each( function() { + dataUser.set( this, key ); + } ); + } + + return access( this, function( value ) { + var data; + + // The calling jQuery object (element matches) is not empty + // (and therefore has an element appears at this[ 0 ]) and the + // `value` parameter was not undefined. An empty jQuery object + // will result in `undefined` for elem = this[ 0 ] which will + // throw an exception if an attempt to read a data cache is made. + if ( elem && value === undefined ) { + + // Attempt to get data from the cache + // The key will always be camelCased in Data + data = dataUser.get( elem, key ); + if ( data !== undefined ) { + return data; + } + + // Attempt to "discover" the data in + // HTML5 custom data-* attrs + data = dataAttr( elem, key ); + if ( data !== undefined ) { + return data; + } + + // We tried really hard, but the data doesn't exist. + return; + } + + // Set the data... + this.each( function() { + + // We always store the camelCased key + dataUser.set( this, key, value ); + } ); + }, null, value, arguments.length > 1, null, true ); + }, + + removeData: function( key ) { + return this.each( function() { + dataUser.remove( this, key ); + } ); + } +} ); + + +jQuery.extend( { + queue: function( elem, type, data ) { + var queue; + + if ( elem ) { + type = ( type || "fx" ) + "queue"; + queue = dataPriv.get( elem, type ); + + // Speed up dequeue by getting out quickly if this is just a lookup + if ( data ) { + if ( !queue || Array.isArray( data ) ) { + queue = dataPriv.access( elem, type, jQuery.makeArray( data ) ); + } else { + queue.push( data ); + } + } + return queue || []; + } + }, + + dequeue: function( elem, type ) { + type = type || "fx"; + + var queue = jQuery.queue( elem, type ), + startLength = queue.length, + fn = queue.shift(), + hooks = jQuery._queueHooks( elem, type ), + next = function() { + jQuery.dequeue( elem, type ); + }; + + // If the fx queue is dequeued, always remove the progress sentinel + if ( fn === "inprogress" ) { + fn = queue.shift(); + startLength--; + } + + if ( fn ) { + + // Add a progress sentinel to prevent the fx queue from being + // automatically dequeued + if ( type === "fx" ) { + queue.unshift( "inprogress" ); + } + + // Clear up the last queue stop function + delete hooks.stop; + fn.call( elem, next, hooks ); + } + + if ( !startLength && hooks ) { + hooks.empty.fire(); + } + }, + + // Not public - generate a queueHooks object, or return the current one + _queueHooks: function( elem, type ) { + var key = type + "queueHooks"; + return dataPriv.get( elem, key ) || dataPriv.access( elem, key, { + empty: jQuery.Callbacks( "once memory" ).add( function() { + dataPriv.remove( elem, [ type + "queue", key ] ); + } ) + } ); + } +} ); + +jQuery.fn.extend( { + queue: function( type, data ) { + var setter = 2; + + if ( typeof type !== "string" ) { + data = type; + type = "fx"; + setter--; + } + + if ( arguments.length < setter ) { + return jQuery.queue( this[ 0 ], type ); + } + + return data === undefined ? + this : + this.each( function() { + var queue = jQuery.queue( this, type, data ); + + // Ensure a hooks for this queue + jQuery._queueHooks( this, type ); + + if ( type === "fx" && queue[ 0 ] !== "inprogress" ) { + jQuery.dequeue( this, type ); + } + } ); + }, + dequeue: function( type ) { + return this.each( function() { + jQuery.dequeue( this, type ); + } ); + }, + clearQueue: function( type ) { + return this.queue( type || "fx", [] ); + }, + + // Get a promise resolved when queues of a certain type + // are emptied (fx is the type by default) + promise: function( type, obj ) { + var tmp, + count = 1, + defer = jQuery.Deferred(), + elements = this, + i = this.length, + resolve = function() { + if ( !( --count ) ) { + defer.resolveWith( elements, [ elements ] ); + } + }; + + if ( typeof type !== "string" ) { + obj = type; + type = undefined; + } + type = type || "fx"; + + while ( i-- ) { + tmp = dataPriv.get( elements[ i ], type + "queueHooks" ); + if ( tmp && tmp.empty ) { + count++; + tmp.empty.add( resolve ); + } + } + resolve(); + return defer.promise( obj ); + } +} ); +var pnum = ( /[+-]?(?:\d*\.|)\d+(?:[eE][+-]?\d+|)/ ).source; + +var rcssNum = new RegExp( "^(?:([+-])=|)(" + pnum + ")([a-z%]*)$", "i" ); + + +var cssExpand = [ "Top", "Right", "Bottom", "Left" ]; + +var documentElement = document.documentElement; + + + + var isAttached = function( elem ) { + return jQuery.contains( elem.ownerDocument, elem ); + }, + composed = { composed: true }; + + // Support: IE 9 - 11+, Edge 12 - 18+, iOS 10.0 - 10.2 only + // Check attachment across shadow DOM boundaries when possible (gh-3504) + // Support: iOS 10.0-10.2 only + // Early iOS 10 versions support `attachShadow` but not `getRootNode`, + // leading to errors. We need to check for `getRootNode`. + if ( documentElement.getRootNode ) { + isAttached = function( elem ) { + return jQuery.contains( elem.ownerDocument, elem ) || + elem.getRootNode( composed ) === elem.ownerDocument; + }; + } +var isHiddenWithinTree = function( elem, el ) { + + // isHiddenWithinTree might be called from jQuery#filter function; + // in that case, element will be second argument + elem = el || elem; + + // Inline style trumps all + return elem.style.display === "none" || + elem.style.display === "" && + + // Otherwise, check computed style + // Support: Firefox <=43 - 45 + // Disconnected elements can have computed display: none, so first confirm that elem is + // in the document. + isAttached( elem ) && + + jQuery.css( elem, "display" ) === "none"; + }; + + + +function adjustCSS( elem, prop, valueParts, tween ) { + var adjusted, scale, + maxIterations = 20, + currentValue = tween ? + function() { + return tween.cur(); + } : + function() { + return jQuery.css( elem, prop, "" ); + }, + initial = currentValue(), + unit = valueParts && valueParts[ 3 ] || ( jQuery.cssNumber[ prop ] ? "" : "px" ), + + // Starting value computation is required for potential unit mismatches + initialInUnit = elem.nodeType && + ( jQuery.cssNumber[ prop ] || unit !== "px" && +initial ) && + rcssNum.exec( jQuery.css( elem, prop ) ); + + if ( initialInUnit && initialInUnit[ 3 ] !== unit ) { + + // Support: Firefox <=54 + // Halve the iteration target value to prevent interference from CSS upper bounds (gh-2144) + initial = initial / 2; + + // Trust units reported by jQuery.css + unit = unit || initialInUnit[ 3 ]; + + // Iteratively approximate from a nonzero starting point + initialInUnit = +initial || 1; + + while ( maxIterations-- ) { + + // Evaluate and update our best guess (doubling guesses that zero out). + // Finish if the scale equals or crosses 1 (making the old*new product non-positive). + jQuery.style( elem, prop, initialInUnit + unit ); + if ( ( 1 - scale ) * ( 1 - ( scale = currentValue() / initial || 0.5 ) ) <= 0 ) { + maxIterations = 0; + } + initialInUnit = initialInUnit / scale; + + } + + initialInUnit = initialInUnit * 2; + jQuery.style( elem, prop, initialInUnit + unit ); + + // Make sure we update the tween properties later on + valueParts = valueParts || []; + } + + if ( valueParts ) { + initialInUnit = +initialInUnit || +initial || 0; + + // Apply relative offset (+=/-=) if specified + adjusted = valueParts[ 1 ] ? + initialInUnit + ( valueParts[ 1 ] + 1 ) * valueParts[ 2 ] : + +valueParts[ 2 ]; + if ( tween ) { + tween.unit = unit; + tween.start = initialInUnit; + tween.end = adjusted; + } + } + return adjusted; +} + + +var defaultDisplayMap = {}; + +function getDefaultDisplay( elem ) { + var temp, + doc = elem.ownerDocument, + nodeName = elem.nodeName, + display = defaultDisplayMap[ nodeName ]; + + if ( display ) { + return display; + } + + temp = doc.body.appendChild( doc.createElement( nodeName ) ); + display = jQuery.css( temp, "display" ); + + temp.parentNode.removeChild( temp ); + + if ( display === "none" ) { + display = "block"; + } + defaultDisplayMap[ nodeName ] = display; + + return display; +} + +function showHide( elements, show ) { + var display, elem, + values = [], + index = 0, + length = elements.length; + + // Determine new display value for elements that need to change + for ( ; index < length; index++ ) { + elem = elements[ index ]; + if ( !elem.style ) { + continue; + } + + display = elem.style.display; + if ( show ) { + + // Since we force visibility upon cascade-hidden elements, an immediate (and slow) + // check is required in this first loop unless we have a nonempty display value (either + // inline or about-to-be-restored) + if ( display === "none" ) { + values[ index ] = dataPriv.get( elem, "display" ) || null; + if ( !values[ index ] ) { + elem.style.display = ""; + } + } + if ( elem.style.display === "" && isHiddenWithinTree( elem ) ) { + values[ index ] = getDefaultDisplay( elem ); + } + } else { + if ( display !== "none" ) { + values[ index ] = "none"; + + // Remember what we're overwriting + dataPriv.set( elem, "display", display ); + } + } + } + + // Set the display of the elements in a second loop to avoid constant reflow + for ( index = 0; index < length; index++ ) { + if ( values[ index ] != null ) { + elements[ index ].style.display = values[ index ]; + } + } + + return elements; +} + +jQuery.fn.extend( { + show: function() { + return showHide( this, true ); + }, + hide: function() { + return showHide( this ); + }, + toggle: function( state ) { + if ( typeof state === "boolean" ) { + return state ? this.show() : this.hide(); + } + + return this.each( function() { + if ( isHiddenWithinTree( this ) ) { + jQuery( this ).show(); + } else { + jQuery( this ).hide(); + } + } ); + } +} ); +var rcheckableType = ( /^(?:checkbox|radio)$/i ); + +var rtagName = ( /<([a-z][^\/\0>\x20\t\r\n\f]*)/i ); + +var rscriptType = ( /^$|^module$|\/(?:java|ecma)script/i ); + + + +( function() { + var fragment = document.createDocumentFragment(), + div = fragment.appendChild( document.createElement( "div" ) ), + input = document.createElement( "input" ); + + // Support: Android 4.0 - 4.3 only + // Check state lost if the name is set (#11217) + // Support: Windows Web Apps (WWA) + // `name` and `type` must use .setAttribute for WWA (#14901) + input.setAttribute( "type", "radio" ); + input.setAttribute( "checked", "checked" ); + input.setAttribute( "name", "t" ); + + div.appendChild( input ); + + // Support: Android <=4.1 only + // Older WebKit doesn't clone checked state correctly in fragments + support.checkClone = div.cloneNode( true ).cloneNode( true ).lastChild.checked; + + // Support: IE <=11 only + // Make sure textarea (and checkbox) defaultValue is properly cloned + div.innerHTML = ""; + support.noCloneChecked = !!div.cloneNode( true ).lastChild.defaultValue; + + // Support: IE <=9 only + // IE <=9 replaces "; + support.option = !!div.lastChild; +} )(); + + +// We have to close these tags to support XHTML (#13200) +var wrapMap = { + + // XHTML parsers do not magically insert elements in the + // same way that tag soup parsers do. So we cannot shorten + // this by omitting or other required elements. + thead: [ 1, "", "
" ], + col: [ 2, "", "
" ], + tr: [ 2, "", "
" ], + td: [ 3, "", "
" ], + + _default: [ 0, "", "" ] +}; + +wrapMap.tbody = wrapMap.tfoot = wrapMap.colgroup = wrapMap.caption = wrapMap.thead; +wrapMap.th = wrapMap.td; + +// Support: IE <=9 only +if ( !support.option ) { + wrapMap.optgroup = wrapMap.option = [ 1, "" ]; +} + + +function getAll( context, tag ) { + + // Support: IE <=9 - 11 only + // Use typeof to avoid zero-argument method invocation on host objects (#15151) + var ret; + + if ( typeof context.getElementsByTagName !== "undefined" ) { + ret = context.getElementsByTagName( tag || "*" ); + + } else if ( typeof context.querySelectorAll !== "undefined" ) { + ret = context.querySelectorAll( tag || "*" ); + + } else { + ret = []; + } + + if ( tag === undefined || tag && nodeName( context, tag ) ) { + return jQuery.merge( [ context ], ret ); + } + + return ret; +} + + +// Mark scripts as having already been evaluated +function setGlobalEval( elems, refElements ) { + var i = 0, + l = elems.length; + + for ( ; i < l; i++ ) { + dataPriv.set( + elems[ i ], + "globalEval", + !refElements || dataPriv.get( refElements[ i ], "globalEval" ) + ); + } +} + + +var rhtml = /<|&#?\w+;/; + +function buildFragment( elems, context, scripts, selection, ignored ) { + var elem, tmp, tag, wrap, attached, j, + fragment = context.createDocumentFragment(), + nodes = [], + i = 0, + l = elems.length; + + for ( ; i < l; i++ ) { + elem = elems[ i ]; + + if ( elem || elem === 0 ) { + + // Add nodes directly + if ( toType( elem ) === "object" ) { + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + jQuery.merge( nodes, elem.nodeType ? [ elem ] : elem ); + + // Convert non-html into a text node + } else if ( !rhtml.test( elem ) ) { + nodes.push( context.createTextNode( elem ) ); + + // Convert html into DOM nodes + } else { + tmp = tmp || fragment.appendChild( context.createElement( "div" ) ); + + // Deserialize a standard representation + tag = ( rtagName.exec( elem ) || [ "", "" ] )[ 1 ].toLowerCase(); + wrap = wrapMap[ tag ] || wrapMap._default; + tmp.innerHTML = wrap[ 1 ] + jQuery.htmlPrefilter( elem ) + wrap[ 2 ]; + + // Descend through wrappers to the right content + j = wrap[ 0 ]; + while ( j-- ) { + tmp = tmp.lastChild; + } + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + jQuery.merge( nodes, tmp.childNodes ); + + // Remember the top-level container + tmp = fragment.firstChild; + + // Ensure the created nodes are orphaned (#12392) + tmp.textContent = ""; + } + } + } + + // Remove wrapper from fragment + fragment.textContent = ""; + + i = 0; + while ( ( elem = nodes[ i++ ] ) ) { + + // Skip elements already in the context collection (trac-4087) + if ( selection && jQuery.inArray( elem, selection ) > -1 ) { + if ( ignored ) { + ignored.push( elem ); + } + continue; + } + + attached = isAttached( elem ); + + // Append to fragment + tmp = getAll( fragment.appendChild( elem ), "script" ); + + // Preserve script evaluation history + if ( attached ) { + setGlobalEval( tmp ); + } + + // Capture executables + if ( scripts ) { + j = 0; + while ( ( elem = tmp[ j++ ] ) ) { + if ( rscriptType.test( elem.type || "" ) ) { + scripts.push( elem ); + } + } + } + } + + return fragment; +} + + +var + rkeyEvent = /^key/, + rmouseEvent = /^(?:mouse|pointer|contextmenu|drag|drop)|click/, + rtypenamespace = /^([^.]*)(?:\.(.+)|)/; + +function returnTrue() { + return true; +} + +function returnFalse() { + return false; +} + +// Support: IE <=9 - 11+ +// focus() and blur() are asynchronous, except when they are no-op. +// So expect focus to be synchronous when the element is already active, +// and blur to be synchronous when the element is not already active. +// (focus and blur are always synchronous in other supported browsers, +// this just defines when we can count on it). +function expectSync( elem, type ) { + return ( elem === safeActiveElement() ) === ( type === "focus" ); +} + +// Support: IE <=9 only +// Accessing document.activeElement can throw unexpectedly +// https://bugs.jquery.com/ticket/13393 +function safeActiveElement() { + try { + return document.activeElement; + } catch ( err ) { } +} + +function on( elem, types, selector, data, fn, one ) { + var origFn, type; + + // Types can be a map of types/handlers + if ( typeof types === "object" ) { + + // ( types-Object, selector, data ) + if ( typeof selector !== "string" ) { + + // ( types-Object, data ) + data = data || selector; + selector = undefined; + } + for ( type in types ) { + on( elem, type, selector, data, types[ type ], one ); + } + return elem; + } + + if ( data == null && fn == null ) { + + // ( types, fn ) + fn = selector; + data = selector = undefined; + } else if ( fn == null ) { + if ( typeof selector === "string" ) { + + // ( types, selector, fn ) + fn = data; + data = undefined; + } else { + + // ( types, data, fn ) + fn = data; + data = selector; + selector = undefined; + } + } + if ( fn === false ) { + fn = returnFalse; + } else if ( !fn ) { + return elem; + } + + if ( one === 1 ) { + origFn = fn; + fn = function( event ) { + + // Can use an empty set, since event contains the info + jQuery().off( event ); + return origFn.apply( this, arguments ); + }; + + // Use same guid so caller can remove using origFn + fn.guid = origFn.guid || ( origFn.guid = jQuery.guid++ ); + } + return elem.each( function() { + jQuery.event.add( this, types, fn, data, selector ); + } ); +} + +/* + * Helper functions for managing events -- not part of the public interface. + * Props to Dean Edwards' addEvent library for many of the ideas. + */ +jQuery.event = { + + global: {}, + + add: function( elem, types, handler, data, selector ) { + + var handleObjIn, eventHandle, tmp, + events, t, handleObj, + special, handlers, type, namespaces, origType, + elemData = dataPriv.get( elem ); + + // Only attach events to objects that accept data + if ( !acceptData( elem ) ) { + return; + } + + // Caller can pass in an object of custom data in lieu of the handler + if ( handler.handler ) { + handleObjIn = handler; + handler = handleObjIn.handler; + selector = handleObjIn.selector; + } + + // Ensure that invalid selectors throw exceptions at attach time + // Evaluate against documentElement in case elem is a non-element node (e.g., document) + if ( selector ) { + jQuery.find.matchesSelector( documentElement, selector ); + } + + // Make sure that the handler has a unique ID, used to find/remove it later + if ( !handler.guid ) { + handler.guid = jQuery.guid++; + } + + // Init the element's event structure and main handler, if this is the first + if ( !( events = elemData.events ) ) { + events = elemData.events = Object.create( null ); + } + if ( !( eventHandle = elemData.handle ) ) { + eventHandle = elemData.handle = function( e ) { + + // Discard the second event of a jQuery.event.trigger() and + // when an event is called after a page has unloaded + return typeof jQuery !== "undefined" && jQuery.event.triggered !== e.type ? + jQuery.event.dispatch.apply( elem, arguments ) : undefined; + }; + } + + // Handle multiple events separated by a space + types = ( types || "" ).match( rnothtmlwhite ) || [ "" ]; + t = types.length; + while ( t-- ) { + tmp = rtypenamespace.exec( types[ t ] ) || []; + type = origType = tmp[ 1 ]; + namespaces = ( tmp[ 2 ] || "" ).split( "." ).sort(); + + // There *must* be a type, no attaching namespace-only handlers + if ( !type ) { + continue; + } + + // If event changes its type, use the special event handlers for the changed type + special = jQuery.event.special[ type ] || {}; + + // If selector defined, determine special event api type, otherwise given type + type = ( selector ? special.delegateType : special.bindType ) || type; + + // Update special based on newly reset type + special = jQuery.event.special[ type ] || {}; + + // handleObj is passed to all event handlers + handleObj = jQuery.extend( { + type: type, + origType: origType, + data: data, + handler: handler, + guid: handler.guid, + selector: selector, + needsContext: selector && jQuery.expr.match.needsContext.test( selector ), + namespace: namespaces.join( "." ) + }, handleObjIn ); + + // Init the event handler queue if we're the first + if ( !( handlers = events[ type ] ) ) { + handlers = events[ type ] = []; + handlers.delegateCount = 0; + + // Only use addEventListener if the special events handler returns false + if ( !special.setup || + special.setup.call( elem, data, namespaces, eventHandle ) === false ) { + + if ( elem.addEventListener ) { + elem.addEventListener( type, eventHandle ); + } + } + } + + if ( special.add ) { + special.add.call( elem, handleObj ); + + if ( !handleObj.handler.guid ) { + handleObj.handler.guid = handler.guid; + } + } + + // Add to the element's handler list, delegates in front + if ( selector ) { + handlers.splice( handlers.delegateCount++, 0, handleObj ); + } else { + handlers.push( handleObj ); + } + + // Keep track of which events have ever been used, for event optimization + jQuery.event.global[ type ] = true; + } + + }, + + // Detach an event or set of events from an element + remove: function( elem, types, handler, selector, mappedTypes ) { + + var j, origCount, tmp, + events, t, handleObj, + special, handlers, type, namespaces, origType, + elemData = dataPriv.hasData( elem ) && dataPriv.get( elem ); + + if ( !elemData || !( events = elemData.events ) ) { + return; + } + + // Once for each type.namespace in types; type may be omitted + types = ( types || "" ).match( rnothtmlwhite ) || [ "" ]; + t = types.length; + while ( t-- ) { + tmp = rtypenamespace.exec( types[ t ] ) || []; + type = origType = tmp[ 1 ]; + namespaces = ( tmp[ 2 ] || "" ).split( "." ).sort(); + + // Unbind all events (on this namespace, if provided) for the element + if ( !type ) { + for ( type in events ) { + jQuery.event.remove( elem, type + types[ t ], handler, selector, true ); + } + continue; + } + + special = jQuery.event.special[ type ] || {}; + type = ( selector ? special.delegateType : special.bindType ) || type; + handlers = events[ type ] || []; + tmp = tmp[ 2 ] && + new RegExp( "(^|\\.)" + namespaces.join( "\\.(?:.*\\.|)" ) + "(\\.|$)" ); + + // Remove matching events + origCount = j = handlers.length; + while ( j-- ) { + handleObj = handlers[ j ]; + + if ( ( mappedTypes || origType === handleObj.origType ) && + ( !handler || handler.guid === handleObj.guid ) && + ( !tmp || tmp.test( handleObj.namespace ) ) && + ( !selector || selector === handleObj.selector || + selector === "**" && handleObj.selector ) ) { + handlers.splice( j, 1 ); + + if ( handleObj.selector ) { + handlers.delegateCount--; + } + if ( special.remove ) { + special.remove.call( elem, handleObj ); + } + } + } + + // Remove generic event handler if we removed something and no more handlers exist + // (avoids potential for endless recursion during removal of special event handlers) + if ( origCount && !handlers.length ) { + if ( !special.teardown || + special.teardown.call( elem, namespaces, elemData.handle ) === false ) { + + jQuery.removeEvent( elem, type, elemData.handle ); + } + + delete events[ type ]; + } + } + + // Remove data and the expando if it's no longer used + if ( jQuery.isEmptyObject( events ) ) { + dataPriv.remove( elem, "handle events" ); + } + }, + + dispatch: function( nativeEvent ) { + + var i, j, ret, matched, handleObj, handlerQueue, + args = new Array( arguments.length ), + + // Make a writable jQuery.Event from the native event object + event = jQuery.event.fix( nativeEvent ), + + handlers = ( + dataPriv.get( this, "events" ) || Object.create( null ) + )[ event.type ] || [], + special = jQuery.event.special[ event.type ] || {}; + + // Use the fix-ed jQuery.Event rather than the (read-only) native event + args[ 0 ] = event; + + for ( i = 1; i < arguments.length; i++ ) { + args[ i ] = arguments[ i ]; + } + + event.delegateTarget = this; + + // Call the preDispatch hook for the mapped type, and let it bail if desired + if ( special.preDispatch && special.preDispatch.call( this, event ) === false ) { + return; + } + + // Determine handlers + handlerQueue = jQuery.event.handlers.call( this, event, handlers ); + + // Run delegates first; they may want to stop propagation beneath us + i = 0; + while ( ( matched = handlerQueue[ i++ ] ) && !event.isPropagationStopped() ) { + event.currentTarget = matched.elem; + + j = 0; + while ( ( handleObj = matched.handlers[ j++ ] ) && + !event.isImmediatePropagationStopped() ) { + + // If the event is namespaced, then each handler is only invoked if it is + // specially universal or its namespaces are a superset of the event's. + if ( !event.rnamespace || handleObj.namespace === false || + event.rnamespace.test( handleObj.namespace ) ) { + + event.handleObj = handleObj; + event.data = handleObj.data; + + ret = ( ( jQuery.event.special[ handleObj.origType ] || {} ).handle || + handleObj.handler ).apply( matched.elem, args ); + + if ( ret !== undefined ) { + if ( ( event.result = ret ) === false ) { + event.preventDefault(); + event.stopPropagation(); + } + } + } + } + } + + // Call the postDispatch hook for the mapped type + if ( special.postDispatch ) { + special.postDispatch.call( this, event ); + } + + return event.result; + }, + + handlers: function( event, handlers ) { + var i, handleObj, sel, matchedHandlers, matchedSelectors, + handlerQueue = [], + delegateCount = handlers.delegateCount, + cur = event.target; + + // Find delegate handlers + if ( delegateCount && + + // Support: IE <=9 + // Black-hole SVG instance trees (trac-13180) + cur.nodeType && + + // Support: Firefox <=42 + // Suppress spec-violating clicks indicating a non-primary pointer button (trac-3861) + // https://www.w3.org/TR/DOM-Level-3-Events/#event-type-click + // Support: IE 11 only + // ...but not arrow key "clicks" of radio inputs, which can have `button` -1 (gh-2343) + !( event.type === "click" && event.button >= 1 ) ) { + + for ( ; cur !== this; cur = cur.parentNode || this ) { + + // Don't check non-elements (#13208) + // Don't process clicks on disabled elements (#6911, #8165, #11382, #11764) + if ( cur.nodeType === 1 && !( event.type === "click" && cur.disabled === true ) ) { + matchedHandlers = []; + matchedSelectors = {}; + for ( i = 0; i < delegateCount; i++ ) { + handleObj = handlers[ i ]; + + // Don't conflict with Object.prototype properties (#13203) + sel = handleObj.selector + " "; + + if ( matchedSelectors[ sel ] === undefined ) { + matchedSelectors[ sel ] = handleObj.needsContext ? + jQuery( sel, this ).index( cur ) > -1 : + jQuery.find( sel, this, null, [ cur ] ).length; + } + if ( matchedSelectors[ sel ] ) { + matchedHandlers.push( handleObj ); + } + } + if ( matchedHandlers.length ) { + handlerQueue.push( { elem: cur, handlers: matchedHandlers } ); + } + } + } + } + + // Add the remaining (directly-bound) handlers + cur = this; + if ( delegateCount < handlers.length ) { + handlerQueue.push( { elem: cur, handlers: handlers.slice( delegateCount ) } ); + } + + return handlerQueue; + }, + + addProp: function( name, hook ) { + Object.defineProperty( jQuery.Event.prototype, name, { + enumerable: true, + configurable: true, + + get: isFunction( hook ) ? + function() { + if ( this.originalEvent ) { + return hook( this.originalEvent ); + } + } : + function() { + if ( this.originalEvent ) { + return this.originalEvent[ name ]; + } + }, + + set: function( value ) { + Object.defineProperty( this, name, { + enumerable: true, + configurable: true, + writable: true, + value: value + } ); + } + } ); + }, + + fix: function( originalEvent ) { + return originalEvent[ jQuery.expando ] ? + originalEvent : + new jQuery.Event( originalEvent ); + }, + + special: { + load: { + + // Prevent triggered image.load events from bubbling to window.load + noBubble: true + }, + click: { + + // Utilize native event to ensure correct state for checkable inputs + setup: function( data ) { + + // For mutual compressibility with _default, replace `this` access with a local var. + // `|| data` is dead code meant only to preserve the variable through minification. + var el = this || data; + + // Claim the first handler + if ( rcheckableType.test( el.type ) && + el.click && nodeName( el, "input" ) ) { + + // dataPriv.set( el, "click", ... ) + leverageNative( el, "click", returnTrue ); + } + + // Return false to allow normal processing in the caller + return false; + }, + trigger: function( data ) { + + // For mutual compressibility with _default, replace `this` access with a local var. + // `|| data` is dead code meant only to preserve the variable through minification. + var el = this || data; + + // Force setup before triggering a click + if ( rcheckableType.test( el.type ) && + el.click && nodeName( el, "input" ) ) { + + leverageNative( el, "click" ); + } + + // Return non-false to allow normal event-path propagation + return true; + }, + + // For cross-browser consistency, suppress native .click() on links + // Also prevent it if we're currently inside a leveraged native-event stack + _default: function( event ) { + var target = event.target; + return rcheckableType.test( target.type ) && + target.click && nodeName( target, "input" ) && + dataPriv.get( target, "click" ) || + nodeName( target, "a" ); + } + }, + + beforeunload: { + postDispatch: function( event ) { + + // Support: Firefox 20+ + // Firefox doesn't alert if the returnValue field is not set. + if ( event.result !== undefined && event.originalEvent ) { + event.originalEvent.returnValue = event.result; + } + } + } + } +}; + +// Ensure the presence of an event listener that handles manually-triggered +// synthetic events by interrupting progress until reinvoked in response to +// *native* events that it fires directly, ensuring that state changes have +// already occurred before other listeners are invoked. +function leverageNative( el, type, expectSync ) { + + // Missing expectSync indicates a trigger call, which must force setup through jQuery.event.add + if ( !expectSync ) { + if ( dataPriv.get( el, type ) === undefined ) { + jQuery.event.add( el, type, returnTrue ); + } + return; + } + + // Register the controller as a special universal handler for all event namespaces + dataPriv.set( el, type, false ); + jQuery.event.add( el, type, { + namespace: false, + handler: function( event ) { + var notAsync, result, + saved = dataPriv.get( this, type ); + + if ( ( event.isTrigger & 1 ) && this[ type ] ) { + + // Interrupt processing of the outer synthetic .trigger()ed event + // Saved data should be false in such cases, but might be a leftover capture object + // from an async native handler (gh-4350) + if ( !saved.length ) { + + // Store arguments for use when handling the inner native event + // There will always be at least one argument (an event object), so this array + // will not be confused with a leftover capture object. + saved = slice.call( arguments ); + dataPriv.set( this, type, saved ); + + // Trigger the native event and capture its result + // Support: IE <=9 - 11+ + // focus() and blur() are asynchronous + notAsync = expectSync( this, type ); + this[ type ](); + result = dataPriv.get( this, type ); + if ( saved !== result || notAsync ) { + dataPriv.set( this, type, false ); + } else { + result = {}; + } + if ( saved !== result ) { + + // Cancel the outer synthetic event + event.stopImmediatePropagation(); + event.preventDefault(); + return result.value; + } + + // If this is an inner synthetic event for an event with a bubbling surrogate + // (focus or blur), assume that the surrogate already propagated from triggering the + // native event and prevent that from happening again here. + // This technically gets the ordering wrong w.r.t. to `.trigger()` (in which the + // bubbling surrogate propagates *after* the non-bubbling base), but that seems + // less bad than duplication. + } else if ( ( jQuery.event.special[ type ] || {} ).delegateType ) { + event.stopPropagation(); + } + + // If this is a native event triggered above, everything is now in order + // Fire an inner synthetic event with the original arguments + } else if ( saved.length ) { + + // ...and capture the result + dataPriv.set( this, type, { + value: jQuery.event.trigger( + + // Support: IE <=9 - 11+ + // Extend with the prototype to reset the above stopImmediatePropagation() + jQuery.extend( saved[ 0 ], jQuery.Event.prototype ), + saved.slice( 1 ), + this + ) + } ); + + // Abort handling of the native event + event.stopImmediatePropagation(); + } + } + } ); +} + +jQuery.removeEvent = function( elem, type, handle ) { + + // This "if" is needed for plain objects + if ( elem.removeEventListener ) { + elem.removeEventListener( type, handle ); + } +}; + +jQuery.Event = function( src, props ) { + + // Allow instantiation without the 'new' keyword + if ( !( this instanceof jQuery.Event ) ) { + return new jQuery.Event( src, props ); + } + + // Event object + if ( src && src.type ) { + this.originalEvent = src; + this.type = src.type; + + // Events bubbling up the document may have been marked as prevented + // by a handler lower down the tree; reflect the correct value. + this.isDefaultPrevented = src.defaultPrevented || + src.defaultPrevented === undefined && + + // Support: Android <=2.3 only + src.returnValue === false ? + returnTrue : + returnFalse; + + // Create target properties + // Support: Safari <=6 - 7 only + // Target should not be a text node (#504, #13143) + this.target = ( src.target && src.target.nodeType === 3 ) ? + src.target.parentNode : + src.target; + + this.currentTarget = src.currentTarget; + this.relatedTarget = src.relatedTarget; + + // Event type + } else { + this.type = src; + } + + // Put explicitly provided properties onto the event object + if ( props ) { + jQuery.extend( this, props ); + } + + // Create a timestamp if incoming event doesn't have one + this.timeStamp = src && src.timeStamp || Date.now(); + + // Mark it as fixed + this[ jQuery.expando ] = true; +}; + +// jQuery.Event is based on DOM3 Events as specified by the ECMAScript Language Binding +// https://www.w3.org/TR/2003/WD-DOM-Level-3-Events-20030331/ecma-script-binding.html +jQuery.Event.prototype = { + constructor: jQuery.Event, + isDefaultPrevented: returnFalse, + isPropagationStopped: returnFalse, + isImmediatePropagationStopped: returnFalse, + isSimulated: false, + + preventDefault: function() { + var e = this.originalEvent; + + this.isDefaultPrevented = returnTrue; + + if ( e && !this.isSimulated ) { + e.preventDefault(); + } + }, + stopPropagation: function() { + var e = this.originalEvent; + + this.isPropagationStopped = returnTrue; + + if ( e && !this.isSimulated ) { + e.stopPropagation(); + } + }, + stopImmediatePropagation: function() { + var e = this.originalEvent; + + this.isImmediatePropagationStopped = returnTrue; + + if ( e && !this.isSimulated ) { + e.stopImmediatePropagation(); + } + + this.stopPropagation(); + } +}; + +// Includes all common event props including KeyEvent and MouseEvent specific props +jQuery.each( { + altKey: true, + bubbles: true, + cancelable: true, + changedTouches: true, + ctrlKey: true, + detail: true, + eventPhase: true, + metaKey: true, + pageX: true, + pageY: true, + shiftKey: true, + view: true, + "char": true, + code: true, + charCode: true, + key: true, + keyCode: true, + button: true, + buttons: true, + clientX: true, + clientY: true, + offsetX: true, + offsetY: true, + pointerId: true, + pointerType: true, + screenX: true, + screenY: true, + targetTouches: true, + toElement: true, + touches: true, + + which: function( event ) { + var button = event.button; + + // Add which for key events + if ( event.which == null && rkeyEvent.test( event.type ) ) { + return event.charCode != null ? event.charCode : event.keyCode; + } + + // Add which for click: 1 === left; 2 === middle; 3 === right + if ( !event.which && button !== undefined && rmouseEvent.test( event.type ) ) { + if ( button & 1 ) { + return 1; + } + + if ( button & 2 ) { + return 3; + } + + if ( button & 4 ) { + return 2; + } + + return 0; + } + + return event.which; + } +}, jQuery.event.addProp ); + +jQuery.each( { focus: "focusin", blur: "focusout" }, function( type, delegateType ) { + jQuery.event.special[ type ] = { + + // Utilize native event if possible so blur/focus sequence is correct + setup: function() { + + // Claim the first handler + // dataPriv.set( this, "focus", ... ) + // dataPriv.set( this, "blur", ... ) + leverageNative( this, type, expectSync ); + + // Return false to allow normal processing in the caller + return false; + }, + trigger: function() { + + // Force setup before trigger + leverageNative( this, type ); + + // Return non-false to allow normal event-path propagation + return true; + }, + + delegateType: delegateType + }; +} ); + +// Create mouseenter/leave events using mouseover/out and event-time checks +// so that event delegation works in jQuery. +// Do the same for pointerenter/pointerleave and pointerover/pointerout +// +// Support: Safari 7 only +// Safari sends mouseenter too often; see: +// https://bugs.chromium.org/p/chromium/issues/detail?id=470258 +// for the description of the bug (it existed in older Chrome versions as well). +jQuery.each( { + mouseenter: "mouseover", + mouseleave: "mouseout", + pointerenter: "pointerover", + pointerleave: "pointerout" +}, function( orig, fix ) { + jQuery.event.special[ orig ] = { + delegateType: fix, + bindType: fix, + + handle: function( event ) { + var ret, + target = this, + related = event.relatedTarget, + handleObj = event.handleObj; + + // For mouseenter/leave call the handler if related is outside the target. + // NB: No relatedTarget if the mouse left/entered the browser window + if ( !related || ( related !== target && !jQuery.contains( target, related ) ) ) { + event.type = handleObj.origType; + ret = handleObj.handler.apply( this, arguments ); + event.type = fix; + } + return ret; + } + }; +} ); + +jQuery.fn.extend( { + + on: function( types, selector, data, fn ) { + return on( this, types, selector, data, fn ); + }, + one: function( types, selector, data, fn ) { + return on( this, types, selector, data, fn, 1 ); + }, + off: function( types, selector, fn ) { + var handleObj, type; + if ( types && types.preventDefault && types.handleObj ) { + + // ( event ) dispatched jQuery.Event + handleObj = types.handleObj; + jQuery( types.delegateTarget ).off( + handleObj.namespace ? + handleObj.origType + "." + handleObj.namespace : + handleObj.origType, + handleObj.selector, + handleObj.handler + ); + return this; + } + if ( typeof types === "object" ) { + + // ( types-object [, selector] ) + for ( type in types ) { + this.off( type, selector, types[ type ] ); + } + return this; + } + if ( selector === false || typeof selector === "function" ) { + + // ( types [, fn] ) + fn = selector; + selector = undefined; + } + if ( fn === false ) { + fn = returnFalse; + } + return this.each( function() { + jQuery.event.remove( this, types, fn, selector ); + } ); + } +} ); + + +var + + // Support: IE <=10 - 11, Edge 12 - 13 only + // In IE/Edge using regex groups here causes severe slowdowns. + // See https://connect.microsoft.com/IE/feedback/details/1736512/ + rnoInnerhtml = /\s*$/g; + +// Prefer a tbody over its parent table for containing new rows +function manipulationTarget( elem, content ) { + if ( nodeName( elem, "table" ) && + nodeName( content.nodeType !== 11 ? content : content.firstChild, "tr" ) ) { + + return jQuery( elem ).children( "tbody" )[ 0 ] || elem; + } + + return elem; +} + +// Replace/restore the type attribute of script elements for safe DOM manipulation +function disableScript( elem ) { + elem.type = ( elem.getAttribute( "type" ) !== null ) + "/" + elem.type; + return elem; +} +function restoreScript( elem ) { + if ( ( elem.type || "" ).slice( 0, 5 ) === "true/" ) { + elem.type = elem.type.slice( 5 ); + } else { + elem.removeAttribute( "type" ); + } + + return elem; +} + +function cloneCopyEvent( src, dest ) { + var i, l, type, pdataOld, udataOld, udataCur, events; + + if ( dest.nodeType !== 1 ) { + return; + } + + // 1. Copy private data: events, handlers, etc. + if ( dataPriv.hasData( src ) ) { + pdataOld = dataPriv.get( src ); + events = pdataOld.events; + + if ( events ) { + dataPriv.remove( dest, "handle events" ); + + for ( type in events ) { + for ( i = 0, l = events[ type ].length; i < l; i++ ) { + jQuery.event.add( dest, type, events[ type ][ i ] ); + } + } + } + } + + // 2. Copy user data + if ( dataUser.hasData( src ) ) { + udataOld = dataUser.access( src ); + udataCur = jQuery.extend( {}, udataOld ); + + dataUser.set( dest, udataCur ); + } +} + +// Fix IE bugs, see support tests +function fixInput( src, dest ) { + var nodeName = dest.nodeName.toLowerCase(); + + // Fails to persist the checked state of a cloned checkbox or radio button. + if ( nodeName === "input" && rcheckableType.test( src.type ) ) { + dest.checked = src.checked; + + // Fails to return the selected option to the default selected state when cloning options + } else if ( nodeName === "input" || nodeName === "textarea" ) { + dest.defaultValue = src.defaultValue; + } +} + +function domManip( collection, args, callback, ignored ) { + + // Flatten any nested arrays + args = flat( args ); + + var fragment, first, scripts, hasScripts, node, doc, + i = 0, + l = collection.length, + iNoClone = l - 1, + value = args[ 0 ], + valueIsFunction = isFunction( value ); + + // We can't cloneNode fragments that contain checked, in WebKit + if ( valueIsFunction || + ( l > 1 && typeof value === "string" && + !support.checkClone && rchecked.test( value ) ) ) { + return collection.each( function( index ) { + var self = collection.eq( index ); + if ( valueIsFunction ) { + args[ 0 ] = value.call( this, index, self.html() ); + } + domManip( self, args, callback, ignored ); + } ); + } + + if ( l ) { + fragment = buildFragment( args, collection[ 0 ].ownerDocument, false, collection, ignored ); + first = fragment.firstChild; + + if ( fragment.childNodes.length === 1 ) { + fragment = first; + } + + // Require either new content or an interest in ignored elements to invoke the callback + if ( first || ignored ) { + scripts = jQuery.map( getAll( fragment, "script" ), disableScript ); + hasScripts = scripts.length; + + // Use the original fragment for the last item + // instead of the first because it can end up + // being emptied incorrectly in certain situations (#8070). + for ( ; i < l; i++ ) { + node = fragment; + + if ( i !== iNoClone ) { + node = jQuery.clone( node, true, true ); + + // Keep references to cloned scripts for later restoration + if ( hasScripts ) { + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + jQuery.merge( scripts, getAll( node, "script" ) ); + } + } + + callback.call( collection[ i ], node, i ); + } + + if ( hasScripts ) { + doc = scripts[ scripts.length - 1 ].ownerDocument; + + // Reenable scripts + jQuery.map( scripts, restoreScript ); + + // Evaluate executable scripts on first document insertion + for ( i = 0; i < hasScripts; i++ ) { + node = scripts[ i ]; + if ( rscriptType.test( node.type || "" ) && + !dataPriv.access( node, "globalEval" ) && + jQuery.contains( doc, node ) ) { + + if ( node.src && ( node.type || "" ).toLowerCase() !== "module" ) { + + // Optional AJAX dependency, but won't run scripts if not present + if ( jQuery._evalUrl && !node.noModule ) { + jQuery._evalUrl( node.src, { + nonce: node.nonce || node.getAttribute( "nonce" ) + }, doc ); + } + } else { + DOMEval( node.textContent.replace( rcleanScript, "" ), node, doc ); + } + } + } + } + } + } + + return collection; +} + +function remove( elem, selector, keepData ) { + var node, + nodes = selector ? jQuery.filter( selector, elem ) : elem, + i = 0; + + for ( ; ( node = nodes[ i ] ) != null; i++ ) { + if ( !keepData && node.nodeType === 1 ) { + jQuery.cleanData( getAll( node ) ); + } + + if ( node.parentNode ) { + if ( keepData && isAttached( node ) ) { + setGlobalEval( getAll( node, "script" ) ); + } + node.parentNode.removeChild( node ); + } + } + + return elem; +} + +jQuery.extend( { + htmlPrefilter: function( html ) { + return html; + }, + + clone: function( elem, dataAndEvents, deepDataAndEvents ) { + var i, l, srcElements, destElements, + clone = elem.cloneNode( true ), + inPage = isAttached( elem ); + + // Fix IE cloning issues + if ( !support.noCloneChecked && ( elem.nodeType === 1 || elem.nodeType === 11 ) && + !jQuery.isXMLDoc( elem ) ) { + + // We eschew Sizzle here for performance reasons: https://jsperf.com/getall-vs-sizzle/2 + destElements = getAll( clone ); + srcElements = getAll( elem ); + + for ( i = 0, l = srcElements.length; i < l; i++ ) { + fixInput( srcElements[ i ], destElements[ i ] ); + } + } + + // Copy the events from the original to the clone + if ( dataAndEvents ) { + if ( deepDataAndEvents ) { + srcElements = srcElements || getAll( elem ); + destElements = destElements || getAll( clone ); + + for ( i = 0, l = srcElements.length; i < l; i++ ) { + cloneCopyEvent( srcElements[ i ], destElements[ i ] ); + } + } else { + cloneCopyEvent( elem, clone ); + } + } + + // Preserve script evaluation history + destElements = getAll( clone, "script" ); + if ( destElements.length > 0 ) { + setGlobalEval( destElements, !inPage && getAll( elem, "script" ) ); + } + + // Return the cloned set + return clone; + }, + + cleanData: function( elems ) { + var data, elem, type, + special = jQuery.event.special, + i = 0; + + for ( ; ( elem = elems[ i ] ) !== undefined; i++ ) { + if ( acceptData( elem ) ) { + if ( ( data = elem[ dataPriv.expando ] ) ) { + if ( data.events ) { + for ( type in data.events ) { + if ( special[ type ] ) { + jQuery.event.remove( elem, type ); + + // This is a shortcut to avoid jQuery.event.remove's overhead + } else { + jQuery.removeEvent( elem, type, data.handle ); + } + } + } + + // Support: Chrome <=35 - 45+ + // Assign undefined instead of using delete, see Data#remove + elem[ dataPriv.expando ] = undefined; + } + if ( elem[ dataUser.expando ] ) { + + // Support: Chrome <=35 - 45+ + // Assign undefined instead of using delete, see Data#remove + elem[ dataUser.expando ] = undefined; + } + } + } + } +} ); + +jQuery.fn.extend( { + detach: function( selector ) { + return remove( this, selector, true ); + }, + + remove: function( selector ) { + return remove( this, selector ); + }, + + text: function( value ) { + return access( this, function( value ) { + return value === undefined ? + jQuery.text( this ) : + this.empty().each( function() { + if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { + this.textContent = value; + } + } ); + }, null, value, arguments.length ); + }, + + append: function() { + return domManip( this, arguments, function( elem ) { + if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { + var target = manipulationTarget( this, elem ); + target.appendChild( elem ); + } + } ); + }, + + prepend: function() { + return domManip( this, arguments, function( elem ) { + if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { + var target = manipulationTarget( this, elem ); + target.insertBefore( elem, target.firstChild ); + } + } ); + }, + + before: function() { + return domManip( this, arguments, function( elem ) { + if ( this.parentNode ) { + this.parentNode.insertBefore( elem, this ); + } + } ); + }, + + after: function() { + return domManip( this, arguments, function( elem ) { + if ( this.parentNode ) { + this.parentNode.insertBefore( elem, this.nextSibling ); + } + } ); + }, + + empty: function() { + var elem, + i = 0; + + for ( ; ( elem = this[ i ] ) != null; i++ ) { + if ( elem.nodeType === 1 ) { + + // Prevent memory leaks + jQuery.cleanData( getAll( elem, false ) ); + + // Remove any remaining nodes + elem.textContent = ""; + } + } + + return this; + }, + + clone: function( dataAndEvents, deepDataAndEvents ) { + dataAndEvents = dataAndEvents == null ? false : dataAndEvents; + deepDataAndEvents = deepDataAndEvents == null ? dataAndEvents : deepDataAndEvents; + + return this.map( function() { + return jQuery.clone( this, dataAndEvents, deepDataAndEvents ); + } ); + }, + + html: function( value ) { + return access( this, function( value ) { + var elem = this[ 0 ] || {}, + i = 0, + l = this.length; + + if ( value === undefined && elem.nodeType === 1 ) { + return elem.innerHTML; + } + + // See if we can take a shortcut and just use innerHTML + if ( typeof value === "string" && !rnoInnerhtml.test( value ) && + !wrapMap[ ( rtagName.exec( value ) || [ "", "" ] )[ 1 ].toLowerCase() ] ) { + + value = jQuery.htmlPrefilter( value ); + + try { + for ( ; i < l; i++ ) { + elem = this[ i ] || {}; + + // Remove element nodes and prevent memory leaks + if ( elem.nodeType === 1 ) { + jQuery.cleanData( getAll( elem, false ) ); + elem.innerHTML = value; + } + } + + elem = 0; + + // If using innerHTML throws an exception, use the fallback method + } catch ( e ) {} + } + + if ( elem ) { + this.empty().append( value ); + } + }, null, value, arguments.length ); + }, + + replaceWith: function() { + var ignored = []; + + // Make the changes, replacing each non-ignored context element with the new content + return domManip( this, arguments, function( elem ) { + var parent = this.parentNode; + + if ( jQuery.inArray( this, ignored ) < 0 ) { + jQuery.cleanData( getAll( this ) ); + if ( parent ) { + parent.replaceChild( elem, this ); + } + } + + // Force callback invocation + }, ignored ); + } +} ); + +jQuery.each( { + appendTo: "append", + prependTo: "prepend", + insertBefore: "before", + insertAfter: "after", + replaceAll: "replaceWith" +}, function( name, original ) { + jQuery.fn[ name ] = function( selector ) { + var elems, + ret = [], + insert = jQuery( selector ), + last = insert.length - 1, + i = 0; + + for ( ; i <= last; i++ ) { + elems = i === last ? this : this.clone( true ); + jQuery( insert[ i ] )[ original ]( elems ); + + // Support: Android <=4.0 only, PhantomJS 1 only + // .get() because push.apply(_, arraylike) throws on ancient WebKit + push.apply( ret, elems.get() ); + } + + return this.pushStack( ret ); + }; +} ); +var rnumnonpx = new RegExp( "^(" + pnum + ")(?!px)[a-z%]+$", "i" ); + +var getStyles = function( elem ) { + + // Support: IE <=11 only, Firefox <=30 (#15098, #14150) + // IE throws on elements created in popups + // FF meanwhile throws on frame elements through "defaultView.getComputedStyle" + var view = elem.ownerDocument.defaultView; + + if ( !view || !view.opener ) { + view = window; + } + + return view.getComputedStyle( elem ); + }; + +var swap = function( elem, options, callback ) { + var ret, name, + old = {}; + + // Remember the old values, and insert the new ones + for ( name in options ) { + old[ name ] = elem.style[ name ]; + elem.style[ name ] = options[ name ]; + } + + ret = callback.call( elem ); + + // Revert the old values + for ( name in options ) { + elem.style[ name ] = old[ name ]; + } + + return ret; +}; + + +var rboxStyle = new RegExp( cssExpand.join( "|" ), "i" ); + + + +( function() { + + // Executing both pixelPosition & boxSizingReliable tests require only one layout + // so they're executed at the same time to save the second computation. + function computeStyleTests() { + + // This is a singleton, we need to execute it only once + if ( !div ) { + return; + } + + container.style.cssText = "position:absolute;left:-11111px;width:60px;" + + "margin-top:1px;padding:0;border:0"; + div.style.cssText = + "position:relative;display:block;box-sizing:border-box;overflow:scroll;" + + "margin:auto;border:1px;padding:1px;" + + "width:60%;top:1%"; + documentElement.appendChild( container ).appendChild( div ); + + var divStyle = window.getComputedStyle( div ); + pixelPositionVal = divStyle.top !== "1%"; + + // Support: Android 4.0 - 4.3 only, Firefox <=3 - 44 + reliableMarginLeftVal = roundPixelMeasures( divStyle.marginLeft ) === 12; + + // Support: Android 4.0 - 4.3 only, Safari <=9.1 - 10.1, iOS <=7.0 - 9.3 + // Some styles come back with percentage values, even though they shouldn't + div.style.right = "60%"; + pixelBoxStylesVal = roundPixelMeasures( divStyle.right ) === 36; + + // Support: IE 9 - 11 only + // Detect misreporting of content dimensions for box-sizing:border-box elements + boxSizingReliableVal = roundPixelMeasures( divStyle.width ) === 36; + + // Support: IE 9 only + // Detect overflow:scroll screwiness (gh-3699) + // Support: Chrome <=64 + // Don't get tricked when zoom affects offsetWidth (gh-4029) + div.style.position = "absolute"; + scrollboxSizeVal = roundPixelMeasures( div.offsetWidth / 3 ) === 12; + + documentElement.removeChild( container ); + + // Nullify the div so it wouldn't be stored in the memory and + // it will also be a sign that checks already performed + div = null; + } + + function roundPixelMeasures( measure ) { + return Math.round( parseFloat( measure ) ); + } + + var pixelPositionVal, boxSizingReliableVal, scrollboxSizeVal, pixelBoxStylesVal, + reliableTrDimensionsVal, reliableMarginLeftVal, + container = document.createElement( "div" ), + div = document.createElement( "div" ); + + // Finish early in limited (non-browser) environments + if ( !div.style ) { + return; + } + + // Support: IE <=9 - 11 only + // Style of cloned element affects source element cloned (#8908) + div.style.backgroundClip = "content-box"; + div.cloneNode( true ).style.backgroundClip = ""; + support.clearCloneStyle = div.style.backgroundClip === "content-box"; + + jQuery.extend( support, { + boxSizingReliable: function() { + computeStyleTests(); + return boxSizingReliableVal; + }, + pixelBoxStyles: function() { + computeStyleTests(); + return pixelBoxStylesVal; + }, + pixelPosition: function() { + computeStyleTests(); + return pixelPositionVal; + }, + reliableMarginLeft: function() { + computeStyleTests(); + return reliableMarginLeftVal; + }, + scrollboxSize: function() { + computeStyleTests(); + return scrollboxSizeVal; + }, + + // Support: IE 9 - 11+, Edge 15 - 18+ + // IE/Edge misreport `getComputedStyle` of table rows with width/height + // set in CSS while `offset*` properties report correct values. + // Behavior in IE 9 is more subtle than in newer versions & it passes + // some versions of this test; make sure not to make it pass there! + reliableTrDimensions: function() { + var table, tr, trChild, trStyle; + if ( reliableTrDimensionsVal == null ) { + table = document.createElement( "table" ); + tr = document.createElement( "tr" ); + trChild = document.createElement( "div" ); + + table.style.cssText = "position:absolute;left:-11111px"; + tr.style.height = "1px"; + trChild.style.height = "9px"; + + documentElement + .appendChild( table ) + .appendChild( tr ) + .appendChild( trChild ); + + trStyle = window.getComputedStyle( tr ); + reliableTrDimensionsVal = parseInt( trStyle.height ) > 3; + + documentElement.removeChild( table ); + } + return reliableTrDimensionsVal; + } + } ); +} )(); + + +function curCSS( elem, name, computed ) { + var width, minWidth, maxWidth, ret, + + // Support: Firefox 51+ + // Retrieving style before computed somehow + // fixes an issue with getting wrong values + // on detached elements + style = elem.style; + + computed = computed || getStyles( elem ); + + // getPropertyValue is needed for: + // .css('filter') (IE 9 only, #12537) + // .css('--customProperty) (#3144) + if ( computed ) { + ret = computed.getPropertyValue( name ) || computed[ name ]; + + if ( ret === "" && !isAttached( elem ) ) { + ret = jQuery.style( elem, name ); + } + + // A tribute to the "awesome hack by Dean Edwards" + // Android Browser returns percentage for some values, + // but width seems to be reliably pixels. + // This is against the CSSOM draft spec: + // https://drafts.csswg.org/cssom/#resolved-values + if ( !support.pixelBoxStyles() && rnumnonpx.test( ret ) && rboxStyle.test( name ) ) { + + // Remember the original values + width = style.width; + minWidth = style.minWidth; + maxWidth = style.maxWidth; + + // Put in the new values to get a computed value out + style.minWidth = style.maxWidth = style.width = ret; + ret = computed.width; + + // Revert the changed values + style.width = width; + style.minWidth = minWidth; + style.maxWidth = maxWidth; + } + } + + return ret !== undefined ? + + // Support: IE <=9 - 11 only + // IE returns zIndex value as an integer. + ret + "" : + ret; +} + + +function addGetHookIf( conditionFn, hookFn ) { + + // Define the hook, we'll check on the first run if it's really needed. + return { + get: function() { + if ( conditionFn() ) { + + // Hook not needed (or it's not possible to use it due + // to missing dependency), remove it. + delete this.get; + return; + } + + // Hook needed; redefine it so that the support test is not executed again. + return ( this.get = hookFn ).apply( this, arguments ); + } + }; +} + + +var cssPrefixes = [ "Webkit", "Moz", "ms" ], + emptyStyle = document.createElement( "div" ).style, + vendorProps = {}; + +// Return a vendor-prefixed property or undefined +function vendorPropName( name ) { + + // Check for vendor prefixed names + var capName = name[ 0 ].toUpperCase() + name.slice( 1 ), + i = cssPrefixes.length; + + while ( i-- ) { + name = cssPrefixes[ i ] + capName; + if ( name in emptyStyle ) { + return name; + } + } +} + +// Return a potentially-mapped jQuery.cssProps or vendor prefixed property +function finalPropName( name ) { + var final = jQuery.cssProps[ name ] || vendorProps[ name ]; + + if ( final ) { + return final; + } + if ( name in emptyStyle ) { + return name; + } + return vendorProps[ name ] = vendorPropName( name ) || name; +} + + +var + + // Swappable if display is none or starts with table + // except "table", "table-cell", or "table-caption" + // See here for display values: https://developer.mozilla.org/en-US/docs/CSS/display + rdisplayswap = /^(none|table(?!-c[ea]).+)/, + rcustomProp = /^--/, + cssShow = { position: "absolute", visibility: "hidden", display: "block" }, + cssNormalTransform = { + letterSpacing: "0", + fontWeight: "400" + }; + +function setPositiveNumber( _elem, value, subtract ) { + + // Any relative (+/-) values have already been + // normalized at this point + var matches = rcssNum.exec( value ); + return matches ? + + // Guard against undefined "subtract", e.g., when used as in cssHooks + Math.max( 0, matches[ 2 ] - ( subtract || 0 ) ) + ( matches[ 3 ] || "px" ) : + value; +} + +function boxModelAdjustment( elem, dimension, box, isBorderBox, styles, computedVal ) { + var i = dimension === "width" ? 1 : 0, + extra = 0, + delta = 0; + + // Adjustment may not be necessary + if ( box === ( isBorderBox ? "border" : "content" ) ) { + return 0; + } + + for ( ; i < 4; i += 2 ) { + + // Both box models exclude margin + if ( box === "margin" ) { + delta += jQuery.css( elem, box + cssExpand[ i ], true, styles ); + } + + // If we get here with a content-box, we're seeking "padding" or "border" or "margin" + if ( !isBorderBox ) { + + // Add padding + delta += jQuery.css( elem, "padding" + cssExpand[ i ], true, styles ); + + // For "border" or "margin", add border + if ( box !== "padding" ) { + delta += jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); + + // But still keep track of it otherwise + } else { + extra += jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); + } + + // If we get here with a border-box (content + padding + border), we're seeking "content" or + // "padding" or "margin" + } else { + + // For "content", subtract padding + if ( box === "content" ) { + delta -= jQuery.css( elem, "padding" + cssExpand[ i ], true, styles ); + } + + // For "content" or "padding", subtract border + if ( box !== "margin" ) { + delta -= jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); + } + } + } + + // Account for positive content-box scroll gutter when requested by providing computedVal + if ( !isBorderBox && computedVal >= 0 ) { + + // offsetWidth/offsetHeight is a rounded sum of content, padding, scroll gutter, and border + // Assuming integer scroll gutter, subtract the rest and round down + delta += Math.max( 0, Math.ceil( + elem[ "offset" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ) ] - + computedVal - + delta - + extra - + 0.5 + + // If offsetWidth/offsetHeight is unknown, then we can't determine content-box scroll gutter + // Use an explicit zero to avoid NaN (gh-3964) + ) ) || 0; + } + + return delta; +} + +function getWidthOrHeight( elem, dimension, extra ) { + + // Start with computed style + var styles = getStyles( elem ), + + // To avoid forcing a reflow, only fetch boxSizing if we need it (gh-4322). + // Fake content-box until we know it's needed to know the true value. + boxSizingNeeded = !support.boxSizingReliable() || extra, + isBorderBox = boxSizingNeeded && + jQuery.css( elem, "boxSizing", false, styles ) === "border-box", + valueIsBorderBox = isBorderBox, + + val = curCSS( elem, dimension, styles ), + offsetProp = "offset" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ); + + // Support: Firefox <=54 + // Return a confounding non-pixel value or feign ignorance, as appropriate. + if ( rnumnonpx.test( val ) ) { + if ( !extra ) { + return val; + } + val = "auto"; + } + + + // Support: IE 9 - 11 only + // Use offsetWidth/offsetHeight for when box sizing is unreliable. + // In those cases, the computed value can be trusted to be border-box. + if ( ( !support.boxSizingReliable() && isBorderBox || + + // Support: IE 10 - 11+, Edge 15 - 18+ + // IE/Edge misreport `getComputedStyle` of table rows with width/height + // set in CSS while `offset*` properties report correct values. + // Interestingly, in some cases IE 9 doesn't suffer from this issue. + !support.reliableTrDimensions() && nodeName( elem, "tr" ) || + + // Fall back to offsetWidth/offsetHeight when value is "auto" + // This happens for inline elements with no explicit setting (gh-3571) + val === "auto" || + + // Support: Android <=4.1 - 4.3 only + // Also use offsetWidth/offsetHeight for misreported inline dimensions (gh-3602) + !parseFloat( val ) && jQuery.css( elem, "display", false, styles ) === "inline" ) && + + // Make sure the element is visible & connected + elem.getClientRects().length ) { + + isBorderBox = jQuery.css( elem, "boxSizing", false, styles ) === "border-box"; + + // Where available, offsetWidth/offsetHeight approximate border box dimensions. + // Where not available (e.g., SVG), assume unreliable box-sizing and interpret the + // retrieved value as a content box dimension. + valueIsBorderBox = offsetProp in elem; + if ( valueIsBorderBox ) { + val = elem[ offsetProp ]; + } + } + + // Normalize "" and auto + val = parseFloat( val ) || 0; + + // Adjust for the element's box model + return ( val + + boxModelAdjustment( + elem, + dimension, + extra || ( isBorderBox ? "border" : "content" ), + valueIsBorderBox, + styles, + + // Provide the current computed size to request scroll gutter calculation (gh-3589) + val + ) + ) + "px"; +} + +jQuery.extend( { + + // Add in style property hooks for overriding the default + // behavior of getting and setting a style property + cssHooks: { + opacity: { + get: function( elem, computed ) { + if ( computed ) { + + // We should always get a number back from opacity + var ret = curCSS( elem, "opacity" ); + return ret === "" ? "1" : ret; + } + } + } + }, + + // Don't automatically add "px" to these possibly-unitless properties + cssNumber: { + "animationIterationCount": true, + "columnCount": true, + "fillOpacity": true, + "flexGrow": true, + "flexShrink": true, + "fontWeight": true, + "gridArea": true, + "gridColumn": true, + "gridColumnEnd": true, + "gridColumnStart": true, + "gridRow": true, + "gridRowEnd": true, + "gridRowStart": true, + "lineHeight": true, + "opacity": true, + "order": true, + "orphans": true, + "widows": true, + "zIndex": true, + "zoom": true + }, + + // Add in properties whose names you wish to fix before + // setting or getting the value + cssProps: {}, + + // Get and set the style property on a DOM Node + style: function( elem, name, value, extra ) { + + // Don't set styles on text and comment nodes + if ( !elem || elem.nodeType === 3 || elem.nodeType === 8 || !elem.style ) { + return; + } + + // Make sure that we're working with the right name + var ret, type, hooks, + origName = camelCase( name ), + isCustomProp = rcustomProp.test( name ), + style = elem.style; + + // Make sure that we're working with the right name. We don't + // want to query the value if it is a CSS custom property + // since they are user-defined. + if ( !isCustomProp ) { + name = finalPropName( origName ); + } + + // Gets hook for the prefixed version, then unprefixed version + hooks = jQuery.cssHooks[ name ] || jQuery.cssHooks[ origName ]; + + // Check if we're setting a value + if ( value !== undefined ) { + type = typeof value; + + // Convert "+=" or "-=" to relative numbers (#7345) + if ( type === "string" && ( ret = rcssNum.exec( value ) ) && ret[ 1 ] ) { + value = adjustCSS( elem, name, ret ); + + // Fixes bug #9237 + type = "number"; + } + + // Make sure that null and NaN values aren't set (#7116) + if ( value == null || value !== value ) { + return; + } + + // If a number was passed in, add the unit (except for certain CSS properties) + // The isCustomProp check can be removed in jQuery 4.0 when we only auto-append + // "px" to a few hardcoded values. + if ( type === "number" && !isCustomProp ) { + value += ret && ret[ 3 ] || ( jQuery.cssNumber[ origName ] ? "" : "px" ); + } + + // background-* props affect original clone's values + if ( !support.clearCloneStyle && value === "" && name.indexOf( "background" ) === 0 ) { + style[ name ] = "inherit"; + } + + // If a hook was provided, use that value, otherwise just set the specified value + if ( !hooks || !( "set" in hooks ) || + ( value = hooks.set( elem, value, extra ) ) !== undefined ) { + + if ( isCustomProp ) { + style.setProperty( name, value ); + } else { + style[ name ] = value; + } + } + + } else { + + // If a hook was provided get the non-computed value from there + if ( hooks && "get" in hooks && + ( ret = hooks.get( elem, false, extra ) ) !== undefined ) { + + return ret; + } + + // Otherwise just get the value from the style object + return style[ name ]; + } + }, + + css: function( elem, name, extra, styles ) { + var val, num, hooks, + origName = camelCase( name ), + isCustomProp = rcustomProp.test( name ); + + // Make sure that we're working with the right name. We don't + // want to modify the value if it is a CSS custom property + // since they are user-defined. + if ( !isCustomProp ) { + name = finalPropName( origName ); + } + + // Try prefixed name followed by the unprefixed name + hooks = jQuery.cssHooks[ name ] || jQuery.cssHooks[ origName ]; + + // If a hook was provided get the computed value from there + if ( hooks && "get" in hooks ) { + val = hooks.get( elem, true, extra ); + } + + // Otherwise, if a way to get the computed value exists, use that + if ( val === undefined ) { + val = curCSS( elem, name, styles ); + } + + // Convert "normal" to computed value + if ( val === "normal" && name in cssNormalTransform ) { + val = cssNormalTransform[ name ]; + } + + // Make numeric if forced or a qualifier was provided and val looks numeric + if ( extra === "" || extra ) { + num = parseFloat( val ); + return extra === true || isFinite( num ) ? num || 0 : val; + } + + return val; + } +} ); + +jQuery.each( [ "height", "width" ], function( _i, dimension ) { + jQuery.cssHooks[ dimension ] = { + get: function( elem, computed, extra ) { + if ( computed ) { + + // Certain elements can have dimension info if we invisibly show them + // but it must have a current display style that would benefit + return rdisplayswap.test( jQuery.css( elem, "display" ) ) && + + // Support: Safari 8+ + // Table columns in Safari have non-zero offsetWidth & zero + // getBoundingClientRect().width unless display is changed. + // Support: IE <=11 only + // Running getBoundingClientRect on a disconnected node + // in IE throws an error. + ( !elem.getClientRects().length || !elem.getBoundingClientRect().width ) ? + swap( elem, cssShow, function() { + return getWidthOrHeight( elem, dimension, extra ); + } ) : + getWidthOrHeight( elem, dimension, extra ); + } + }, + + set: function( elem, value, extra ) { + var matches, + styles = getStyles( elem ), + + // Only read styles.position if the test has a chance to fail + // to avoid forcing a reflow. + scrollboxSizeBuggy = !support.scrollboxSize() && + styles.position === "absolute", + + // To avoid forcing a reflow, only fetch boxSizing if we need it (gh-3991) + boxSizingNeeded = scrollboxSizeBuggy || extra, + isBorderBox = boxSizingNeeded && + jQuery.css( elem, "boxSizing", false, styles ) === "border-box", + subtract = extra ? + boxModelAdjustment( + elem, + dimension, + extra, + isBorderBox, + styles + ) : + 0; + + // Account for unreliable border-box dimensions by comparing offset* to computed and + // faking a content-box to get border and padding (gh-3699) + if ( isBorderBox && scrollboxSizeBuggy ) { + subtract -= Math.ceil( + elem[ "offset" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ) ] - + parseFloat( styles[ dimension ] ) - + boxModelAdjustment( elem, dimension, "border", false, styles ) - + 0.5 + ); + } + + // Convert to pixels if value adjustment is needed + if ( subtract && ( matches = rcssNum.exec( value ) ) && + ( matches[ 3 ] || "px" ) !== "px" ) { + + elem.style[ dimension ] = value; + value = jQuery.css( elem, dimension ); + } + + return setPositiveNumber( elem, value, subtract ); + } + }; +} ); + +jQuery.cssHooks.marginLeft = addGetHookIf( support.reliableMarginLeft, + function( elem, computed ) { + if ( computed ) { + return ( parseFloat( curCSS( elem, "marginLeft" ) ) || + elem.getBoundingClientRect().left - + swap( elem, { marginLeft: 0 }, function() { + return elem.getBoundingClientRect().left; + } ) + ) + "px"; + } + } +); + +// These hooks are used by animate to expand properties +jQuery.each( { + margin: "", + padding: "", + border: "Width" +}, function( prefix, suffix ) { + jQuery.cssHooks[ prefix + suffix ] = { + expand: function( value ) { + var i = 0, + expanded = {}, + + // Assumes a single number if not a string + parts = typeof value === "string" ? value.split( " " ) : [ value ]; + + for ( ; i < 4; i++ ) { + expanded[ prefix + cssExpand[ i ] + suffix ] = + parts[ i ] || parts[ i - 2 ] || parts[ 0 ]; + } + + return expanded; + } + }; + + if ( prefix !== "margin" ) { + jQuery.cssHooks[ prefix + suffix ].set = setPositiveNumber; + } +} ); + +jQuery.fn.extend( { + css: function( name, value ) { + return access( this, function( elem, name, value ) { + var styles, len, + map = {}, + i = 0; + + if ( Array.isArray( name ) ) { + styles = getStyles( elem ); + len = name.length; + + for ( ; i < len; i++ ) { + map[ name[ i ] ] = jQuery.css( elem, name[ i ], false, styles ); + } + + return map; + } + + return value !== undefined ? + jQuery.style( elem, name, value ) : + jQuery.css( elem, name ); + }, name, value, arguments.length > 1 ); + } +} ); + + +function Tween( elem, options, prop, end, easing ) { + return new Tween.prototype.init( elem, options, prop, end, easing ); +} +jQuery.Tween = Tween; + +Tween.prototype = { + constructor: Tween, + init: function( elem, options, prop, end, easing, unit ) { + this.elem = elem; + this.prop = prop; + this.easing = easing || jQuery.easing._default; + this.options = options; + this.start = this.now = this.cur(); + this.end = end; + this.unit = unit || ( jQuery.cssNumber[ prop ] ? "" : "px" ); + }, + cur: function() { + var hooks = Tween.propHooks[ this.prop ]; + + return hooks && hooks.get ? + hooks.get( this ) : + Tween.propHooks._default.get( this ); + }, + run: function( percent ) { + var eased, + hooks = Tween.propHooks[ this.prop ]; + + if ( this.options.duration ) { + this.pos = eased = jQuery.easing[ this.easing ]( + percent, this.options.duration * percent, 0, 1, this.options.duration + ); + } else { + this.pos = eased = percent; + } + this.now = ( this.end - this.start ) * eased + this.start; + + if ( this.options.step ) { + this.options.step.call( this.elem, this.now, this ); + } + + if ( hooks && hooks.set ) { + hooks.set( this ); + } else { + Tween.propHooks._default.set( this ); + } + return this; + } +}; + +Tween.prototype.init.prototype = Tween.prototype; + +Tween.propHooks = { + _default: { + get: function( tween ) { + var result; + + // Use a property on the element directly when it is not a DOM element, + // or when there is no matching style property that exists. + if ( tween.elem.nodeType !== 1 || + tween.elem[ tween.prop ] != null && tween.elem.style[ tween.prop ] == null ) { + return tween.elem[ tween.prop ]; + } + + // Passing an empty string as a 3rd parameter to .css will automatically + // attempt a parseFloat and fallback to a string if the parse fails. + // Simple values such as "10px" are parsed to Float; + // complex values such as "rotate(1rad)" are returned as-is. + result = jQuery.css( tween.elem, tween.prop, "" ); + + // Empty strings, null, undefined and "auto" are converted to 0. + return !result || result === "auto" ? 0 : result; + }, + set: function( tween ) { + + // Use step hook for back compat. + // Use cssHook if its there. + // Use .style if available and use plain properties where available. + if ( jQuery.fx.step[ tween.prop ] ) { + jQuery.fx.step[ tween.prop ]( tween ); + } else if ( tween.elem.nodeType === 1 && ( + jQuery.cssHooks[ tween.prop ] || + tween.elem.style[ finalPropName( tween.prop ) ] != null ) ) { + jQuery.style( tween.elem, tween.prop, tween.now + tween.unit ); + } else { + tween.elem[ tween.prop ] = tween.now; + } + } + } +}; + +// Support: IE <=9 only +// Panic based approach to setting things on disconnected nodes +Tween.propHooks.scrollTop = Tween.propHooks.scrollLeft = { + set: function( tween ) { + if ( tween.elem.nodeType && tween.elem.parentNode ) { + tween.elem[ tween.prop ] = tween.now; + } + } +}; + +jQuery.easing = { + linear: function( p ) { + return p; + }, + swing: function( p ) { + return 0.5 - Math.cos( p * Math.PI ) / 2; + }, + _default: "swing" +}; + +jQuery.fx = Tween.prototype.init; + +// Back compat <1.8 extension point +jQuery.fx.step = {}; + + + + +var + fxNow, inProgress, + rfxtypes = /^(?:toggle|show|hide)$/, + rrun = /queueHooks$/; + +function schedule() { + if ( inProgress ) { + if ( document.hidden === false && window.requestAnimationFrame ) { + window.requestAnimationFrame( schedule ); + } else { + window.setTimeout( schedule, jQuery.fx.interval ); + } + + jQuery.fx.tick(); + } +} + +// Animations created synchronously will run synchronously +function createFxNow() { + window.setTimeout( function() { + fxNow = undefined; + } ); + return ( fxNow = Date.now() ); +} + +// Generate parameters to create a standard animation +function genFx( type, includeWidth ) { + var which, + i = 0, + attrs = { height: type }; + + // If we include width, step value is 1 to do all cssExpand values, + // otherwise step value is 2 to skip over Left and Right + includeWidth = includeWidth ? 1 : 0; + for ( ; i < 4; i += 2 - includeWidth ) { + which = cssExpand[ i ]; + attrs[ "margin" + which ] = attrs[ "padding" + which ] = type; + } + + if ( includeWidth ) { + attrs.opacity = attrs.width = type; + } + + return attrs; +} + +function createTween( value, prop, animation ) { + var tween, + collection = ( Animation.tweeners[ prop ] || [] ).concat( Animation.tweeners[ "*" ] ), + index = 0, + length = collection.length; + for ( ; index < length; index++ ) { + if ( ( tween = collection[ index ].call( animation, prop, value ) ) ) { + + // We're done with this property + return tween; + } + } +} + +function defaultPrefilter( elem, props, opts ) { + var prop, value, toggle, hooks, oldfire, propTween, restoreDisplay, display, + isBox = "width" in props || "height" in props, + anim = this, + orig = {}, + style = elem.style, + hidden = elem.nodeType && isHiddenWithinTree( elem ), + dataShow = dataPriv.get( elem, "fxshow" ); + + // Queue-skipping animations hijack the fx hooks + if ( !opts.queue ) { + hooks = jQuery._queueHooks( elem, "fx" ); + if ( hooks.unqueued == null ) { + hooks.unqueued = 0; + oldfire = hooks.empty.fire; + hooks.empty.fire = function() { + if ( !hooks.unqueued ) { + oldfire(); + } + }; + } + hooks.unqueued++; + + anim.always( function() { + + // Ensure the complete handler is called before this completes + anim.always( function() { + hooks.unqueued--; + if ( !jQuery.queue( elem, "fx" ).length ) { + hooks.empty.fire(); + } + } ); + } ); + } + + // Detect show/hide animations + for ( prop in props ) { + value = props[ prop ]; + if ( rfxtypes.test( value ) ) { + delete props[ prop ]; + toggle = toggle || value === "toggle"; + if ( value === ( hidden ? "hide" : "show" ) ) { + + // Pretend to be hidden if this is a "show" and + // there is still data from a stopped show/hide + if ( value === "show" && dataShow && dataShow[ prop ] !== undefined ) { + hidden = true; + + // Ignore all other no-op show/hide data + } else { + continue; + } + } + orig[ prop ] = dataShow && dataShow[ prop ] || jQuery.style( elem, prop ); + } + } + + // Bail out if this is a no-op like .hide().hide() + propTween = !jQuery.isEmptyObject( props ); + if ( !propTween && jQuery.isEmptyObject( orig ) ) { + return; + } + + // Restrict "overflow" and "display" styles during box animations + if ( isBox && elem.nodeType === 1 ) { + + // Support: IE <=9 - 11, Edge 12 - 15 + // Record all 3 overflow attributes because IE does not infer the shorthand + // from identically-valued overflowX and overflowY and Edge just mirrors + // the overflowX value there. + opts.overflow = [ style.overflow, style.overflowX, style.overflowY ]; + + // Identify a display type, preferring old show/hide data over the CSS cascade + restoreDisplay = dataShow && dataShow.display; + if ( restoreDisplay == null ) { + restoreDisplay = dataPriv.get( elem, "display" ); + } + display = jQuery.css( elem, "display" ); + if ( display === "none" ) { + if ( restoreDisplay ) { + display = restoreDisplay; + } else { + + // Get nonempty value(s) by temporarily forcing visibility + showHide( [ elem ], true ); + restoreDisplay = elem.style.display || restoreDisplay; + display = jQuery.css( elem, "display" ); + showHide( [ elem ] ); + } + } + + // Animate inline elements as inline-block + if ( display === "inline" || display === "inline-block" && restoreDisplay != null ) { + if ( jQuery.css( elem, "float" ) === "none" ) { + + // Restore the original display value at the end of pure show/hide animations + if ( !propTween ) { + anim.done( function() { + style.display = restoreDisplay; + } ); + if ( restoreDisplay == null ) { + display = style.display; + restoreDisplay = display === "none" ? "" : display; + } + } + style.display = "inline-block"; + } + } + } + + if ( opts.overflow ) { + style.overflow = "hidden"; + anim.always( function() { + style.overflow = opts.overflow[ 0 ]; + style.overflowX = opts.overflow[ 1 ]; + style.overflowY = opts.overflow[ 2 ]; + } ); + } + + // Implement show/hide animations + propTween = false; + for ( prop in orig ) { + + // General show/hide setup for this element animation + if ( !propTween ) { + if ( dataShow ) { + if ( "hidden" in dataShow ) { + hidden = dataShow.hidden; + } + } else { + dataShow = dataPriv.access( elem, "fxshow", { display: restoreDisplay } ); + } + + // Store hidden/visible for toggle so `.stop().toggle()` "reverses" + if ( toggle ) { + dataShow.hidden = !hidden; + } + + // Show elements before animating them + if ( hidden ) { + showHide( [ elem ], true ); + } + + /* eslint-disable no-loop-func */ + + anim.done( function() { + + /* eslint-enable no-loop-func */ + + // The final step of a "hide" animation is actually hiding the element + if ( !hidden ) { + showHide( [ elem ] ); + } + dataPriv.remove( elem, "fxshow" ); + for ( prop in orig ) { + jQuery.style( elem, prop, orig[ prop ] ); + } + } ); + } + + // Per-property setup + propTween = createTween( hidden ? dataShow[ prop ] : 0, prop, anim ); + if ( !( prop in dataShow ) ) { + dataShow[ prop ] = propTween.start; + if ( hidden ) { + propTween.end = propTween.start; + propTween.start = 0; + } + } + } +} + +function propFilter( props, specialEasing ) { + var index, name, easing, value, hooks; + + // camelCase, specialEasing and expand cssHook pass + for ( index in props ) { + name = camelCase( index ); + easing = specialEasing[ name ]; + value = props[ index ]; + if ( Array.isArray( value ) ) { + easing = value[ 1 ]; + value = props[ index ] = value[ 0 ]; + } + + if ( index !== name ) { + props[ name ] = value; + delete props[ index ]; + } + + hooks = jQuery.cssHooks[ name ]; + if ( hooks && "expand" in hooks ) { + value = hooks.expand( value ); + delete props[ name ]; + + // Not quite $.extend, this won't overwrite existing keys. + // Reusing 'index' because we have the correct "name" + for ( index in value ) { + if ( !( index in props ) ) { + props[ index ] = value[ index ]; + specialEasing[ index ] = easing; + } + } + } else { + specialEasing[ name ] = easing; + } + } +} + +function Animation( elem, properties, options ) { + var result, + stopped, + index = 0, + length = Animation.prefilters.length, + deferred = jQuery.Deferred().always( function() { + + // Don't match elem in the :animated selector + delete tick.elem; + } ), + tick = function() { + if ( stopped ) { + return false; + } + var currentTime = fxNow || createFxNow(), + remaining = Math.max( 0, animation.startTime + animation.duration - currentTime ), + + // Support: Android 2.3 only + // Archaic crash bug won't allow us to use `1 - ( 0.5 || 0 )` (#12497) + temp = remaining / animation.duration || 0, + percent = 1 - temp, + index = 0, + length = animation.tweens.length; + + for ( ; index < length; index++ ) { + animation.tweens[ index ].run( percent ); + } + + deferred.notifyWith( elem, [ animation, percent, remaining ] ); + + // If there's more to do, yield + if ( percent < 1 && length ) { + return remaining; + } + + // If this was an empty animation, synthesize a final progress notification + if ( !length ) { + deferred.notifyWith( elem, [ animation, 1, 0 ] ); + } + + // Resolve the animation and report its conclusion + deferred.resolveWith( elem, [ animation ] ); + return false; + }, + animation = deferred.promise( { + elem: elem, + props: jQuery.extend( {}, properties ), + opts: jQuery.extend( true, { + specialEasing: {}, + easing: jQuery.easing._default + }, options ), + originalProperties: properties, + originalOptions: options, + startTime: fxNow || createFxNow(), + duration: options.duration, + tweens: [], + createTween: function( prop, end ) { + var tween = jQuery.Tween( elem, animation.opts, prop, end, + animation.opts.specialEasing[ prop ] || animation.opts.easing ); + animation.tweens.push( tween ); + return tween; + }, + stop: function( gotoEnd ) { + var index = 0, + + // If we are going to the end, we want to run all the tweens + // otherwise we skip this part + length = gotoEnd ? animation.tweens.length : 0; + if ( stopped ) { + return this; + } + stopped = true; + for ( ; index < length; index++ ) { + animation.tweens[ index ].run( 1 ); + } + + // Resolve when we played the last frame; otherwise, reject + if ( gotoEnd ) { + deferred.notifyWith( elem, [ animation, 1, 0 ] ); + deferred.resolveWith( elem, [ animation, gotoEnd ] ); + } else { + deferred.rejectWith( elem, [ animation, gotoEnd ] ); + } + return this; + } + } ), + props = animation.props; + + propFilter( props, animation.opts.specialEasing ); + + for ( ; index < length; index++ ) { + result = Animation.prefilters[ index ].call( animation, elem, props, animation.opts ); + if ( result ) { + if ( isFunction( result.stop ) ) { + jQuery._queueHooks( animation.elem, animation.opts.queue ).stop = + result.stop.bind( result ); + } + return result; + } + } + + jQuery.map( props, createTween, animation ); + + if ( isFunction( animation.opts.start ) ) { + animation.opts.start.call( elem, animation ); + } + + // Attach callbacks from options + animation + .progress( animation.opts.progress ) + .done( animation.opts.done, animation.opts.complete ) + .fail( animation.opts.fail ) + .always( animation.opts.always ); + + jQuery.fx.timer( + jQuery.extend( tick, { + elem: elem, + anim: animation, + queue: animation.opts.queue + } ) + ); + + return animation; +} + +jQuery.Animation = jQuery.extend( Animation, { + + tweeners: { + "*": [ function( prop, value ) { + var tween = this.createTween( prop, value ); + adjustCSS( tween.elem, prop, rcssNum.exec( value ), tween ); + return tween; + } ] + }, + + tweener: function( props, callback ) { + if ( isFunction( props ) ) { + callback = props; + props = [ "*" ]; + } else { + props = props.match( rnothtmlwhite ); + } + + var prop, + index = 0, + length = props.length; + + for ( ; index < length; index++ ) { + prop = props[ index ]; + Animation.tweeners[ prop ] = Animation.tweeners[ prop ] || []; + Animation.tweeners[ prop ].unshift( callback ); + } + }, + + prefilters: [ defaultPrefilter ], + + prefilter: function( callback, prepend ) { + if ( prepend ) { + Animation.prefilters.unshift( callback ); + } else { + Animation.prefilters.push( callback ); + } + } +} ); + +jQuery.speed = function( speed, easing, fn ) { + var opt = speed && typeof speed === "object" ? jQuery.extend( {}, speed ) : { + complete: fn || !fn && easing || + isFunction( speed ) && speed, + duration: speed, + easing: fn && easing || easing && !isFunction( easing ) && easing + }; + + // Go to the end state if fx are off + if ( jQuery.fx.off ) { + opt.duration = 0; + + } else { + if ( typeof opt.duration !== "number" ) { + if ( opt.duration in jQuery.fx.speeds ) { + opt.duration = jQuery.fx.speeds[ opt.duration ]; + + } else { + opt.duration = jQuery.fx.speeds._default; + } + } + } + + // Normalize opt.queue - true/undefined/null -> "fx" + if ( opt.queue == null || opt.queue === true ) { + opt.queue = "fx"; + } + + // Queueing + opt.old = opt.complete; + + opt.complete = function() { + if ( isFunction( opt.old ) ) { + opt.old.call( this ); + } + + if ( opt.queue ) { + jQuery.dequeue( this, opt.queue ); + } + }; + + return opt; +}; + +jQuery.fn.extend( { + fadeTo: function( speed, to, easing, callback ) { + + // Show any hidden elements after setting opacity to 0 + return this.filter( isHiddenWithinTree ).css( "opacity", 0 ).show() + + // Animate to the value specified + .end().animate( { opacity: to }, speed, easing, callback ); + }, + animate: function( prop, speed, easing, callback ) { + var empty = jQuery.isEmptyObject( prop ), + optall = jQuery.speed( speed, easing, callback ), + doAnimation = function() { + + // Operate on a copy of prop so per-property easing won't be lost + var anim = Animation( this, jQuery.extend( {}, prop ), optall ); + + // Empty animations, or finishing resolves immediately + if ( empty || dataPriv.get( this, "finish" ) ) { + anim.stop( true ); + } + }; + doAnimation.finish = doAnimation; + + return empty || optall.queue === false ? + this.each( doAnimation ) : + this.queue( optall.queue, doAnimation ); + }, + stop: function( type, clearQueue, gotoEnd ) { + var stopQueue = function( hooks ) { + var stop = hooks.stop; + delete hooks.stop; + stop( gotoEnd ); + }; + + if ( typeof type !== "string" ) { + gotoEnd = clearQueue; + clearQueue = type; + type = undefined; + } + if ( clearQueue ) { + this.queue( type || "fx", [] ); + } + + return this.each( function() { + var dequeue = true, + index = type != null && type + "queueHooks", + timers = jQuery.timers, + data = dataPriv.get( this ); + + if ( index ) { + if ( data[ index ] && data[ index ].stop ) { + stopQueue( data[ index ] ); + } + } else { + for ( index in data ) { + if ( data[ index ] && data[ index ].stop && rrun.test( index ) ) { + stopQueue( data[ index ] ); + } + } + } + + for ( index = timers.length; index--; ) { + if ( timers[ index ].elem === this && + ( type == null || timers[ index ].queue === type ) ) { + + timers[ index ].anim.stop( gotoEnd ); + dequeue = false; + timers.splice( index, 1 ); + } + } + + // Start the next in the queue if the last step wasn't forced. + // Timers currently will call their complete callbacks, which + // will dequeue but only if they were gotoEnd. + if ( dequeue || !gotoEnd ) { + jQuery.dequeue( this, type ); + } + } ); + }, + finish: function( type ) { + if ( type !== false ) { + type = type || "fx"; + } + return this.each( function() { + var index, + data = dataPriv.get( this ), + queue = data[ type + "queue" ], + hooks = data[ type + "queueHooks" ], + timers = jQuery.timers, + length = queue ? queue.length : 0; + + // Enable finishing flag on private data + data.finish = true; + + // Empty the queue first + jQuery.queue( this, type, [] ); + + if ( hooks && hooks.stop ) { + hooks.stop.call( this, true ); + } + + // Look for any active animations, and finish them + for ( index = timers.length; index--; ) { + if ( timers[ index ].elem === this && timers[ index ].queue === type ) { + timers[ index ].anim.stop( true ); + timers.splice( index, 1 ); + } + } + + // Look for any animations in the old queue and finish them + for ( index = 0; index < length; index++ ) { + if ( queue[ index ] && queue[ index ].finish ) { + queue[ index ].finish.call( this ); + } + } + + // Turn off finishing flag + delete data.finish; + } ); + } +} ); + +jQuery.each( [ "toggle", "show", "hide" ], function( _i, name ) { + var cssFn = jQuery.fn[ name ]; + jQuery.fn[ name ] = function( speed, easing, callback ) { + return speed == null || typeof speed === "boolean" ? + cssFn.apply( this, arguments ) : + this.animate( genFx( name, true ), speed, easing, callback ); + }; +} ); + +// Generate shortcuts for custom animations +jQuery.each( { + slideDown: genFx( "show" ), + slideUp: genFx( "hide" ), + slideToggle: genFx( "toggle" ), + fadeIn: { opacity: "show" }, + fadeOut: { opacity: "hide" }, + fadeToggle: { opacity: "toggle" } +}, function( name, props ) { + jQuery.fn[ name ] = function( speed, easing, callback ) { + return this.animate( props, speed, easing, callback ); + }; +} ); + +jQuery.timers = []; +jQuery.fx.tick = function() { + var timer, + i = 0, + timers = jQuery.timers; + + fxNow = Date.now(); + + for ( ; i < timers.length; i++ ) { + timer = timers[ i ]; + + // Run the timer and safely remove it when done (allowing for external removal) + if ( !timer() && timers[ i ] === timer ) { + timers.splice( i--, 1 ); + } + } + + if ( !timers.length ) { + jQuery.fx.stop(); + } + fxNow = undefined; +}; + +jQuery.fx.timer = function( timer ) { + jQuery.timers.push( timer ); + jQuery.fx.start(); +}; + +jQuery.fx.interval = 13; +jQuery.fx.start = function() { + if ( inProgress ) { + return; + } + + inProgress = true; + schedule(); +}; + +jQuery.fx.stop = function() { + inProgress = null; +}; + +jQuery.fx.speeds = { + slow: 600, + fast: 200, + + // Default speed + _default: 400 +}; + + +// Based off of the plugin by Clint Helfers, with permission. +// https://web.archive.org/web/20100324014747/http://blindsignals.com/index.php/2009/07/jquery-delay/ +jQuery.fn.delay = function( time, type ) { + time = jQuery.fx ? jQuery.fx.speeds[ time ] || time : time; + type = type || "fx"; + + return this.queue( type, function( next, hooks ) { + var timeout = window.setTimeout( next, time ); + hooks.stop = function() { + window.clearTimeout( timeout ); + }; + } ); +}; + + +( function() { + var input = document.createElement( "input" ), + select = document.createElement( "select" ), + opt = select.appendChild( document.createElement( "option" ) ); + + input.type = "checkbox"; + + // Support: Android <=4.3 only + // Default value for a checkbox should be "on" + support.checkOn = input.value !== ""; + + // Support: IE <=11 only + // Must access selectedIndex to make default options select + support.optSelected = opt.selected; + + // Support: IE <=11 only + // An input loses its value after becoming a radio + input = document.createElement( "input" ); + input.value = "t"; + input.type = "radio"; + support.radioValue = input.value === "t"; +} )(); + + +var boolHook, + attrHandle = jQuery.expr.attrHandle; + +jQuery.fn.extend( { + attr: function( name, value ) { + return access( this, jQuery.attr, name, value, arguments.length > 1 ); + }, + + removeAttr: function( name ) { + return this.each( function() { + jQuery.removeAttr( this, name ); + } ); + } +} ); + +jQuery.extend( { + attr: function( elem, name, value ) { + var ret, hooks, + nType = elem.nodeType; + + // Don't get/set attributes on text, comment and attribute nodes + if ( nType === 3 || nType === 8 || nType === 2 ) { + return; + } + + // Fallback to prop when attributes are not supported + if ( typeof elem.getAttribute === "undefined" ) { + return jQuery.prop( elem, name, value ); + } + + // Attribute hooks are determined by the lowercase version + // Grab necessary hook if one is defined + if ( nType !== 1 || !jQuery.isXMLDoc( elem ) ) { + hooks = jQuery.attrHooks[ name.toLowerCase() ] || + ( jQuery.expr.match.bool.test( name ) ? boolHook : undefined ); + } + + if ( value !== undefined ) { + if ( value === null ) { + jQuery.removeAttr( elem, name ); + return; + } + + if ( hooks && "set" in hooks && + ( ret = hooks.set( elem, value, name ) ) !== undefined ) { + return ret; + } + + elem.setAttribute( name, value + "" ); + return value; + } + + if ( hooks && "get" in hooks && ( ret = hooks.get( elem, name ) ) !== null ) { + return ret; + } + + ret = jQuery.find.attr( elem, name ); + + // Non-existent attributes return null, we normalize to undefined + return ret == null ? undefined : ret; + }, + + attrHooks: { + type: { + set: function( elem, value ) { + if ( !support.radioValue && value === "radio" && + nodeName( elem, "input" ) ) { + var val = elem.value; + elem.setAttribute( "type", value ); + if ( val ) { + elem.value = val; + } + return value; + } + } + } + }, + + removeAttr: function( elem, value ) { + var name, + i = 0, + + // Attribute names can contain non-HTML whitespace characters + // https://html.spec.whatwg.org/multipage/syntax.html#attributes-2 + attrNames = value && value.match( rnothtmlwhite ); + + if ( attrNames && elem.nodeType === 1 ) { + while ( ( name = attrNames[ i++ ] ) ) { + elem.removeAttribute( name ); + } + } + } +} ); + +// Hooks for boolean attributes +boolHook = { + set: function( elem, value, name ) { + if ( value === false ) { + + // Remove boolean attributes when set to false + jQuery.removeAttr( elem, name ); + } else { + elem.setAttribute( name, name ); + } + return name; + } +}; + +jQuery.each( jQuery.expr.match.bool.source.match( /\w+/g ), function( _i, name ) { + var getter = attrHandle[ name ] || jQuery.find.attr; + + attrHandle[ name ] = function( elem, name, isXML ) { + var ret, handle, + lowercaseName = name.toLowerCase(); + + if ( !isXML ) { + + // Avoid an infinite loop by temporarily removing this function from the getter + handle = attrHandle[ lowercaseName ]; + attrHandle[ lowercaseName ] = ret; + ret = getter( elem, name, isXML ) != null ? + lowercaseName : + null; + attrHandle[ lowercaseName ] = handle; + } + return ret; + }; +} ); + + + + +var rfocusable = /^(?:input|select|textarea|button)$/i, + rclickable = /^(?:a|area)$/i; + +jQuery.fn.extend( { + prop: function( name, value ) { + return access( this, jQuery.prop, name, value, arguments.length > 1 ); + }, + + removeProp: function( name ) { + return this.each( function() { + delete this[ jQuery.propFix[ name ] || name ]; + } ); + } +} ); + +jQuery.extend( { + prop: function( elem, name, value ) { + var ret, hooks, + nType = elem.nodeType; + + // Don't get/set properties on text, comment and attribute nodes + if ( nType === 3 || nType === 8 || nType === 2 ) { + return; + } + + if ( nType !== 1 || !jQuery.isXMLDoc( elem ) ) { + + // Fix name and attach hooks + name = jQuery.propFix[ name ] || name; + hooks = jQuery.propHooks[ name ]; + } + + if ( value !== undefined ) { + if ( hooks && "set" in hooks && + ( ret = hooks.set( elem, value, name ) ) !== undefined ) { + return ret; + } + + return ( elem[ name ] = value ); + } + + if ( hooks && "get" in hooks && ( ret = hooks.get( elem, name ) ) !== null ) { + return ret; + } + + return elem[ name ]; + }, + + propHooks: { + tabIndex: { + get: function( elem ) { + + // Support: IE <=9 - 11 only + // elem.tabIndex doesn't always return the + // correct value when it hasn't been explicitly set + // https://web.archive.org/web/20141116233347/http://fluidproject.org/blog/2008/01/09/getting-setting-and-removing-tabindex-values-with-javascript/ + // Use proper attribute retrieval(#12072) + var tabindex = jQuery.find.attr( elem, "tabindex" ); + + if ( tabindex ) { + return parseInt( tabindex, 10 ); + } + + if ( + rfocusable.test( elem.nodeName ) || + rclickable.test( elem.nodeName ) && + elem.href + ) { + return 0; + } + + return -1; + } + } + }, + + propFix: { + "for": "htmlFor", + "class": "className" + } +} ); + +// Support: IE <=11 only +// Accessing the selectedIndex property +// forces the browser to respect setting selected +// on the option +// The getter ensures a default option is selected +// when in an optgroup +// eslint rule "no-unused-expressions" is disabled for this code +// since it considers such accessions noop +if ( !support.optSelected ) { + jQuery.propHooks.selected = { + get: function( elem ) { + + /* eslint no-unused-expressions: "off" */ + + var parent = elem.parentNode; + if ( parent && parent.parentNode ) { + parent.parentNode.selectedIndex; + } + return null; + }, + set: function( elem ) { + + /* eslint no-unused-expressions: "off" */ + + var parent = elem.parentNode; + if ( parent ) { + parent.selectedIndex; + + if ( parent.parentNode ) { + parent.parentNode.selectedIndex; + } + } + } + }; +} + +jQuery.each( [ + "tabIndex", + "readOnly", + "maxLength", + "cellSpacing", + "cellPadding", + "rowSpan", + "colSpan", + "useMap", + "frameBorder", + "contentEditable" +], function() { + jQuery.propFix[ this.toLowerCase() ] = this; +} ); + + + + + // Strip and collapse whitespace according to HTML spec + // https://infra.spec.whatwg.org/#strip-and-collapse-ascii-whitespace + function stripAndCollapse( value ) { + var tokens = value.match( rnothtmlwhite ) || []; + return tokens.join( " " ); + } + + +function getClass( elem ) { + return elem.getAttribute && elem.getAttribute( "class" ) || ""; +} + +function classesToArray( value ) { + if ( Array.isArray( value ) ) { + return value; + } + if ( typeof value === "string" ) { + return value.match( rnothtmlwhite ) || []; + } + return []; +} + +jQuery.fn.extend( { + addClass: function( value ) { + var classes, elem, cur, curValue, clazz, j, finalValue, + i = 0; + + if ( isFunction( value ) ) { + return this.each( function( j ) { + jQuery( this ).addClass( value.call( this, j, getClass( this ) ) ); + } ); + } + + classes = classesToArray( value ); + + if ( classes.length ) { + while ( ( elem = this[ i++ ] ) ) { + curValue = getClass( elem ); + cur = elem.nodeType === 1 && ( " " + stripAndCollapse( curValue ) + " " ); + + if ( cur ) { + j = 0; + while ( ( clazz = classes[ j++ ] ) ) { + if ( cur.indexOf( " " + clazz + " " ) < 0 ) { + cur += clazz + " "; + } + } + + // Only assign if different to avoid unneeded rendering. + finalValue = stripAndCollapse( cur ); + if ( curValue !== finalValue ) { + elem.setAttribute( "class", finalValue ); + } + } + } + } + + return this; + }, + + removeClass: function( value ) { + var classes, elem, cur, curValue, clazz, j, finalValue, + i = 0; + + if ( isFunction( value ) ) { + return this.each( function( j ) { + jQuery( this ).removeClass( value.call( this, j, getClass( this ) ) ); + } ); + } + + if ( !arguments.length ) { + return this.attr( "class", "" ); + } + + classes = classesToArray( value ); + + if ( classes.length ) { + while ( ( elem = this[ i++ ] ) ) { + curValue = getClass( elem ); + + // This expression is here for better compressibility (see addClass) + cur = elem.nodeType === 1 && ( " " + stripAndCollapse( curValue ) + " " ); + + if ( cur ) { + j = 0; + while ( ( clazz = classes[ j++ ] ) ) { + + // Remove *all* instances + while ( cur.indexOf( " " + clazz + " " ) > -1 ) { + cur = cur.replace( " " + clazz + " ", " " ); + } + } + + // Only assign if different to avoid unneeded rendering. + finalValue = stripAndCollapse( cur ); + if ( curValue !== finalValue ) { + elem.setAttribute( "class", finalValue ); + } + } + } + } + + return this; + }, + + toggleClass: function( value, stateVal ) { + var type = typeof value, + isValidValue = type === "string" || Array.isArray( value ); + + if ( typeof stateVal === "boolean" && isValidValue ) { + return stateVal ? this.addClass( value ) : this.removeClass( value ); + } + + if ( isFunction( value ) ) { + return this.each( function( i ) { + jQuery( this ).toggleClass( + value.call( this, i, getClass( this ), stateVal ), + stateVal + ); + } ); + } + + return this.each( function() { + var className, i, self, classNames; + + if ( isValidValue ) { + + // Toggle individual class names + i = 0; + self = jQuery( this ); + classNames = classesToArray( value ); + + while ( ( className = classNames[ i++ ] ) ) { + + // Check each className given, space separated list + if ( self.hasClass( className ) ) { + self.removeClass( className ); + } else { + self.addClass( className ); + } + } + + // Toggle whole class name + } else if ( value === undefined || type === "boolean" ) { + className = getClass( this ); + if ( className ) { + + // Store className if set + dataPriv.set( this, "__className__", className ); + } + + // If the element has a class name or if we're passed `false`, + // then remove the whole classname (if there was one, the above saved it). + // Otherwise bring back whatever was previously saved (if anything), + // falling back to the empty string if nothing was stored. + if ( this.setAttribute ) { + this.setAttribute( "class", + className || value === false ? + "" : + dataPriv.get( this, "__className__" ) || "" + ); + } + } + } ); + }, + + hasClass: function( selector ) { + var className, elem, + i = 0; + + className = " " + selector + " "; + while ( ( elem = this[ i++ ] ) ) { + if ( elem.nodeType === 1 && + ( " " + stripAndCollapse( getClass( elem ) ) + " " ).indexOf( className ) > -1 ) { + return true; + } + } + + return false; + } +} ); + + + + +var rreturn = /\r/g; + +jQuery.fn.extend( { + val: function( value ) { + var hooks, ret, valueIsFunction, + elem = this[ 0 ]; + + if ( !arguments.length ) { + if ( elem ) { + hooks = jQuery.valHooks[ elem.type ] || + jQuery.valHooks[ elem.nodeName.toLowerCase() ]; + + if ( hooks && + "get" in hooks && + ( ret = hooks.get( elem, "value" ) ) !== undefined + ) { + return ret; + } + + ret = elem.value; + + // Handle most common string cases + if ( typeof ret === "string" ) { + return ret.replace( rreturn, "" ); + } + + // Handle cases where value is null/undef or number + return ret == null ? "" : ret; + } + + return; + } + + valueIsFunction = isFunction( value ); + + return this.each( function( i ) { + var val; + + if ( this.nodeType !== 1 ) { + return; + } + + if ( valueIsFunction ) { + val = value.call( this, i, jQuery( this ).val() ); + } else { + val = value; + } + + // Treat null/undefined as ""; convert numbers to string + if ( val == null ) { + val = ""; + + } else if ( typeof val === "number" ) { + val += ""; + + } else if ( Array.isArray( val ) ) { + val = jQuery.map( val, function( value ) { + return value == null ? "" : value + ""; + } ); + } + + hooks = jQuery.valHooks[ this.type ] || jQuery.valHooks[ this.nodeName.toLowerCase() ]; + + // If set returns undefined, fall back to normal setting + if ( !hooks || !( "set" in hooks ) || hooks.set( this, val, "value" ) === undefined ) { + this.value = val; + } + } ); + } +} ); + +jQuery.extend( { + valHooks: { + option: { + get: function( elem ) { + + var val = jQuery.find.attr( elem, "value" ); + return val != null ? + val : + + // Support: IE <=10 - 11 only + // option.text throws exceptions (#14686, #14858) + // Strip and collapse whitespace + // https://html.spec.whatwg.org/#strip-and-collapse-whitespace + stripAndCollapse( jQuery.text( elem ) ); + } + }, + select: { + get: function( elem ) { + var value, option, i, + options = elem.options, + index = elem.selectedIndex, + one = elem.type === "select-one", + values = one ? null : [], + max = one ? index + 1 : options.length; + + if ( index < 0 ) { + i = max; + + } else { + i = one ? index : 0; + } + + // Loop through all the selected options + for ( ; i < max; i++ ) { + option = options[ i ]; + + // Support: IE <=9 only + // IE8-9 doesn't update selected after form reset (#2551) + if ( ( option.selected || i === index ) && + + // Don't return options that are disabled or in a disabled optgroup + !option.disabled && + ( !option.parentNode.disabled || + !nodeName( option.parentNode, "optgroup" ) ) ) { + + // Get the specific value for the option + value = jQuery( option ).val(); + + // We don't need an array for one selects + if ( one ) { + return value; + } + + // Multi-Selects return an array + values.push( value ); + } + } + + return values; + }, + + set: function( elem, value ) { + var optionSet, option, + options = elem.options, + values = jQuery.makeArray( value ), + i = options.length; + + while ( i-- ) { + option = options[ i ]; + + /* eslint-disable no-cond-assign */ + + if ( option.selected = + jQuery.inArray( jQuery.valHooks.option.get( option ), values ) > -1 + ) { + optionSet = true; + } + + /* eslint-enable no-cond-assign */ + } + + // Force browsers to behave consistently when non-matching value is set + if ( !optionSet ) { + elem.selectedIndex = -1; + } + return values; + } + } + } +} ); + +// Radios and checkboxes getter/setter +jQuery.each( [ "radio", "checkbox" ], function() { + jQuery.valHooks[ this ] = { + set: function( elem, value ) { + if ( Array.isArray( value ) ) { + return ( elem.checked = jQuery.inArray( jQuery( elem ).val(), value ) > -1 ); + } + } + }; + if ( !support.checkOn ) { + jQuery.valHooks[ this ].get = function( elem ) { + return elem.getAttribute( "value" ) === null ? "on" : elem.value; + }; + } +} ); + + + + +// Return jQuery for attributes-only inclusion + + +support.focusin = "onfocusin" in window; + + +var rfocusMorph = /^(?:focusinfocus|focusoutblur)$/, + stopPropagationCallback = function( e ) { + e.stopPropagation(); + }; + +jQuery.extend( jQuery.event, { + + trigger: function( event, data, elem, onlyHandlers ) { + + var i, cur, tmp, bubbleType, ontype, handle, special, lastElement, + eventPath = [ elem || document ], + type = hasOwn.call( event, "type" ) ? event.type : event, + namespaces = hasOwn.call( event, "namespace" ) ? event.namespace.split( "." ) : []; + + cur = lastElement = tmp = elem = elem || document; + + // Don't do events on text and comment nodes + if ( elem.nodeType === 3 || elem.nodeType === 8 ) { + return; + } + + // focus/blur morphs to focusin/out; ensure we're not firing them right now + if ( rfocusMorph.test( type + jQuery.event.triggered ) ) { + return; + } + + if ( type.indexOf( "." ) > -1 ) { + + // Namespaced trigger; create a regexp to match event type in handle() + namespaces = type.split( "." ); + type = namespaces.shift(); + namespaces.sort(); + } + ontype = type.indexOf( ":" ) < 0 && "on" + type; + + // Caller can pass in a jQuery.Event object, Object, or just an event type string + event = event[ jQuery.expando ] ? + event : + new jQuery.Event( type, typeof event === "object" && event ); + + // Trigger bitmask: & 1 for native handlers; & 2 for jQuery (always true) + event.isTrigger = onlyHandlers ? 2 : 3; + event.namespace = namespaces.join( "." ); + event.rnamespace = event.namespace ? + new RegExp( "(^|\\.)" + namespaces.join( "\\.(?:.*\\.|)" ) + "(\\.|$)" ) : + null; + + // Clean up the event in case it is being reused + event.result = undefined; + if ( !event.target ) { + event.target = elem; + } + + // Clone any incoming data and prepend the event, creating the handler arg list + data = data == null ? + [ event ] : + jQuery.makeArray( data, [ event ] ); + + // Allow special events to draw outside the lines + special = jQuery.event.special[ type ] || {}; + if ( !onlyHandlers && special.trigger && special.trigger.apply( elem, data ) === false ) { + return; + } + + // Determine event propagation path in advance, per W3C events spec (#9951) + // Bubble up to document, then to window; watch for a global ownerDocument var (#9724) + if ( !onlyHandlers && !special.noBubble && !isWindow( elem ) ) { + + bubbleType = special.delegateType || type; + if ( !rfocusMorph.test( bubbleType + type ) ) { + cur = cur.parentNode; + } + for ( ; cur; cur = cur.parentNode ) { + eventPath.push( cur ); + tmp = cur; + } + + // Only add window if we got to document (e.g., not plain obj or detached DOM) + if ( tmp === ( elem.ownerDocument || document ) ) { + eventPath.push( tmp.defaultView || tmp.parentWindow || window ); + } + } + + // Fire handlers on the event path + i = 0; + while ( ( cur = eventPath[ i++ ] ) && !event.isPropagationStopped() ) { + lastElement = cur; + event.type = i > 1 ? + bubbleType : + special.bindType || type; + + // jQuery handler + handle = ( + dataPriv.get( cur, "events" ) || Object.create( null ) + )[ event.type ] && + dataPriv.get( cur, "handle" ); + if ( handle ) { + handle.apply( cur, data ); + } + + // Native handler + handle = ontype && cur[ ontype ]; + if ( handle && handle.apply && acceptData( cur ) ) { + event.result = handle.apply( cur, data ); + if ( event.result === false ) { + event.preventDefault(); + } + } + } + event.type = type; + + // If nobody prevented the default action, do it now + if ( !onlyHandlers && !event.isDefaultPrevented() ) { + + if ( ( !special._default || + special._default.apply( eventPath.pop(), data ) === false ) && + acceptData( elem ) ) { + + // Call a native DOM method on the target with the same name as the event. + // Don't do default actions on window, that's where global variables be (#6170) + if ( ontype && isFunction( elem[ type ] ) && !isWindow( elem ) ) { + + // Don't re-trigger an onFOO event when we call its FOO() method + tmp = elem[ ontype ]; + + if ( tmp ) { + elem[ ontype ] = null; + } + + // Prevent re-triggering of the same event, since we already bubbled it above + jQuery.event.triggered = type; + + if ( event.isPropagationStopped() ) { + lastElement.addEventListener( type, stopPropagationCallback ); + } + + elem[ type ](); + + if ( event.isPropagationStopped() ) { + lastElement.removeEventListener( type, stopPropagationCallback ); + } + + jQuery.event.triggered = undefined; + + if ( tmp ) { + elem[ ontype ] = tmp; + } + } + } + } + + return event.result; + }, + + // Piggyback on a donor event to simulate a different one + // Used only for `focus(in | out)` events + simulate: function( type, elem, event ) { + var e = jQuery.extend( + new jQuery.Event(), + event, + { + type: type, + isSimulated: true + } + ); + + jQuery.event.trigger( e, null, elem ); + } + +} ); + +jQuery.fn.extend( { + + trigger: function( type, data ) { + return this.each( function() { + jQuery.event.trigger( type, data, this ); + } ); + }, + triggerHandler: function( type, data ) { + var elem = this[ 0 ]; + if ( elem ) { + return jQuery.event.trigger( type, data, elem, true ); + } + } +} ); + + +// Support: Firefox <=44 +// Firefox doesn't have focus(in | out) events +// Related ticket - https://bugzilla.mozilla.org/show_bug.cgi?id=687787 +// +// Support: Chrome <=48 - 49, Safari <=9.0 - 9.1 +// focus(in | out) events fire after focus & blur events, +// which is spec violation - http://www.w3.org/TR/DOM-Level-3-Events/#events-focusevent-event-order +// Related ticket - https://bugs.chromium.org/p/chromium/issues/detail?id=449857 +if ( !support.focusin ) { + jQuery.each( { focus: "focusin", blur: "focusout" }, function( orig, fix ) { + + // Attach a single capturing handler on the document while someone wants focusin/focusout + var handler = function( event ) { + jQuery.event.simulate( fix, event.target, jQuery.event.fix( event ) ); + }; + + jQuery.event.special[ fix ] = { + setup: function() { + + // Handle: regular nodes (via `this.ownerDocument`), window + // (via `this.document`) & document (via `this`). + var doc = this.ownerDocument || this.document || this, + attaches = dataPriv.access( doc, fix ); + + if ( !attaches ) { + doc.addEventListener( orig, handler, true ); + } + dataPriv.access( doc, fix, ( attaches || 0 ) + 1 ); + }, + teardown: function() { + var doc = this.ownerDocument || this.document || this, + attaches = dataPriv.access( doc, fix ) - 1; + + if ( !attaches ) { + doc.removeEventListener( orig, handler, true ); + dataPriv.remove( doc, fix ); + + } else { + dataPriv.access( doc, fix, attaches ); + } + } + }; + } ); +} +var location = window.location; + +var nonce = { guid: Date.now() }; + +var rquery = ( /\?/ ); + + + +// Cross-browser xml parsing +jQuery.parseXML = function( data ) { + var xml; + if ( !data || typeof data !== "string" ) { + return null; + } + + // Support: IE 9 - 11 only + // IE throws on parseFromString with invalid input. + try { + xml = ( new window.DOMParser() ).parseFromString( data, "text/xml" ); + } catch ( e ) { + xml = undefined; + } + + if ( !xml || xml.getElementsByTagName( "parsererror" ).length ) { + jQuery.error( "Invalid XML: " + data ); + } + return xml; +}; + + +var + rbracket = /\[\]$/, + rCRLF = /\r?\n/g, + rsubmitterTypes = /^(?:submit|button|image|reset|file)$/i, + rsubmittable = /^(?:input|select|textarea|keygen)/i; + +function buildParams( prefix, obj, traditional, add ) { + var name; + + if ( Array.isArray( obj ) ) { + + // Serialize array item. + jQuery.each( obj, function( i, v ) { + if ( traditional || rbracket.test( prefix ) ) { + + // Treat each array item as a scalar. + add( prefix, v ); + + } else { + + // Item is non-scalar (array or object), encode its numeric index. + buildParams( + prefix + "[" + ( typeof v === "object" && v != null ? i : "" ) + "]", + v, + traditional, + add + ); + } + } ); + + } else if ( !traditional && toType( obj ) === "object" ) { + + // Serialize object item. + for ( name in obj ) { + buildParams( prefix + "[" + name + "]", obj[ name ], traditional, add ); + } + + } else { + + // Serialize scalar item. + add( prefix, obj ); + } +} + +// Serialize an array of form elements or a set of +// key/values into a query string +jQuery.param = function( a, traditional ) { + var prefix, + s = [], + add = function( key, valueOrFunction ) { + + // If value is a function, invoke it and use its return value + var value = isFunction( valueOrFunction ) ? + valueOrFunction() : + valueOrFunction; + + s[ s.length ] = encodeURIComponent( key ) + "=" + + encodeURIComponent( value == null ? "" : value ); + }; + + if ( a == null ) { + return ""; + } + + // If an array was passed in, assume that it is an array of form elements. + if ( Array.isArray( a ) || ( a.jquery && !jQuery.isPlainObject( a ) ) ) { + + // Serialize the form elements + jQuery.each( a, function() { + add( this.name, this.value ); + } ); + + } else { + + // If traditional, encode the "old" way (the way 1.3.2 or older + // did it), otherwise encode params recursively. + for ( prefix in a ) { + buildParams( prefix, a[ prefix ], traditional, add ); + } + } + + // Return the resulting serialization + return s.join( "&" ); +}; + +jQuery.fn.extend( { + serialize: function() { + return jQuery.param( this.serializeArray() ); + }, + serializeArray: function() { + return this.map( function() { + + // Can add propHook for "elements" to filter or add form elements + var elements = jQuery.prop( this, "elements" ); + return elements ? jQuery.makeArray( elements ) : this; + } ) + .filter( function() { + var type = this.type; + + // Use .is( ":disabled" ) so that fieldset[disabled] works + return this.name && !jQuery( this ).is( ":disabled" ) && + rsubmittable.test( this.nodeName ) && !rsubmitterTypes.test( type ) && + ( this.checked || !rcheckableType.test( type ) ); + } ) + .map( function( _i, elem ) { + var val = jQuery( this ).val(); + + if ( val == null ) { + return null; + } + + if ( Array.isArray( val ) ) { + return jQuery.map( val, function( val ) { + return { name: elem.name, value: val.replace( rCRLF, "\r\n" ) }; + } ); + } + + return { name: elem.name, value: val.replace( rCRLF, "\r\n" ) }; + } ).get(); + } +} ); + + +var + r20 = /%20/g, + rhash = /#.*$/, + rantiCache = /([?&])_=[^&]*/, + rheaders = /^(.*?):[ \t]*([^\r\n]*)$/mg, + + // #7653, #8125, #8152: local protocol detection + rlocalProtocol = /^(?:about|app|app-storage|.+-extension|file|res|widget):$/, + rnoContent = /^(?:GET|HEAD)$/, + rprotocol = /^\/\//, + + /* Prefilters + * 1) They are useful to introduce custom dataTypes (see ajax/jsonp.js for an example) + * 2) These are called: + * - BEFORE asking for a transport + * - AFTER param serialization (s.data is a string if s.processData is true) + * 3) key is the dataType + * 4) the catchall symbol "*" can be used + * 5) execution will start with transport dataType and THEN continue down to "*" if needed + */ + prefilters = {}, + + /* Transports bindings + * 1) key is the dataType + * 2) the catchall symbol "*" can be used + * 3) selection will start with transport dataType and THEN go to "*" if needed + */ + transports = {}, + + // Avoid comment-prolog char sequence (#10098); must appease lint and evade compression + allTypes = "*/".concat( "*" ), + + // Anchor tag for parsing the document origin + originAnchor = document.createElement( "a" ); + originAnchor.href = location.href; + +// Base "constructor" for jQuery.ajaxPrefilter and jQuery.ajaxTransport +function addToPrefiltersOrTransports( structure ) { + + // dataTypeExpression is optional and defaults to "*" + return function( dataTypeExpression, func ) { + + if ( typeof dataTypeExpression !== "string" ) { + func = dataTypeExpression; + dataTypeExpression = "*"; + } + + var dataType, + i = 0, + dataTypes = dataTypeExpression.toLowerCase().match( rnothtmlwhite ) || []; + + if ( isFunction( func ) ) { + + // For each dataType in the dataTypeExpression + while ( ( dataType = dataTypes[ i++ ] ) ) { + + // Prepend if requested + if ( dataType[ 0 ] === "+" ) { + dataType = dataType.slice( 1 ) || "*"; + ( structure[ dataType ] = structure[ dataType ] || [] ).unshift( func ); + + // Otherwise append + } else { + ( structure[ dataType ] = structure[ dataType ] || [] ).push( func ); + } + } + } + }; +} + +// Base inspection function for prefilters and transports +function inspectPrefiltersOrTransports( structure, options, originalOptions, jqXHR ) { + + var inspected = {}, + seekingTransport = ( structure === transports ); + + function inspect( dataType ) { + var selected; + inspected[ dataType ] = true; + jQuery.each( structure[ dataType ] || [], function( _, prefilterOrFactory ) { + var dataTypeOrTransport = prefilterOrFactory( options, originalOptions, jqXHR ); + if ( typeof dataTypeOrTransport === "string" && + !seekingTransport && !inspected[ dataTypeOrTransport ] ) { + + options.dataTypes.unshift( dataTypeOrTransport ); + inspect( dataTypeOrTransport ); + return false; + } else if ( seekingTransport ) { + return !( selected = dataTypeOrTransport ); + } + } ); + return selected; + } + + return inspect( options.dataTypes[ 0 ] ) || !inspected[ "*" ] && inspect( "*" ); +} + +// A special extend for ajax options +// that takes "flat" options (not to be deep extended) +// Fixes #9887 +function ajaxExtend( target, src ) { + var key, deep, + flatOptions = jQuery.ajaxSettings.flatOptions || {}; + + for ( key in src ) { + if ( src[ key ] !== undefined ) { + ( flatOptions[ key ] ? target : ( deep || ( deep = {} ) ) )[ key ] = src[ key ]; + } + } + if ( deep ) { + jQuery.extend( true, target, deep ); + } + + return target; +} + +/* Handles responses to an ajax request: + * - finds the right dataType (mediates between content-type and expected dataType) + * - returns the corresponding response + */ +function ajaxHandleResponses( s, jqXHR, responses ) { + + var ct, type, finalDataType, firstDataType, + contents = s.contents, + dataTypes = s.dataTypes; + + // Remove auto dataType and get content-type in the process + while ( dataTypes[ 0 ] === "*" ) { + dataTypes.shift(); + if ( ct === undefined ) { + ct = s.mimeType || jqXHR.getResponseHeader( "Content-Type" ); + } + } + + // Check if we're dealing with a known content-type + if ( ct ) { + for ( type in contents ) { + if ( contents[ type ] && contents[ type ].test( ct ) ) { + dataTypes.unshift( type ); + break; + } + } + } + + // Check to see if we have a response for the expected dataType + if ( dataTypes[ 0 ] in responses ) { + finalDataType = dataTypes[ 0 ]; + } else { + + // Try convertible dataTypes + for ( type in responses ) { + if ( !dataTypes[ 0 ] || s.converters[ type + " " + dataTypes[ 0 ] ] ) { + finalDataType = type; + break; + } + if ( !firstDataType ) { + firstDataType = type; + } + } + + // Or just use first one + finalDataType = finalDataType || firstDataType; + } + + // If we found a dataType + // We add the dataType to the list if needed + // and return the corresponding response + if ( finalDataType ) { + if ( finalDataType !== dataTypes[ 0 ] ) { + dataTypes.unshift( finalDataType ); + } + return responses[ finalDataType ]; + } +} + +/* Chain conversions given the request and the original response + * Also sets the responseXXX fields on the jqXHR instance + */ +function ajaxConvert( s, response, jqXHR, isSuccess ) { + var conv2, current, conv, tmp, prev, + converters = {}, + + // Work with a copy of dataTypes in case we need to modify it for conversion + dataTypes = s.dataTypes.slice(); + + // Create converters map with lowercased keys + if ( dataTypes[ 1 ] ) { + for ( conv in s.converters ) { + converters[ conv.toLowerCase() ] = s.converters[ conv ]; + } + } + + current = dataTypes.shift(); + + // Convert to each sequential dataType + while ( current ) { + + if ( s.responseFields[ current ] ) { + jqXHR[ s.responseFields[ current ] ] = response; + } + + // Apply the dataFilter if provided + if ( !prev && isSuccess && s.dataFilter ) { + response = s.dataFilter( response, s.dataType ); + } + + prev = current; + current = dataTypes.shift(); + + if ( current ) { + + // There's only work to do if current dataType is non-auto + if ( current === "*" ) { + + current = prev; + + // Convert response if prev dataType is non-auto and differs from current + } else if ( prev !== "*" && prev !== current ) { + + // Seek a direct converter + conv = converters[ prev + " " + current ] || converters[ "* " + current ]; + + // If none found, seek a pair + if ( !conv ) { + for ( conv2 in converters ) { + + // If conv2 outputs current + tmp = conv2.split( " " ); + if ( tmp[ 1 ] === current ) { + + // If prev can be converted to accepted input + conv = converters[ prev + " " + tmp[ 0 ] ] || + converters[ "* " + tmp[ 0 ] ]; + if ( conv ) { + + // Condense equivalence converters + if ( conv === true ) { + conv = converters[ conv2 ]; + + // Otherwise, insert the intermediate dataType + } else if ( converters[ conv2 ] !== true ) { + current = tmp[ 0 ]; + dataTypes.unshift( tmp[ 1 ] ); + } + break; + } + } + } + } + + // Apply converter (if not an equivalence) + if ( conv !== true ) { + + // Unless errors are allowed to bubble, catch and return them + if ( conv && s.throws ) { + response = conv( response ); + } else { + try { + response = conv( response ); + } catch ( e ) { + return { + state: "parsererror", + error: conv ? e : "No conversion from " + prev + " to " + current + }; + } + } + } + } + } + } + + return { state: "success", data: response }; +} + +jQuery.extend( { + + // Counter for holding the number of active queries + active: 0, + + // Last-Modified header cache for next request + lastModified: {}, + etag: {}, + + ajaxSettings: { + url: location.href, + type: "GET", + isLocal: rlocalProtocol.test( location.protocol ), + global: true, + processData: true, + async: true, + contentType: "application/x-www-form-urlencoded; charset=UTF-8", + + /* + timeout: 0, + data: null, + dataType: null, + username: null, + password: null, + cache: null, + throws: false, + traditional: false, + headers: {}, + */ + + accepts: { + "*": allTypes, + text: "text/plain", + html: "text/html", + xml: "application/xml, text/xml", + json: "application/json, text/javascript" + }, + + contents: { + xml: /\bxml\b/, + html: /\bhtml/, + json: /\bjson\b/ + }, + + responseFields: { + xml: "responseXML", + text: "responseText", + json: "responseJSON" + }, + + // Data converters + // Keys separate source (or catchall "*") and destination types with a single space + converters: { + + // Convert anything to text + "* text": String, + + // Text to html (true = no transformation) + "text html": true, + + // Evaluate text as a json expression + "text json": JSON.parse, + + // Parse text as xml + "text xml": jQuery.parseXML + }, + + // For options that shouldn't be deep extended: + // you can add your own custom options here if + // and when you create one that shouldn't be + // deep extended (see ajaxExtend) + flatOptions: { + url: true, + context: true + } + }, + + // Creates a full fledged settings object into target + // with both ajaxSettings and settings fields. + // If target is omitted, writes into ajaxSettings. + ajaxSetup: function( target, settings ) { + return settings ? + + // Building a settings object + ajaxExtend( ajaxExtend( target, jQuery.ajaxSettings ), settings ) : + + // Extending ajaxSettings + ajaxExtend( jQuery.ajaxSettings, target ); + }, + + ajaxPrefilter: addToPrefiltersOrTransports( prefilters ), + ajaxTransport: addToPrefiltersOrTransports( transports ), + + // Main method + ajax: function( url, options ) { + + // If url is an object, simulate pre-1.5 signature + if ( typeof url === "object" ) { + options = url; + url = undefined; + } + + // Force options to be an object + options = options || {}; + + var transport, + + // URL without anti-cache param + cacheURL, + + // Response headers + responseHeadersString, + responseHeaders, + + // timeout handle + timeoutTimer, + + // Url cleanup var + urlAnchor, + + // Request state (becomes false upon send and true upon completion) + completed, + + // To know if global events are to be dispatched + fireGlobals, + + // Loop variable + i, + + // uncached part of the url + uncached, + + // Create the final options object + s = jQuery.ajaxSetup( {}, options ), + + // Callbacks context + callbackContext = s.context || s, + + // Context for global events is callbackContext if it is a DOM node or jQuery collection + globalEventContext = s.context && + ( callbackContext.nodeType || callbackContext.jquery ) ? + jQuery( callbackContext ) : + jQuery.event, + + // Deferreds + deferred = jQuery.Deferred(), + completeDeferred = jQuery.Callbacks( "once memory" ), + + // Status-dependent callbacks + statusCode = s.statusCode || {}, + + // Headers (they are sent all at once) + requestHeaders = {}, + requestHeadersNames = {}, + + // Default abort message + strAbort = "canceled", + + // Fake xhr + jqXHR = { + readyState: 0, + + // Builds headers hashtable if needed + getResponseHeader: function( key ) { + var match; + if ( completed ) { + if ( !responseHeaders ) { + responseHeaders = {}; + while ( ( match = rheaders.exec( responseHeadersString ) ) ) { + responseHeaders[ match[ 1 ].toLowerCase() + " " ] = + ( responseHeaders[ match[ 1 ].toLowerCase() + " " ] || [] ) + .concat( match[ 2 ] ); + } + } + match = responseHeaders[ key.toLowerCase() + " " ]; + } + return match == null ? null : match.join( ", " ); + }, + + // Raw string + getAllResponseHeaders: function() { + return completed ? responseHeadersString : null; + }, + + // Caches the header + setRequestHeader: function( name, value ) { + if ( completed == null ) { + name = requestHeadersNames[ name.toLowerCase() ] = + requestHeadersNames[ name.toLowerCase() ] || name; + requestHeaders[ name ] = value; + } + return this; + }, + + // Overrides response content-type header + overrideMimeType: function( type ) { + if ( completed == null ) { + s.mimeType = type; + } + return this; + }, + + // Status-dependent callbacks + statusCode: function( map ) { + var code; + if ( map ) { + if ( completed ) { + + // Execute the appropriate callbacks + jqXHR.always( map[ jqXHR.status ] ); + } else { + + // Lazy-add the new callbacks in a way that preserves old ones + for ( code in map ) { + statusCode[ code ] = [ statusCode[ code ], map[ code ] ]; + } + } + } + return this; + }, + + // Cancel the request + abort: function( statusText ) { + var finalText = statusText || strAbort; + if ( transport ) { + transport.abort( finalText ); + } + done( 0, finalText ); + return this; + } + }; + + // Attach deferreds + deferred.promise( jqXHR ); + + // Add protocol if not provided (prefilters might expect it) + // Handle falsy url in the settings object (#10093: consistency with old signature) + // We also use the url parameter if available + s.url = ( ( url || s.url || location.href ) + "" ) + .replace( rprotocol, location.protocol + "//" ); + + // Alias method option to type as per ticket #12004 + s.type = options.method || options.type || s.method || s.type; + + // Extract dataTypes list + s.dataTypes = ( s.dataType || "*" ).toLowerCase().match( rnothtmlwhite ) || [ "" ]; + + // A cross-domain request is in order when the origin doesn't match the current origin. + if ( s.crossDomain == null ) { + urlAnchor = document.createElement( "a" ); + + // Support: IE <=8 - 11, Edge 12 - 15 + // IE throws exception on accessing the href property if url is malformed, + // e.g. http://example.com:80x/ + try { + urlAnchor.href = s.url; + + // Support: IE <=8 - 11 only + // Anchor's host property isn't correctly set when s.url is relative + urlAnchor.href = urlAnchor.href; + s.crossDomain = originAnchor.protocol + "//" + originAnchor.host !== + urlAnchor.protocol + "//" + urlAnchor.host; + } catch ( e ) { + + // If there is an error parsing the URL, assume it is crossDomain, + // it can be rejected by the transport if it is invalid + s.crossDomain = true; + } + } + + // Convert data if not already a string + if ( s.data && s.processData && typeof s.data !== "string" ) { + s.data = jQuery.param( s.data, s.traditional ); + } + + // Apply prefilters + inspectPrefiltersOrTransports( prefilters, s, options, jqXHR ); + + // If request was aborted inside a prefilter, stop there + if ( completed ) { + return jqXHR; + } + + // We can fire global events as of now if asked to + // Don't fire events if jQuery.event is undefined in an AMD-usage scenario (#15118) + fireGlobals = jQuery.event && s.global; + + // Watch for a new set of requests + if ( fireGlobals && jQuery.active++ === 0 ) { + jQuery.event.trigger( "ajaxStart" ); + } + + // Uppercase the type + s.type = s.type.toUpperCase(); + + // Determine if request has content + s.hasContent = !rnoContent.test( s.type ); + + // Save the URL in case we're toying with the If-Modified-Since + // and/or If-None-Match header later on + // Remove hash to simplify url manipulation + cacheURL = s.url.replace( rhash, "" ); + + // More options handling for requests with no content + if ( !s.hasContent ) { + + // Remember the hash so we can put it back + uncached = s.url.slice( cacheURL.length ); + + // If data is available and should be processed, append data to url + if ( s.data && ( s.processData || typeof s.data === "string" ) ) { + cacheURL += ( rquery.test( cacheURL ) ? "&" : "?" ) + s.data; + + // #9682: remove data so that it's not used in an eventual retry + delete s.data; + } + + // Add or update anti-cache param if needed + if ( s.cache === false ) { + cacheURL = cacheURL.replace( rantiCache, "$1" ); + uncached = ( rquery.test( cacheURL ) ? "&" : "?" ) + "_=" + ( nonce.guid++ ) + + uncached; + } + + // Put hash and anti-cache on the URL that will be requested (gh-1732) + s.url = cacheURL + uncached; + + // Change '%20' to '+' if this is encoded form body content (gh-2658) + } else if ( s.data && s.processData && + ( s.contentType || "" ).indexOf( "application/x-www-form-urlencoded" ) === 0 ) { + s.data = s.data.replace( r20, "+" ); + } + + // Set the If-Modified-Since and/or If-None-Match header, if in ifModified mode. + if ( s.ifModified ) { + if ( jQuery.lastModified[ cacheURL ] ) { + jqXHR.setRequestHeader( "If-Modified-Since", jQuery.lastModified[ cacheURL ] ); + } + if ( jQuery.etag[ cacheURL ] ) { + jqXHR.setRequestHeader( "If-None-Match", jQuery.etag[ cacheURL ] ); + } + } + + // Set the correct header, if data is being sent + if ( s.data && s.hasContent && s.contentType !== false || options.contentType ) { + jqXHR.setRequestHeader( "Content-Type", s.contentType ); + } + + // Set the Accepts header for the server, depending on the dataType + jqXHR.setRequestHeader( + "Accept", + s.dataTypes[ 0 ] && s.accepts[ s.dataTypes[ 0 ] ] ? + s.accepts[ s.dataTypes[ 0 ] ] + + ( s.dataTypes[ 0 ] !== "*" ? ", " + allTypes + "; q=0.01" : "" ) : + s.accepts[ "*" ] + ); + + // Check for headers option + for ( i in s.headers ) { + jqXHR.setRequestHeader( i, s.headers[ i ] ); + } + + // Allow custom headers/mimetypes and early abort + if ( s.beforeSend && + ( s.beforeSend.call( callbackContext, jqXHR, s ) === false || completed ) ) { + + // Abort if not done already and return + return jqXHR.abort(); + } + + // Aborting is no longer a cancellation + strAbort = "abort"; + + // Install callbacks on deferreds + completeDeferred.add( s.complete ); + jqXHR.done( s.success ); + jqXHR.fail( s.error ); + + // Get transport + transport = inspectPrefiltersOrTransports( transports, s, options, jqXHR ); + + // If no transport, we auto-abort + if ( !transport ) { + done( -1, "No Transport" ); + } else { + jqXHR.readyState = 1; + + // Send global event + if ( fireGlobals ) { + globalEventContext.trigger( "ajaxSend", [ jqXHR, s ] ); + } + + // If request was aborted inside ajaxSend, stop there + if ( completed ) { + return jqXHR; + } + + // Timeout + if ( s.async && s.timeout > 0 ) { + timeoutTimer = window.setTimeout( function() { + jqXHR.abort( "timeout" ); + }, s.timeout ); + } + + try { + completed = false; + transport.send( requestHeaders, done ); + } catch ( e ) { + + // Rethrow post-completion exceptions + if ( completed ) { + throw e; + } + + // Propagate others as results + done( -1, e ); + } + } + + // Callback for when everything is done + function done( status, nativeStatusText, responses, headers ) { + var isSuccess, success, error, response, modified, + statusText = nativeStatusText; + + // Ignore repeat invocations + if ( completed ) { + return; + } + + completed = true; + + // Clear timeout if it exists + if ( timeoutTimer ) { + window.clearTimeout( timeoutTimer ); + } + + // Dereference transport for early garbage collection + // (no matter how long the jqXHR object will be used) + transport = undefined; + + // Cache response headers + responseHeadersString = headers || ""; + + // Set readyState + jqXHR.readyState = status > 0 ? 4 : 0; + + // Determine if successful + isSuccess = status >= 200 && status < 300 || status === 304; + + // Get response data + if ( responses ) { + response = ajaxHandleResponses( s, jqXHR, responses ); + } + + // Use a noop converter for missing script + if ( !isSuccess && jQuery.inArray( "script", s.dataTypes ) > -1 ) { + s.converters[ "text script" ] = function() {}; + } + + // Convert no matter what (that way responseXXX fields are always set) + response = ajaxConvert( s, response, jqXHR, isSuccess ); + + // If successful, handle type chaining + if ( isSuccess ) { + + // Set the If-Modified-Since and/or If-None-Match header, if in ifModified mode. + if ( s.ifModified ) { + modified = jqXHR.getResponseHeader( "Last-Modified" ); + if ( modified ) { + jQuery.lastModified[ cacheURL ] = modified; + } + modified = jqXHR.getResponseHeader( "etag" ); + if ( modified ) { + jQuery.etag[ cacheURL ] = modified; + } + } + + // if no content + if ( status === 204 || s.type === "HEAD" ) { + statusText = "nocontent"; + + // if not modified + } else if ( status === 304 ) { + statusText = "notmodified"; + + // If we have data, let's convert it + } else { + statusText = response.state; + success = response.data; + error = response.error; + isSuccess = !error; + } + } else { + + // Extract error from statusText and normalize for non-aborts + error = statusText; + if ( status || !statusText ) { + statusText = "error"; + if ( status < 0 ) { + status = 0; + } + } + } + + // Set data for the fake xhr object + jqXHR.status = status; + jqXHR.statusText = ( nativeStatusText || statusText ) + ""; + + // Success/Error + if ( isSuccess ) { + deferred.resolveWith( callbackContext, [ success, statusText, jqXHR ] ); + } else { + deferred.rejectWith( callbackContext, [ jqXHR, statusText, error ] ); + } + + // Status-dependent callbacks + jqXHR.statusCode( statusCode ); + statusCode = undefined; + + if ( fireGlobals ) { + globalEventContext.trigger( isSuccess ? "ajaxSuccess" : "ajaxError", + [ jqXHR, s, isSuccess ? success : error ] ); + } + + // Complete + completeDeferred.fireWith( callbackContext, [ jqXHR, statusText ] ); + + if ( fireGlobals ) { + globalEventContext.trigger( "ajaxComplete", [ jqXHR, s ] ); + + // Handle the global AJAX counter + if ( !( --jQuery.active ) ) { + jQuery.event.trigger( "ajaxStop" ); + } + } + } + + return jqXHR; + }, + + getJSON: function( url, data, callback ) { + return jQuery.get( url, data, callback, "json" ); + }, + + getScript: function( url, callback ) { + return jQuery.get( url, undefined, callback, "script" ); + } +} ); + +jQuery.each( [ "get", "post" ], function( _i, method ) { + jQuery[ method ] = function( url, data, callback, type ) { + + // Shift arguments if data argument was omitted + if ( isFunction( data ) ) { + type = type || callback; + callback = data; + data = undefined; + } + + // The url can be an options object (which then must have .url) + return jQuery.ajax( jQuery.extend( { + url: url, + type: method, + dataType: type, + data: data, + success: callback + }, jQuery.isPlainObject( url ) && url ) ); + }; +} ); + +jQuery.ajaxPrefilter( function( s ) { + var i; + for ( i in s.headers ) { + if ( i.toLowerCase() === "content-type" ) { + s.contentType = s.headers[ i ] || ""; + } + } +} ); + + +jQuery._evalUrl = function( url, options, doc ) { + return jQuery.ajax( { + url: url, + + // Make this explicit, since user can override this through ajaxSetup (#11264) + type: "GET", + dataType: "script", + cache: true, + async: false, + global: false, + + // Only evaluate the response if it is successful (gh-4126) + // dataFilter is not invoked for failure responses, so using it instead + // of the default converter is kludgy but it works. + converters: { + "text script": function() {} + }, + dataFilter: function( response ) { + jQuery.globalEval( response, options, doc ); + } + } ); +}; + + +jQuery.fn.extend( { + wrapAll: function( html ) { + var wrap; + + if ( this[ 0 ] ) { + if ( isFunction( html ) ) { + html = html.call( this[ 0 ] ); + } + + // The elements to wrap the target around + wrap = jQuery( html, this[ 0 ].ownerDocument ).eq( 0 ).clone( true ); + + if ( this[ 0 ].parentNode ) { + wrap.insertBefore( this[ 0 ] ); + } + + wrap.map( function() { + var elem = this; + + while ( elem.firstElementChild ) { + elem = elem.firstElementChild; + } + + return elem; + } ).append( this ); + } + + return this; + }, + + wrapInner: function( html ) { + if ( isFunction( html ) ) { + return this.each( function( i ) { + jQuery( this ).wrapInner( html.call( this, i ) ); + } ); + } + + return this.each( function() { + var self = jQuery( this ), + contents = self.contents(); + + if ( contents.length ) { + contents.wrapAll( html ); + + } else { + self.append( html ); + } + } ); + }, + + wrap: function( html ) { + var htmlIsFunction = isFunction( html ); + + return this.each( function( i ) { + jQuery( this ).wrapAll( htmlIsFunction ? html.call( this, i ) : html ); + } ); + }, + + unwrap: function( selector ) { + this.parent( selector ).not( "body" ).each( function() { + jQuery( this ).replaceWith( this.childNodes ); + } ); + return this; + } +} ); + + +jQuery.expr.pseudos.hidden = function( elem ) { + return !jQuery.expr.pseudos.visible( elem ); +}; +jQuery.expr.pseudos.visible = function( elem ) { + return !!( elem.offsetWidth || elem.offsetHeight || elem.getClientRects().length ); +}; + + + + +jQuery.ajaxSettings.xhr = function() { + try { + return new window.XMLHttpRequest(); + } catch ( e ) {} +}; + +var xhrSuccessStatus = { + + // File protocol always yields status code 0, assume 200 + 0: 200, + + // Support: IE <=9 only + // #1450: sometimes IE returns 1223 when it should be 204 + 1223: 204 + }, + xhrSupported = jQuery.ajaxSettings.xhr(); + +support.cors = !!xhrSupported && ( "withCredentials" in xhrSupported ); +support.ajax = xhrSupported = !!xhrSupported; + +jQuery.ajaxTransport( function( options ) { + var callback, errorCallback; + + // Cross domain only allowed if supported through XMLHttpRequest + if ( support.cors || xhrSupported && !options.crossDomain ) { + return { + send: function( headers, complete ) { + var i, + xhr = options.xhr(); + + xhr.open( + options.type, + options.url, + options.async, + options.username, + options.password + ); + + // Apply custom fields if provided + if ( options.xhrFields ) { + for ( i in options.xhrFields ) { + xhr[ i ] = options.xhrFields[ i ]; + } + } + + // Override mime type if needed + if ( options.mimeType && xhr.overrideMimeType ) { + xhr.overrideMimeType( options.mimeType ); + } + + // X-Requested-With header + // For cross-domain requests, seeing as conditions for a preflight are + // akin to a jigsaw puzzle, we simply never set it to be sure. + // (it can always be set on a per-request basis or even using ajaxSetup) + // For same-domain requests, won't change header if already provided. + if ( !options.crossDomain && !headers[ "X-Requested-With" ] ) { + headers[ "X-Requested-With" ] = "XMLHttpRequest"; + } + + // Set headers + for ( i in headers ) { + xhr.setRequestHeader( i, headers[ i ] ); + } + + // Callback + callback = function( type ) { + return function() { + if ( callback ) { + callback = errorCallback = xhr.onload = + xhr.onerror = xhr.onabort = xhr.ontimeout = + xhr.onreadystatechange = null; + + if ( type === "abort" ) { + xhr.abort(); + } else if ( type === "error" ) { + + // Support: IE <=9 only + // On a manual native abort, IE9 throws + // errors on any property access that is not readyState + if ( typeof xhr.status !== "number" ) { + complete( 0, "error" ); + } else { + complete( + + // File: protocol always yields status 0; see #8605, #14207 + xhr.status, + xhr.statusText + ); + } + } else { + complete( + xhrSuccessStatus[ xhr.status ] || xhr.status, + xhr.statusText, + + // Support: IE <=9 only + // IE9 has no XHR2 but throws on binary (trac-11426) + // For XHR2 non-text, let the caller handle it (gh-2498) + ( xhr.responseType || "text" ) !== "text" || + typeof xhr.responseText !== "string" ? + { binary: xhr.response } : + { text: xhr.responseText }, + xhr.getAllResponseHeaders() + ); + } + } + }; + }; + + // Listen to events + xhr.onload = callback(); + errorCallback = xhr.onerror = xhr.ontimeout = callback( "error" ); + + // Support: IE 9 only + // Use onreadystatechange to replace onabort + // to handle uncaught aborts + if ( xhr.onabort !== undefined ) { + xhr.onabort = errorCallback; + } else { + xhr.onreadystatechange = function() { + + // Check readyState before timeout as it changes + if ( xhr.readyState === 4 ) { + + // Allow onerror to be called first, + // but that will not handle a native abort + // Also, save errorCallback to a variable + // as xhr.onerror cannot be accessed + window.setTimeout( function() { + if ( callback ) { + errorCallback(); + } + } ); + } + }; + } + + // Create the abort callback + callback = callback( "abort" ); + + try { + + // Do send the request (this may raise an exception) + xhr.send( options.hasContent && options.data || null ); + } catch ( e ) { + + // #14683: Only rethrow if this hasn't been notified as an error yet + if ( callback ) { + throw e; + } + } + }, + + abort: function() { + if ( callback ) { + callback(); + } + } + }; + } +} ); + + + + +// Prevent auto-execution of scripts when no explicit dataType was provided (See gh-2432) +jQuery.ajaxPrefilter( function( s ) { + if ( s.crossDomain ) { + s.contents.script = false; + } +} ); + +// Install script dataType +jQuery.ajaxSetup( { + accepts: { + script: "text/javascript, application/javascript, " + + "application/ecmascript, application/x-ecmascript" + }, + contents: { + script: /\b(?:java|ecma)script\b/ + }, + converters: { + "text script": function( text ) { + jQuery.globalEval( text ); + return text; + } + } +} ); + +// Handle cache's special case and crossDomain +jQuery.ajaxPrefilter( "script", function( s ) { + if ( s.cache === undefined ) { + s.cache = false; + } + if ( s.crossDomain ) { + s.type = "GET"; + } +} ); + +// Bind script tag hack transport +jQuery.ajaxTransport( "script", function( s ) { + + // This transport only deals with cross domain or forced-by-attrs requests + if ( s.crossDomain || s.scriptAttrs ) { + var script, callback; + return { + send: function( _, complete ) { + script = jQuery( " + + + + + + + + + + + + +
+
+
+ + +
+ +
+

psy_simple.colors module¶

+

+ The documentation of psy-simple is now hosted at, https://psyplot.github.io/psy-simple/api/psy_simple.colors.html. + You should be redirected within 5 seconds. +

+ + +
+ +
+
+ +
+
+ + + + + + + \ No newline at end of file diff --git a/docs/_build/html/api/psy_simple.html b/docs/_build/html/api/psy_simple.html new file mode 100644 index 0000000..04dc483 --- /dev/null +++ b/docs/_build/html/api/psy_simple.html @@ -0,0 +1,121 @@ + + + + + + + + + API Reference — psy-simple 1.3.1 documentation + + + + + + + + + + + + + + + +
+
+
+ + +
+ +
+

API Reference¶

+

+ The documentation of psy-simple is now hosted at, https://psyplot.github.io/psy-simple/api/psy_simple.html. + You should be redirected within 5 seconds. +

+

Subpackages¶

+
+
+
+
+

Submodules¶

+
+
+
+
+ + +
+ +
+
+ +
+
+ + + + + + + \ No newline at end of file diff --git a/docs/_build/html/api/psy_simple.plotters.html b/docs/_build/html/api/psy_simple.plotters.html new file mode 100644 index 0000000..5731311 --- /dev/null +++ b/docs/_build/html/api/psy_simple.plotters.html @@ -0,0 +1,113 @@ + + + + + + + + + psy_simple.plotters module — psy-simple 1.3.1 documentation + + + + + + + + + + + + + + + +
+
+
+ + +
+ +
+

psy_simple.plotters module¶

+

+ The documentation of psy-simple is now hosted at, https://psyplot.github.io/psy-simple/api/psy_simple.plotters.html. + You should be redirected within 5 seconds. +

+ + +
+ +
+
+ +
+
+ + + + + + + \ No newline at end of file diff --git a/docs/_build/html/api/psy_simple.plugin.html b/docs/_build/html/api/psy_simple.plugin.html new file mode 100644 index 0000000..3dcbd0f --- /dev/null +++ b/docs/_build/html/api/psy_simple.plugin.html @@ -0,0 +1,113 @@ + + + + + + + + + psy_simple.plugin module — psy-simple 1.3.1 documentation + + + + + + + + + + + + + + + +
+
+
+ + +
+ +
+

psy_simple.plugin module¶

+

+ The documentation of psy-simple is now hosted at, https://psyplot.github.io/psy-simple/api/psy_simple.plugin.html. + You should be redirected within 5 seconds. +

+ + +
+ +
+
+ +
+
+ + + + + + + \ No newline at end of file diff --git a/docs/_build/html/api/psy_simple.widgets.colors.html b/docs/_build/html/api/psy_simple.widgets.colors.html new file mode 100644 index 0000000..517b439 --- /dev/null +++ b/docs/_build/html/api/psy_simple.widgets.colors.html @@ -0,0 +1,115 @@ + + + + + + + + + psy_simple.widgets.colors module — psy-simple 1.3.1 documentation + + + + + + + + + + + + + + + +
+
+
+ + +
+ +
+

psy_simple.widgets.colors module¶

+

+ The documentation of psy-simple is now hosted at, https://psyplot.github.io/psy-simple/api/psy_simple.widgets.colors.html. + You should be redirected within 5 seconds. +

+ + +
+ +
+
+ +
+
+ + + + + + + \ No newline at end of file diff --git a/docs/_build/html/api/psy_simple.widgets.html b/docs/_build/html/api/psy_simple.widgets.html new file mode 100644 index 0000000..9a8667b --- /dev/null +++ b/docs/_build/html/api/psy_simple.widgets.html @@ -0,0 +1,118 @@ + + + + + + + + + psy_simple.widgets package — psy-simple 1.3.1 documentation + + + + + + + + + + + + + + + +
+
+
+ + +
+ +
+

psy_simple.widgets package¶

+

+ The documentation of psy-simple is now hosted at, https://psyplot.github.io/psy-simple/api/psy_simple.widgets.html. + You should be redirected within 5 seconds. +

+

Submodules¶

+
+
+
+
+ + +
+ +
+
+ +
+
+ + + + + + + \ No newline at end of file diff --git a/docs/_build/html/api/psy_simple.widgets.texts.html b/docs/_build/html/api/psy_simple.widgets.texts.html new file mode 100644 index 0000000..a50344a --- /dev/null +++ b/docs/_build/html/api/psy_simple.widgets.texts.html @@ -0,0 +1,115 @@ + + + + + + + + + psy_simple.widgets.texts module — psy-simple 1.3.1 documentation + + + + + + + + + + + + + + + +
+
+
+ + +
+ +
+

psy_simple.widgets.texts module¶

+

+ The documentation of psy-simple is now hosted at, https://psyplot.github.io/psy-simple/api/psy_simple.widgets.texts.html. + You should be redirected within 5 seconds. +

+ + +
+ +
+
+ +
+
+ + + + + + + \ No newline at end of file diff --git a/docs/_build/html/changelog.html b/docs/_build/html/changelog.html new file mode 100644 index 0000000..918201f --- /dev/null +++ b/docs/_build/html/changelog.html @@ -0,0 +1,109 @@ + + + + + + + + + Changelog — psy-simple 1.3.1 documentation + + + + + + + + + + + + + + +
+
+
+ + +
+ +
+

Changelog¶

+

+ The documentation of psy-simple is now hosted at, https://psyplot.github.io/psy-simple/changelog.html. + You should be redirected within 5 seconds. +

+ + +
+ +
+
+ +
+
+ + + + + + + \ No newline at end of file diff --git a/docs/_build/html/contribute.html b/docs/_build/html/contribute.html new file mode 100644 index 0000000..79810b0 --- /dev/null +++ b/docs/_build/html/contribute.html @@ -0,0 +1,111 @@ + + + + + + + + + Contributing to psy-simple — psy-simple 1.3.1 documentation + + + + + + + + + + + + + + + +
+
+
+ + +
+ +
+

Contributing to psy-simple¶

+

+ The documentation of psy-simple is now hosted at, https://psyplot.github.io/psy-simple/contribute.html. + You should be redirected within 5 seconds. +

+ + +
+ +
+
+ +
+
+ + + + + + + \ No newline at end of file diff --git a/docs/_build/html/generated/psyplot.project.plot.barplot.html b/docs/_build/html/generated/psyplot.project.plot.barplot.html new file mode 100644 index 0000000..fcca7f5 --- /dev/null +++ b/docs/_build/html/generated/psyplot.project.plot.barplot.html @@ -0,0 +1,113 @@ + + + + + + + + + psyplot.project.plot.barplot — psy-simple 1.3.1 documentation + + + + + + + + + + + + + + + +
+
+
+ + +
+ +
+

psyplot.project.plot.barplot¶

+

+ The documentation of psy-simple is now hosted at, https://psyplot.github.io/psy-simple/generated/psyplot.project.plot.barplot.html. + You should be redirected within 5 seconds. +

+ + +
+ +
+
+ +
+
+ + + + + + + \ No newline at end of file diff --git a/docs/_build/html/generated/psyplot.project.plot.combined.html b/docs/_build/html/generated/psyplot.project.plot.combined.html new file mode 100644 index 0000000..9ba57e5 --- /dev/null +++ b/docs/_build/html/generated/psyplot.project.plot.combined.html @@ -0,0 +1,113 @@ + + + + + + + + + psyplot.project.plot.combined — psy-simple 1.3.1 documentation + + + + + + + + + + + + + + + +
+
+
+ + +
+ +
+

psyplot.project.plot.combined¶

+

+ The documentation of psy-simple is now hosted at, https://psyplot.github.io/psy-simple/generated/psyplot.project.plot.combined.html. + You should be redirected within 5 seconds. +

+ + +
+ +
+
+ +
+
+ + + + + + + \ No newline at end of file diff --git a/docs/_build/html/generated/psyplot.project.plot.density.html b/docs/_build/html/generated/psyplot.project.plot.density.html new file mode 100644 index 0000000..61d45e2 --- /dev/null +++ b/docs/_build/html/generated/psyplot.project.plot.density.html @@ -0,0 +1,113 @@ + + + + + + + + + psyplot.project.plot.density — psy-simple 1.3.1 documentation + + + + + + + + + + + + + + + +
+
+
+ + +
+ +
+

psyplot.project.plot.density¶

+

+ The documentation of psy-simple is now hosted at, https://psyplot.github.io/psy-simple/generated/psyplot.project.plot.density.html. + You should be redirected within 5 seconds. +

+ + +
+ +
+
+ +
+
+ + + + + + + \ No newline at end of file diff --git a/docs/_build/html/generated/psyplot.project.plot.fldmean.html b/docs/_build/html/generated/psyplot.project.plot.fldmean.html new file mode 100644 index 0000000..128a971 --- /dev/null +++ b/docs/_build/html/generated/psyplot.project.plot.fldmean.html @@ -0,0 +1,113 @@ + + + + + + + + + psyplot.project.plot.fldmean — psy-simple 1.3.1 documentation + + + + + + + + + + + + + + + +
+
+
+ + +
+ +
+

psyplot.project.plot.fldmean¶

+

+ The documentation of psy-simple is now hosted at, https://psyplot.github.io/psy-simple/generated/psyplot.project.plot.fldmean.html. + You should be redirected within 5 seconds. +

+ + +
+ +
+
+ +
+
+ + + + + + + \ No newline at end of file diff --git a/docs/_build/html/generated/psyplot.project.plot.lineplot.html b/docs/_build/html/generated/psyplot.project.plot.lineplot.html new file mode 100644 index 0000000..c3c1972 --- /dev/null +++ b/docs/_build/html/generated/psyplot.project.plot.lineplot.html @@ -0,0 +1,113 @@ + + + + + + + + + psyplot.project.plot.lineplot — psy-simple 1.3.1 documentation + + + + + + + + + + + + + + + +
+
+
+ + +
+ +
+

psyplot.project.plot.lineplot¶

+

+ The documentation of psy-simple is now hosted at, https://psyplot.github.io/psy-simple/generated/psyplot.project.plot.lineplot.html. + You should be redirected within 5 seconds. +

+ + +
+ +
+
+ +
+
+ + + + + + + \ No newline at end of file diff --git a/docs/_build/html/generated/psyplot.project.plot.plot2d.html b/docs/_build/html/generated/psyplot.project.plot.plot2d.html new file mode 100644 index 0000000..02e7591 --- /dev/null +++ b/docs/_build/html/generated/psyplot.project.plot.plot2d.html @@ -0,0 +1,113 @@ + + + + + + + + + psyplot.project.plot.plot2d — psy-simple 1.3.1 documentation + + + + + + + + + + + + + + + +
+
+
+ + +
+ +
+

psyplot.project.plot.plot2d¶

+

+ The documentation of psy-simple is now hosted at, https://psyplot.github.io/psy-simple/generated/psyplot.project.plot.plot2d.html. + You should be redirected within 5 seconds. +

+ + +
+ +
+
+ +
+
+ + + + + + + \ No newline at end of file diff --git a/docs/_build/html/generated/psyplot.project.plot.vector.html b/docs/_build/html/generated/psyplot.project.plot.vector.html new file mode 100644 index 0000000..72e8da1 --- /dev/null +++ b/docs/_build/html/generated/psyplot.project.plot.vector.html @@ -0,0 +1,113 @@ + + + + + + + + + psyplot.project.plot.vector — psy-simple 1.3.1 documentation + + + + + + + + + + + + + + + +
+
+
+ + +
+ +
+

psyplot.project.plot.vector¶

+

+ The documentation of psy-simple is now hosted at, https://psyplot.github.io/psy-simple/generated/psyplot.project.plot.vector.html. + You should be redirected within 5 seconds. +

+ + +
+ +
+
+ +
+
+ + + + + + + \ No newline at end of file diff --git a/docs/_build/html/generated/psyplot.project.plot.violinplot.html b/docs/_build/html/generated/psyplot.project.plot.violinplot.html new file mode 100644 index 0000000..562ba5d --- /dev/null +++ b/docs/_build/html/generated/psyplot.project.plot.violinplot.html @@ -0,0 +1,113 @@ + + + + + + + + + psyplot.project.plot.violinplot — psy-simple 1.3.1 documentation + + + + + + + + + + + + + + + +
+
+
+ + +
+ +
+

psyplot.project.plot.violinplot¶

+

+ The documentation of psy-simple is now hosted at, https://psyplot.github.io/psy-simple/generated/psyplot.project.plot.violinplot.html. + You should be redirected within 5 seconds. +

+ + +
+ +
+
+ +
+
+ + + + + + + \ No newline at end of file diff --git a/docs/_build/html/genindex.html b/docs/_build/html/genindex.html new file mode 100644 index 0000000..bcce678 --- /dev/null +++ b/docs/_build/html/genindex.html @@ -0,0 +1,103 @@ + + + + + + + + Index — psy-simple 1.3.1 documentation + + + + + + + + + + + + + +
+
+
+ + +
+ + +

Index

+ +
+ +
+ + +
+ +
+
+ +
+
+ + + + + + + \ No newline at end of file diff --git a/docs/_build/html/index.html b/docs/_build/html/index.html new file mode 100644 index 0000000..812dbb5 --- /dev/null +++ b/docs/_build/html/index.html @@ -0,0 +1,119 @@ + + + + + + + + + psy-simple: The psyplot plugin for simple visualizations — psy-simple 1.3.1 documentation + + + + + + + + + + + + + + +
+
+
+ + +
+ +
+

psy-simple: The psyplot plugin for simple visualizations¶

+

+ The documentation of psy-simple is now hosted at, https://psyplot.github.io/psy-simple/. + You should be redirected within 5 seconds. +

+
+
+
+

Indices and tables¶

+ +
+ + +
+ +
+
+ +
+
+ + + + + + + \ No newline at end of file diff --git a/docs/_build/html/installing.html b/docs/_build/html/installing.html new file mode 100644 index 0000000..14e2a16 --- /dev/null +++ b/docs/_build/html/installing.html @@ -0,0 +1,111 @@ + + + + + + + + + Installation — psy-simple 1.3.1 documentation + + + + + + + + + + + + + + + +
+
+
+ + +
+ +
+

Installation¶

+

+ The documentation of psy-simple is now hosted at, https://psyplot.github.io/psy-simple/installing.html. + You should be redirected within 5 seconds. +

+ + +
+ +
+
+ +
+
+ + + + + + + \ No newline at end of file diff --git a/docs/_build/html/objects.inv b/docs/_build/html/objects.inv new file mode 100644 index 0000000..f297de6 Binary files /dev/null and b/docs/_build/html/objects.inv differ diff --git a/docs/_build/html/plot_methods.html b/docs/_build/html/plot_methods.html new file mode 100644 index 0000000..4be586d --- /dev/null +++ b/docs/_build/html/plot_methods.html @@ -0,0 +1,113 @@ + + + + + + + + + psyplot plot methods — psy-simple 1.3.1 documentation + + + + + + + + + + + + + + + +
+
+
+ + +
+ +
+

psyplot plot methods¶

+

+ The documentation of psy-simple is now hosted at, https://psyplot.github.io/psy-simple/plot_methods.html. + You should be redirected within 5 seconds. +

+
+
+ + +
+ +
+
+ +
+
+ + + + + + + \ No newline at end of file diff --git a/docs/_build/html/search.html b/docs/_build/html/search.html new file mode 100644 index 0000000..aef1648 --- /dev/null +++ b/docs/_build/html/search.html @@ -0,0 +1,122 @@ + + + + + + + + Search — psy-simple 1.3.1 documentation + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+ +

Search

+ + + + +

+ Searching for multiple words only shows matches that contain + all words. +

+ + +
+ + + +
+ + + +
+ +
+ + +
+ +
+
+ +
+
+ + + + + + + \ No newline at end of file diff --git a/docs/_build/html/searchindex.js b/docs/_build/html/searchindex.js new file mode 100644 index 0000000..6caac05 --- /dev/null +++ b/docs/_build/html/searchindex.js @@ -0,0 +1 @@ +Search.setIndex({docnames:["api/psy_simple","api/psy_simple.colors","api/psy_simple.plotters","api/psy_simple.plugin","api/psy_simple.widgets","api/psy_simple.widgets.colors","api/psy_simple.widgets.texts","changelog","contribute","generated/psyplot.project.plot.barplot","generated/psyplot.project.plot.combined","generated/psyplot.project.plot.density","generated/psyplot.project.plot.fldmean","generated/psyplot.project.plot.lineplot","generated/psyplot.project.plot.plot2d","generated/psyplot.project.plot.vector","generated/psyplot.project.plot.violinplot","index","installing","plot_methods"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":4,"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:56},filenames:["api/psy_simple.rst","api/psy_simple.colors.rst","api/psy_simple.plotters.rst","api/psy_simple.plugin.rst","api/psy_simple.widgets.rst","api/psy_simple.widgets.colors.rst","api/psy_simple.widgets.texts.rst","changelog.rst","contribute.rst","generated/psyplot.project.plot.barplot.rst","generated/psyplot.project.plot.combined.rst","generated/psyplot.project.plot.density.rst","generated/psyplot.project.plot.fldmean.rst","generated/psyplot.project.plot.lineplot.rst","generated/psyplot.project.plot.plot2d.rst","generated/psyplot.project.plot.vector.rst","generated/psyplot.project.plot.violinplot.rst","index.rst","installing.rst","plot_methods.rst"],objects:{},objnames:{},objtypes:{},terms:{"5":[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19],The:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,18,19],api:[1,2,3,4,5,6],document:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19],gener:[9,10,11,12,13,14,15,16],github:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19],host:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19],html:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,18,19],http:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19],index:17,io:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19],modul:17,now:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19],page:17,plot_method:19,psy:[0,1,2,3,4,5,6,7,9,10,11,12,13,14,15,16,18,19],psy_simpl:0,psyplot:[0,1,2,3,4,5,6,7,8,18],redirect:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19],search:17,second:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19],should:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19],simpl:[0,1,2,3,4,5,6,7,9,10,11,12,13,14,15,16,18,19],within:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19],you:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19]},titles:["API Reference","psy_simple.colors module","psy_simple.plotters module","psy_simple.plugin module","psy_simple.widgets package","psy_simple.widgets.colors module","psy_simple.widgets.texts module","Changelog","Contributing to psy-simple","psyplot.project.plot.barplot","psyplot.project.plot.combined","psyplot.project.plot.density","psyplot.project.plot.fldmean","psyplot.project.plot.lineplot","psyplot.project.plot.plot2d","psyplot.project.plot.vector","psyplot.project.plot.violinplot","psy-simple: The psyplot plugin for simple visualizations","Installation","psyplot plot methods"],titleterms:{The:17,api:0,barplot:9,changelog:7,color:[1,5],combin:10,contribut:8,densiti:11,fldmean:12,indic:17,instal:18,lineplot:13,method:19,modul:[1,2,3,5,6],packag:4,plot2d:14,plot:[9,10,11,12,13,14,15,16,19],plotter:2,plugin:[3,17],project:[9,10,11,12,13,14,15,16],psy:[8,17],psy_simpl:[1,2,3,4,5,6],psyplot:[9,10,11,12,13,14,15,16,17,19],refer:0,simpl:[8,17],submodul:[0,4],subpackag:0,tabl:17,text:6,vector:15,violinplot:16,visual:17,widget:[4,5,6]}}) \ No newline at end of file diff --git a/docs/_static/.gitignore b/docs/_static/.gitignore new file mode 100644 index 0000000..91fd588 --- /dev/null +++ b/docs/_static/.gitignore @@ -0,0 +1 @@ +docs_*.png diff --git a/docs/_static/ncview.png b/docs/_static/ncview.png deleted file mode 100644 index dcfcf3f..0000000 Binary files a/docs/_static/ncview.png and /dev/null differ diff --git a/docs/_static/resize-demo.gif b/docs/_static/resize-demo.gif deleted file mode 100644 index 025c9e5..0000000 Binary files a/docs/_static/resize-demo.gif and /dev/null differ diff --git a/docs/_static/screenshot.png b/docs/_static/screenshot.png deleted file mode 100644 index b43c210..0000000 Binary files a/docs/_static/screenshot.png and /dev/null differ diff --git a/docs/_static/theme_overrides.css b/docs/_static/theme_overrides.css deleted file mode 100644 index 78432dc..0000000 --- a/docs/_static/theme_overrides.css +++ /dev/null @@ -1,10 +0,0 @@ -/* override table width restrictions */ -.wy-table-responsive table td, .wy-table-responsive table th { - white-space: normal; -} - -.wy-table-responsive { - margin-bottom: 24px; - max-width: 100%; - overflow: visible; -} \ No newline at end of file diff --git a/docs/_templates/.gitignore b/docs/_templates/.gitignore new file mode 100644 index 0000000..e69de29 diff --git a/docs/_templates/layout.html b/docs/_templates/layout.html new file mode 100644 index 0000000..d8ddc36 --- /dev/null +++ b/docs/_templates/layout.html @@ -0,0 +1,5 @@ +{% extends "!layout.html" %} + +{% block extrahead %} + +{% endblock %} \ No newline at end of file diff --git a/docs/api/psy_view.dialogs.rst b/docs/api/psy_view.dialogs.rst new file mode 100644 index 0000000..0ef0c5b --- /dev/null +++ b/docs/api/psy_view.dialogs.rst @@ -0,0 +1,9 @@ +psy\_view.dialogs module +======================== + +.. raw:: html + +

+ The documentation of psy-view is now hosted at, https://psyplot.github.io/psy-view/api/psy_view.dialogs.html. + You should be redirected within 5 seconds. +

diff --git a/docs/api/psy_view.ds_widget.rst b/docs/api/psy_view.ds_widget.rst new file mode 100644 index 0000000..7d65a75 --- /dev/null +++ b/docs/api/psy_view.ds_widget.rst @@ -0,0 +1,9 @@ +psy\_view.ds\_widget module +=========================== + +.. raw:: html + +

+ The documentation of psy-view is now hosted at, https://psyplot.github.io/psy-view/api/psy_view.ds_widget.html. + You should be redirected within 5 seconds. +

diff --git a/docs/api/psy_view.plotmethods.rst b/docs/api/psy_view.plotmethods.rst new file mode 100644 index 0000000..c6857cf --- /dev/null +++ b/docs/api/psy_view.plotmethods.rst @@ -0,0 +1,9 @@ +psy\_view.plotmethods module +============================ + +.. raw:: html + +

+ The documentation of psy-view is now hosted at, https://psyplot.github.io/psy-view/api/psy_view.plotmethods.html. + You should be redirected within 5 seconds. +

diff --git a/docs/api/psy_view.rcsetup.rst b/docs/api/psy_view.rcsetup.rst new file mode 100644 index 0000000..6990a52 --- /dev/null +++ b/docs/api/psy_view.rcsetup.rst @@ -0,0 +1,9 @@ +psy\_view.rcsetup module +======================== + +.. raw:: html + +

+ The documentation of psy-view is now hosted at, https://psyplot.github.io/psy-view/api/psy_view.rcsetup.html. + You should be redirected within 5 seconds. +

diff --git a/docs/api/psy_view.rst b/docs/api/psy_view.rst new file mode 100644 index 0000000..2c19c5f --- /dev/null +++ b/docs/api/psy_view.rst @@ -0,0 +1,24 @@ +.. _api: +API Reference +================= + +.. raw:: html + +

+ The documentation of psy-view is now hosted at, https://psyplot.github.io/psy-view/api/psy_view.html. + You should be redirected within 5 seconds. +

+ + +Submodules +---------- + +.. toctree:: + :maxdepth: 4 + :hidden: + + psy_view.dialogs + psy_view.ds_widget + psy_view.plotmethods + psy_view.rcsetup + psy_view.utils diff --git a/docs/api/psy_view.utils.rst b/docs/api/psy_view.utils.rst new file mode 100644 index 0000000..71beb26 --- /dev/null +++ b/docs/api/psy_view.utils.rst @@ -0,0 +1,9 @@ +psy\_view.utils module +====================== + +.. raw:: html + +

+ The documentation of psy-view is now hosted at, https://psyplot.github.io/psy-view/api/psy_view.utils.html. + You should be redirected within 5 seconds. +

diff --git a/docs/apigen.bash b/docs/apigen.bash deleted file mode 100755 index 1e7105c..0000000 --- a/docs/apigen.bash +++ /dev/null @@ -1,13 +0,0 @@ -#!/bin/bash -set -e -# script to automatically generate the psyplot api documentation using -# sphinx-apidoc and sed -sphinx-apidoc -f -M -e -T -o api ../psy_view/ - -# replace chapter title in psy_view.rst -sed -i -e '1,1s/.*/API Reference/' api/psy_view.rst - -# add a label to the main API file -sed -i '1 i .. _api:' api/psy_view.rst - -sphinx-autogen -o generated *.rst */*.rst diff --git a/docs/command_line.rst b/docs/command_line.rst index f771d88..2ea216a 100644 --- a/docs/command_line.rst +++ b/docs/command_line.rst @@ -4,16 +4,11 @@ Command line usage ================== -The :mod:`psy_view.__main__` module defines the command line options for -psy-view. It can be run from the command line via:: - python -m psy-view [options] [arguments] -or simply:: +.. raw:: html - psy-view [options] [arguments] - -.. argparse:: - :module: psy_view - :func: get_parser - :prog: psy-view +

+ The documentation of psy-view is now hosted at, https://psyplot.github.io/psy-view/command_line.html. + You should be redirected within 5 seconds. +

diff --git a/docs/conf.py b/docs/conf.py index 613eecd..57173ef 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -10,43 +10,19 @@ # add these directories to sys.path here. If the directory is relative to the # documentation root, use os.path.abspath to make it absolute, like shown here. # -import os -import os.path as osp -import shutil -import re -import warnings +# import os +# import sys +# sys.path.insert(0, os.path.abspath('.')) -import subprocess as spr - -# note: we need to import pyplot here, because otherwise it might fail to load -# the ipython extension -import matplotlib.pyplot as plt - -from docutils import nodes -from docutils.statemachine import StringList -from docutils.parsers.rst import directives -from docutils.parsers.rst.directives import images - -from sphinx.util.docutils import SphinxDirective - -warnings.filterwarnings("ignore", message=r"\s*Downloading:") # -- Project information ----------------------------------------------------- -import psy_view - -confdir = osp.dirname(__file__) - project = 'psy-view' -copyright = ", ".join( - psy_view.__copyright__.strip().replace("Copyright (C) ", "").splitlines() -) -author = psy_view.__author__ - +copyright = '2021, Philipp S. Sommer' +author = 'Philipp S. Sommer' -version = re.match(r'\d+\.\d+\.\d+', psy_view.__version__).group() # type: ignore -# The full version, including alpha/beta/rc tags. -release = psy_view.__version__ +# The full version, including alpha/beta/rc tags +release = '1.3.1' # -- General configuration --------------------------------------------------- @@ -55,243 +31,27 @@ # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = [ - 'sphinx.ext.doctest', - 'sphinx.ext.intersphinx', - 'sphinx.ext.autosummary', - 'sphinx.ext.viewcode', - 'IPython.sphinxext.ipython_console_highlighting', - 'IPython.sphinxext.ipython_directive', - 'sphinxarg.ext', - 'psyplot.sphinxext.extended_napoleon', - 'autodocsumm', - 'sphinx.ext.todo', ] -rebuild_screenshots = False - -todo_include_todos = True - # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] -# create the api documentation -if not osp.exists(osp.join(osp.dirname(__file__), 'api')): - spr.check_call(['bash', 'apigen.bash']) - # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. # This pattern also affects html_static_path and html_extra_path. -exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] +exclude_patterns = [] +# The master toctree document. +master_doc = 'index' # -- Options for HTML output ------------------------------------------------- # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. # -html_theme = 'sphinx_rtd_theme' +html_theme = 'alabaster' # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". html_static_path = ['_static'] - -autodoc_default_options = { - 'show_inheritance': True, - 'autosummary': True, - } - -not_document_data = ['psy_view.rcsetup.defaultParams', - 'psy_view.rcsetup.rcParams'] - -# -- Options for LaTeX output --------------------------------------------- - -latex_elements = { - # Additional stuff for the LaTeX preamble. - 'preamble': r'\setcounter{tocdepth}{10}' -} - -master_doc = 'index' - -# Grouping the document tree into LaTeX files. List of tuples -# (source start file, target name, title, -# author, documentclass [howto, manual, or own class]). -latex_documents = [ - (master_doc, 'psy-view.tex', u'psy-view Documentation', - u'Philipp S. Sommer', 'manual'), -] - -# -- Options for Epub output ---------------------------------------------- - -# Bibliographic Dublin Core info. -epub_title = project -epub_author = author -epub_publisher = author -epub_copyright = copyright - -# A list of files that should not be packed into the epub file. -epub_exclude_files = ['search.html'] - -# Example configuration for intersphinx: refer to the Python standard library. -intersphinx_mapping = { - 'pandas': ('https://pandas.pydata.org/pandas-docs/stable/', None), - 'numpy': ('https://numpy.org/doc/stable/', None), - 'matplotlib': ('https://matplotlib.org/stable/', None), - 'sphinx': ('https://www.sphinx-doc.org/en/master/', None), - 'xarray': ('https://xarray.pydata.org/en/stable/', None), - 'cartopy': ('https://scitools.org.uk/cartopy/docs/latest/', None), - 'psyplot': ('https://psyplot.github.io/psyplot/', None), - 'psy_simple': ('https://psyplot.github.io/psy-simple/', None), - 'psy_maps': ('https://psyplot.github.io/psy-maps/', None), - 'psyplot_gui': ('https://psyplot.github.io/psyplot-gui/', None), -} - - -def create_screenshot( - code: str, output: str, make_plot: bool = False, enable: bool = None, - plotmethod: str = "mapplot", minwidth=None, - generate=rebuild_screenshots, - ) -> str: - """Generate a screenshot of the GUI.""" - from PyQt5.QtWidgets import QApplication, QSizePolicy # pylint: disable=no-name-in-module - from psy_view.ds_widget import DatasetWidget - from psyplot.data import open_dataset - - output = osp.join("_static", output) - - app = QApplication.instance() - if app is None: - app = QApplication([]) - - if not generate and osp.exists(output): - return output - - ds_widget = DatasetWidget(open_dataset(osp.join(confdir, "demo.nc"))) - ds_widget.plotmethod = plotmethod - - if make_plot: - ds_widget.variable_buttons["t2m"].click() - - if minwidth: - ds_widget.setMinimumWidth(minwidth) - - options = {"ds_widget": ds_widget} - exec("w = " + code, options) - w = options['w'] - - if enable is not None: - w.setEnabled(enable) - - w.setSizePolicy(QSizePolicy.Maximum, QSizePolicy.Maximum) - - ds_widget.show() # to make sure we can see everything - - w.grab().save(osp.join(confdir, output)) - ds_widget.close_sp() - ds_widget.close() - return output - - -def plotmethod(argument): - return directives.choice(argument, ("mapplot", "lineplot", "plot2d")) - - -class ScreenshotDirective(SphinxDirective): - """A directive to generate screenshots of the GUI. - - Usage:: - - .. screenshot:: - :width: 20px - ... other image options ... - """ - - has_content = False - - option_spec = images.Image.option_spec.copy() - - option_spec["plot"] = directives.flag - option_spec["enable"] = directives.flag - option_spec["plotmethod"] = plotmethod - option_spec["minwidth"] = directives.positive_int - option_spec["generate"] = directives.flag - - target_directive = "image" - - required_arguments = 2 - optional_arguments = 0 - - def add_line(self, line: str) -> None: - """Append one line of generated reST to the output.""" - source = self.get_source_info() - if line.strip(): # not a blank line - self.result.append(line, *source) - else: - self.result.append('', *source) - - def generate(self) -> None: - """Generate the content.""" - self.add_line(f".. {self.target_directive}:: {self.img_name}") - - for option, val in self.options.items(): - self.add_line(f" :{option}: {val}") - - def run(self): - """Run the directive.""" - self.result = StringList() - - make_plot = self.options.pop("plot", False) is None - enable = True if self.options.pop("enable", False) is None else None - - rebuild_screenshot = ( - self.options.pop("generate", False) or - self.env.app.config.rebuild_screenshots - ) - - self.img_name = create_screenshot( - *self.arguments, make_plot=make_plot, enable=enable, - plotmethod=self.options.pop("plotmethod", None) or "mapplot", - minwidth=self.options.pop("minwidth", None), - generate=rebuild_screenshot, - ) - - self.generate() - - node = nodes.paragraph() - node.document = self.state.document - self.state.nested_parse(self.result, 0, node) - - return node.children - - -class ScreenshotFigureDirective(ScreenshotDirective): - """A directive to generate screenshots of the GUI. - - Usage:: - - .. screenshot-figure:: - :width: 20px - ... other image options ... - - some caption - """ - - target_directive = "figure" - - has_content = True - - def generate(self): - super().generate() - - if self.content: - self.add_line('') - indent = " " - for line in self.content: - self.add_line(indent + line) - - -def setup(app): - app.add_directive('screenshot', ScreenshotDirective) - app.add_directive("screenshot-figure", ScreenshotFigureDirective) - app.add_config_value('rebuild_screenshots', rebuild_screenshots, 'env') - app.add_css_file("theme_overrides.css") diff --git a/docs/contribute.rst b/docs/contribute.rst new file mode 100644 index 0000000..2039b23 --- /dev/null +++ b/docs/contribute.rst @@ -0,0 +1,11 @@ +.. _how-to-contribute: + +Contributing to psy-view +========================== + +.. raw:: html + +

+ The documentation of psy-view is now hosted at, https://psyplot.github.io/psy-view/contribute.html. + You should be redirected within 5 seconds. +

diff --git a/docs/demo.nc b/docs/demo.nc deleted file mode 100644 index e6b9dbf..0000000 Binary files a/docs/demo.nc and /dev/null differ diff --git a/docs/environment.yml b/docs/environment.yml deleted file mode 100644 index 4142528..0000000 --- a/docs/environment.yml +++ /dev/null @@ -1,12 +0,0 @@ -name: psy-view-docs -channels: - - local - - psyplot/label/master - - conda-forge -dependencies: - - python=3.8 - - sphinx - - sphinx_rtd_theme - - psy-view - - autodocsumm - - sphinx-argparse diff --git a/docs/getting-started.rst b/docs/getting-started.rst index 0f1dd3a..a41d1d0 100644 --- a/docs/getting-started.rst +++ b/docs/getting-started.rst @@ -3,100 +3,10 @@ Getting started =============== -.. highlight:: bash -Binder examples ---------------- -You can run a demo of psy-view in your webbrowser by clicking |mybinder|. This -will show you a remote desktop (after some time for launching the server) where -you can test psy-view (and the psyplot-gui) for different test files. +.. raw:: html -.. _binder-upload: - -Uploading your own data -^^^^^^^^^^^^^^^^^^^^^^^ -You can also upload your own data to visualize it on the binder instance. Once -you see the remote desktop, your URL will be something like -``https://hub.gke2.mybinder.org/user/psyplot-psy-view-.../desktop/?token=...``. - -1. open a new tab -2. take the URL from the previous tab and replace the last part from the url - (``desktop/?token=...``) with ``tree/Desktop``). -3. Now click the :guilabel:`Upload` button and select the file you want to upload -4. Upload the file -5. The file you uploaded will now appear on the desktop in the previous tab - - -.. |mybinder| image:: https://static.mybinder.org/badge_logo.svg - :target: https://mybinder.org/v2/gh/psyplot/psy-view/master?urlpath=%2Fdesktop - :alt: mybinder-demo - - -Run it locally --------------- - -Congratulations! You successfully installed psy-view on your system (if not, -head over to :ref:`install`). - -This small example shows you, how to make a simple georeferenced plot. You can -use the :download:`demo.nc` file for this demo. - -Start the GUI from the command line via:: - - psy-view demo.nc - -A widget will open that looks like - -.. screenshot:: ds_widget docs-getting-started-ds_widget.png - -You see a button for the `t2m` variable: |t2m|. Click it, and it opens a plot -like this: - -.. ipython:: - :suppress: - - In [1]: import psyplot.project as psy - ...: with psy.plot.mapplot( - ...: "demo.nc", name="t2m", - ...: cmap="viridis", - ...: ) as sp: - ...: sp.export("docs-getting-started-example.png") - -.. image:: docs-getting-started-example.png - -Now use the |btn_cmap| button to select a different colormap, edit the -projection via the |btn_proj| button, or update the dimensions via the -navigation buttons: |btn_prev|, |btn_next|, |btn_animate_backward| and -|btn_animate_forward|. - -More documentation about the GUI elements is provided in our -:ref:`User guide `. And if you are interested in the python code, -checkout the :ref:`API reference `. - - -.. |t2m| screenshot:: ds_widget.variable_buttons['t2m'] docs-getting-started-t2m.png - :height: 1.3em - -.. |btn_cmap| screenshot:: ds_widget.plotmethod_widget.btn_cmap docs-getting-started-btn_cmap.png - :plot: - :height: 1.3em - -.. |btn_proj| screenshot:: ds_widget.plotmethod_widget.btn_proj docs-getting-started-btn_proj.png - :plot: - :height: 1.3em - -.. |btn_prev| screenshot:: ds_widget.btn_prev docs-btn_prev.png - :height: 1.3em - :enable: - -.. |btn_next| screenshot:: ds_widget.btn_next docs-btn_next.png - :height: 1.3em - :enable: - -.. |btn_animate_backward| screenshot:: ds_widget.btn_animate_backward docs-btn_animate_backward.png - :height: 1.3em - :enable: - -.. |btn_animate_forward| screenshot:: ds_widget.btn_animate_forward docs-btn_animate_forward.png - :height: 1.3em - :enable: \ No newline at end of file +

+ The documentation of psy-view is now hosted at, https://psyplot.github.io/psy-view/getting-started.html. + You should be redirected within 5 seconds. +

diff --git a/docs/index.rst b/docs/index.rst index 75be6b7..5d4209a 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,165 +1,27 @@ -.. psy-view documentation master file, created by - sphinx-quickstart on Wed Jul 8 21:08:22 2020. +.. psyplot documentation master file, created by + sphinx-quickstart on Wed Sep 22 19:43:59 2021. You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. .. _psy-view: -Welcome to psy-view! -==================== +psy-view: The psyplot plugin for simple visualizations +======================================================== -.. image:: _static/screenshot.png - :width: 50% - :alt: GUI screenshot - :align: center +.. raw:: html -*psy-view* defines a viewer application for netCDF files, that is highly -motivated by the ncview_ software but entirely built upon the psyplot framework. -It supports strucutured and unstructured grids and provides an intuitive -graphical user interface to quickly dive into the data inside a netCDF file. +

+ The documentation of psy-view is now hosted at, https://psyplot.github.io/psy-view/. + You should be redirected within 5 seconds. +

-.. _ncview: http://meteora.ucsd.edu/~pierce/ncview_home_page.html - -.. warning:: - - This package is currently under development and we highly appreciate your - feedback! Please try it out yourself and, if you would like to see more features, - find bugs or want to say anything else, please leave your comments and - experiences at https://github.com/psyplot/psy-view/issues or send a mail to - psyplot@hzg.de. - -.. start-badges - -.. only:: html and not epub - - .. list-table:: - :stub-columns: 1 - :widths: 10 90 - - * - docs - - |docs| |mybinder| - * - tests - - |circleci| |appveyor| |codecov| - * - package - - |version| |conda| |github| |zenodo| - * - implementations - - |supported-versions| |supported-implementations| - * - get in touch - - |gitter| |mailing-list| |issues| - - .. |docs| image:: https://img.shields.io/github/deployments/psyplot/psy-view/github-pages - :alt: Documentation - :target: http://psyplot.github.io/psy-view/ - - .. |mybinder| image:: https://mybinder.org/badge_logo.svg - :target: https://mybinder.org/v2/gh/psyplot/psy-view/master?urlpath=%2Fdesktop - :alt: mybinder.org - - .. |circleci| image:: https://circleci.com/gh/psyplot/psy-view/tree/master.svg?style=svg - :alt: CircleCI - :target: https://circleci.com/gh/psyplot/psy-view/tree/master - - .. |appveyor| image:: https://ci.appveyor.com/api/projects/status/a7qxvvwt0e41j32h/branch/master?svg=true - :alt: AppVeyor - :target: https://ci.appveyor.com/project/psyplot/psy-view/branch/master - - .. |codecov| image:: https://codecov.io/gh/psyplot/psy-view/branch/master/graph/badge.svg - :alt: Coverage - :target: https://codecov.io/gh/psyplot/psy-view - - .. |conda| image:: https://anaconda.org/conda-forge/psy-view/badges/version.svg - :alt: conda - :target: https://anaconda.org/conda-forge/psy-view - - .. |github| image:: https://img.shields.io/github/release/psyplot/psy-view.svg - :target: https://github.com/psyplot/psy-view/releases/latest - :alt: Latest github release - - .. |version| image:: https://img.shields.io/pypi/v/psy-view.svg?style=flat - :alt: PyPI Package latest release - :target: https://pypi.python.org/pypi/psy-view - - .. |supported-versions| image:: https://img.shields.io/pypi/pyversions/psy-view.svg?style=flat - :alt: Supported versions - :target: https://pypi.python.org/pypi/psy-view - - .. |supported-implementations| image:: https://img.shields.io/pypi/implementation/psy-view.svg?style=flat - :alt: Supported implementations - :target: https://pypi.python.org/pypi/psy-view - - .. |gitter| image:: https://img.shields.io/gitter/room/psyplot/community.svg?style=flat - :target: https://gitter.im/psyplot/community - :alt: Gitter - - .. |mailing-list| image:: https://img.shields.io/badge/join-mailing%20list-brightgreen.svg?style=flat - :target: https://www.listserv.dfn.de/sympa/subscribe/psyplot - :alt: DFN mailing list - - .. |issues| image:: https://img.shields.io/github/issues-raw/psyplot/psy-view.svg?style=flat - :target: https://github.com/psyplot/psy-view/issues - :alt: GitHub issues - - .. |zenodo| image:: https://zenodo.org/badge/249615633.svg - :alt: Zenodo - :target: https://zenodo.org/badge/latestdoi/249615633 - -.. end-badges - -Features --------- -Some of the most important features offered by psy-view are: - -- intuitive GUI to select variables, dimensions, slices, etc. and change the - plot -- automatically decodes CF-conventions and supports unstructured grid, such as - ICON_ or UGRID_ -- animation interface -- different projections -- implemented in psyplot-gui_ for full flexibility (if desired) - -Interested? Read more in the section :ref:`psy-view-vs-ncview`. - -.. _ICON: https://mpimet.mpg.de/en/science/modeling-with-icon/icon-configurations -.. _UGRID: http://ugrid-conventions.github.io/ugrid-conventions/ -.. _psyplot-gui: https://psyplot.github.io/psyplot-gui .. toctree:: - :maxdepth: 2 - :caption: Contents: - - installing - getting-started - user-guide - ncview - command_line - api/psy_view - todo - - -Get in touch ------------- -Any quesions? Do not hessitate to get in touch with the psyplot developers. - -- Create an issue at the `bug tracker`_ -- Chat with the developers in out `channel on gitter`_ -- Subscribe to the `mailing list`_ and ask for support -- Sent a mail to psyplot@hzg.de - -See also the `code of conduct`_, and our `contribution guide`_ for more -information and a guide about good bug reports. - -.. _bug tracker: https://github.com/psyplot/psy-view -.. _channel on gitter: https://gitter.im/psyplot/community -.. _mailing list: https://www.listserv.dfn.de/sympa/subscribe/psyplot -.. _code of conduct: https://github.com/psyplot/psyplot/blob/master/CODE_OF_CONDUCT.md -.. _contribution guide: https://github.com/psyplot/psyplot/blob/master/CONTRIBUTING.md - - - - -Indices and tables -================== - -* :ref:`genindex` -* :ref:`modindex` -* :ref:`search` + :maxdepth: 1 + :hidden: + + installing + plot_methods + contribute + api/psy_view + changelog diff --git a/docs/installing.rst b/docs/installing.rst index ef70008..8ca85ed 100644 --- a/docs/installing.rst +++ b/docs/installing.rst @@ -1,192 +1,13 @@ .. _install: -Installation -============ - .. highlight:: bash -How to install --------------- - -.. _install-conda: - -Installation using conda -^^^^^^^^^^^^^^^^^^^^^^^^ - -We strongly recommend to install psy-view via the anaconda package -manager. Either by downloading anaconda_, or miniconda_ for you operating -system. If you installed `conda` for your operating system, open the -terminal (or `Anaconda Prompt` on Windows) and type:: - - $ conda create -n psyplot -c conda-forge psy-view - -to install it. On Linux and OS X, you may instead want to type:: - - $ conda create -n psyplot -c conda-forge --override-channels psy-view - -in order to not mix the anaconda defaults and and conda-forge channel, because -mixing them can sometimes cause incompatibilities. - -The commands above installed psy-view and all it's necessary -dependencies into a separate environment that you can activate via:: - - $ conda activate psyplot - -Now launch the GUI via typing:: - - $ psy-view - -in the terminal (Anaconda Prompt). On Windows, you will also have a -corresponding entry in the start menu. - -Note that you will always have to activate the conda environment -(`conda activate psyplot`) in order to start `psy-view`. The advantage, however, -is that other packages installed via conda are not affected by the dependencies -of psy-view. - -.. note:: - - Alternatively, you can also install psy-view directly in an existing conda - environment by using:: - - $ conda install -c conda-forge psy-view - - -.. _install-pip: - -Installation using pip -^^^^^^^^^^^^^^^^^^^^^^ -If you do not want to use conda for managing your python packages, you can also -use the python package manager ``pip`` and install via:: - - $ pip install psy-view - -But we strongly recommend that you make sure you have the :ref:`dependencies` -installed before. - -.. _install-source: - -Installation from source -^^^^^^^^^^^^^^^^^^^^^^^^ -To install it from source, make sure you have the :ref:`dependencies` -installed, clone the github_ repository via:: - - git clone https://github.com/psyplot/psy-view.git - -and install it via:: - - python -m pip install ./psy-view - - -.. _dependencies: - -Dependencies ------------- - -Required dependencies -^^^^^^^^^^^^^^^^^^^^^ -Psy-view supports all python versions greater than 3.7. Other dependencies are - -- psyplot_ and `the corresponding dependencies`_ -- the psyplot plugin psy-maps_ -- the general GUI for psyplot, psyplot-gui_ -- netCDF4_ - - -.. _conda: https://conda.io/docs/ -.. _anaconda: https://www.anaconda.com/products/individual -.. _miniconda: https://docs.conda.io/en/latest/miniconda.html -.. _psyplot: https://psyplot.github.io/psyplot/installing.html -.. _the corresponding dependencies: https://psyplot.github.io/psyplot/installing.html#dependencies -.. _psy-maps: https://psyplot.github.io/psy-maps/installing.html -.. _psyplot-gui: https://psyplot.github.io/psyplot-gui/installing.html -.. _netCDF4: https://github.com/Unidata/netcdf4-python - - -Running the tests ------------------ -We us pytest_ to run our tests. So install pytest and pytest-qt via:: - - $ conda install -c conda-forge pytest pytest-qt - -clone the github repository via:: - - $ git clone https://github.com/psyplot/psy-view.git - -And from within the cloned repository, run - - $ pytest -xv - -Alternatively, you can build the conda recipe at ``ci/conda-recipe`` which -will also run the test suite. Just install `conda-build` via:: - - $ conda install -n base conda-build - -and build the recipe via:: - - $ conda build ci/conda-recipe - - -.. _install-docs: - -Building the docs ------------------ -To build the docs, check out the github_ repository and install the -requirements in ``'docs/environment.yml'``. The easiest way to do this is, -again, via conda:: - - $ conda env create -f docs/environment.yml - $ conda activate psy-view-docs - -You also need to install the sphinx_rtd_theme via:: - - $ pip install sphinx_rtd_theme - -Then build the docs via:: - - $ cd docs - $ make html - - -.. _github: https://github.com/psyplot/psy-view -.. _pytest: https://pytest.org/en/latest/contents.html - - -.. _uninstall: - -Uninstallation --------------- -The uninstallation depends on the system you used to install psyplot. Either -you did it via :ref:`conda ` (see -:ref:`uninstall-conda`), via :ref:`pip ` or from the -:ref:`source files ` (see :ref:`uninstall-pip`). - -Anyway, if you may want to remove the psyplot configuration files. If you did -not specify anything else (see :func:`psyplot.config.rcsetup.psyplot_fname`), -the configuration files for psyplot are located in the user home directory. -Under linux and OSX, this is ``$HOME/.config/psyplot``. On other platforms it -is in the ``.psyplot`` directory in the user home. - -.. _uninstall-conda: - -Uninstallation via conda -^^^^^^^^^^^^^^^^^^^^^^^^ -If you installed psy-view via :ref:`conda ` into a separate -environment, simply run:: - - conda env remove -n psyplot # assuming you named the environment psyplot - -If you want to uninstall psy-view, only, type:: - - conda uninstall psy-view - -.. _uninstall-pip: - -Uninstallation via pip -^^^^^^^^^^^^^^^^^^^^^^ -Uninstalling via pip simply goes via:: +Installation +============ - pip uninstall psy-view +.. raw:: html -Note, however, that you should use :ref:`conda ` if you -installed it via conda. +

+ The documentation of psy-view is now hosted at, https://psyplot.github.io/psy-view/installing.html. + You should be redirected within 5 seconds. +

diff --git a/docs/ncview.rst b/docs/ncview.rst index 9591eed..255a01f 100644 --- a/docs/ncview.rst +++ b/docs/ncview.rst @@ -2,108 +2,11 @@ psy-view vs. ncview =================== -When developping *psy-view*, we had the intuitiveness of ncview_ in mind, a -light-weight graphical user interface to visualize the contents of netCDF files. -In general, `psy-view` can do everything that `ncview` does, and more. -.. image:: _static/ncview.png - :alt: ncview screenshot - :target: http://meteora.ucsd.edu/~pierce/ncview_home_page.html +.. raw:: html -.. _ncview: http://meteora.ucsd.edu/~pierce/ncview_home_page.html - -The following table tries to summarize the differences of the features for both -softwares. If you feel like anything is missing or wrong, please tell us by -creating a new issue at https://github.com/psyplot/psy-view/issues/ - -.. list-table:: psy-view vs. ncview - :stub-columns: 1 - :header-rows: 1 - :widths: 2 4 2 - - * - Feature - - psy-view - - ncview - * - supported grids - - - * rectilinear (i.e. standard :math:`nx\times ny` grid) - * ICON_ (triangular, hexagonal, etc.) - * UGRID_ (triangular, hexagonal, etc.) - - rectilinear - * - supported plots - - - * georeferenced plots - * standard 2D-plots - * line plots - - - * georeferenced plots - * standard 2D-plots - * line plots - * - mouse features - - - * plot a time series when clicking on a plot - * show coordinates and data when hovering the plot - - - * plot a time series when clicking on a plot - * show coordinates and data when hovering the plot - * - View the data - - not yet implemented - - comes with a simple and basic editor - * - image export - - all common formats (e.g. - :abbr:`PDF (Portable Document Format)`, - :abbr:`PNG (Portable Network Graphics)`, - :abbr:`GIF (Graphics Interchange Format)`, etc.) with high resolution - - :abbr:`PS (PostScript)` - * - animation export - - GIF, MP4 (using ffmpeg or imagemagick) - - .. note:: - - This is a beta feature - - - not implemented - * - :abbr:`GUI (Graphical User Interface`) startup time - - fast locally, slow via X11 - - fast - * - projection support - - - * decodes CF-conformal grid_mapping_ attributes - * flexibly choose the `projection of the plot via cartopy`_ - - - * decodes CF-conformal grid_mapping_ attributes - * plots on standard lat-lon projection only - * - supported files - - anything that is supported by xarray (netCDF, GRIB, GeoTIFF, etc.) - - .. todo:: - - add more documentation for supported file types - - netCDF files only - * - Language - - Entirely written in Python with the use of - - * xarray_ - * matplotlib_ - * PyQt5_ - * cartopy_ - - Entirely written in C - * - Extensibility - - psy-view is built upon psyplot, so you can - - * export the plot settings - * use it in python scripts - * use the more general `psyplot GUI`_ - - cannot be extended - - -.. _grid_mapping: http://cfconventions.org/Data/cf-conventions/cf-conventions-1.8/cf-conventions.html#appendix-grid-mappings -.. _projection of the plot via cartopy: https://scitools.org.uk/cartopy/docs/latest/reference/crs.html#list-of-projections -.. _xarray: http://xarray.pydata.org/en/stable/ -.. _matplotlib: https://matplotlib.org/ -.. _PyQt5: https://riverbankcomputing.com/software/pyqt -.. _cartopy: https://scitools.org.uk/cartopy/docs/latest -.. _psyplot GUI: https://psyplot.github.io/psyplot-gui/ -.. _ICON: https://mpimet.mpg.de/en/science/modeling-with-icon/icon-configurations -.. _UGRID: http://ugrid-conventions.github.io/ugrid-conventions/ +

+ The documentation of psy-view is now hosted at, https://psyplot.github.io/psy-view/ncview.html. + You should be redirected within 5 seconds. +

diff --git a/docs/todo.rst b/docs/todo.rst index 1892d81..6820e85 100644 --- a/docs/todo.rst +++ b/docs/todo.rst @@ -3,4 +3,10 @@ ToDos ===== -.. todolist:: \ No newline at end of file + +.. raw:: html + +

+ The documentation of psy-view is now hosted at, https://psyplot.github.io/psy-view/todo.html. + You should be redirected within 5 seconds. +

diff --git a/docs/user-guide.rst b/docs/user-guide.rst index 4dd7de0..2d784af 100644 --- a/docs/user-guide.rst +++ b/docs/user-guide.rst @@ -3,547 +3,9 @@ User guide =============== -.. highlight:: bash +.. raw:: html -Starting the GUI ----------------- - -Assuming that you :ref:`installed ` psy-view, you can start it by -typing:: - - $ psy-view - -in the terminal (or Anaconda Prompt on Windows). On windows you additionally -have the opportunity to start it from the start menu (just search for -psy-view), assuming that you have :ref:`installed it via conda `. - -You can also directly pass a path to a netCDF file, e.g.:: - - $ psy-view demo.nc - -to open it. You can also directly select a variable for plotting via the -``-n`` option, e.g.:: - - $ psy-view demo.nc -n t2m - -Please see the section :ref:`command-line` for more information, or type:: - - $ psy-view --help - -in the terminal. - -.. note:: - - The psy-view widget is also available from the `psyplot GUI`_. Just type:: - - $ psyplot - - in the terminal to start it from there. See also :ref:`psyplot-gui-embed`. - - -.. _psyplot GUI: https://psyplot.github.io/psyplot-gui - - -.. _user-guide-gui: - -The GUI -------- - -The usage of psy-view should be quite intuitive and this small guide gives you -a quick intro into the central elements. Please let us know if you -encounter any problems. - -.. screenshot-figure:: ds_widget docs-ds_widget.png - :plot: - - psy-views central element: the dataset widget. - -The dataset widget is the central element of psy-view. It runs as a standalone -application, or within the psyplot gui (see :ref:`psyplot-gui-embed`). - -Resizing the GUI elements -^^^^^^^^^^^^^^^^^^^^^^^^^ -The widget is made flexible such that you can adapt the heights of the -individual elements. Just move your cursor between the elements to change their -size. - -.. only:: html - - The following screencast illustrates this functionality: - - .. image:: _static/resize-demo.gif - -The central elements (from top to bottom) are presented in the next sections. - -.. _user-guide-open: - -Open a netCDF file -^^^^^^^^^^^^^^^^^^ - -.. screenshot:: ds_widget.open_widget docs-open_widget.png - -Click the |btn_open| button to select a netCDF file from the disk, or directly -enter the path in the line widget. You can open multiple datasets at the -same time within the widget. The selection of the current dataset can be -done through the dataset tree (see below) - - -.. |btn_open| screenshot:: ds_widget.btn_open docs-btn_open.png - :width: 1.3em - - -.. _user-guide-ds_tree: - -View the dataset -^^^^^^^^^^^^^^^^ - -.. screenshot:: ds_widget.ds_tree docs-ds_tree.png - -Here you can see all open datasets and select the one you want to -visualize. Expand the items to get more information about variables and -their attributes. - -.. _user-guide-navigation: - -Navigate and export -^^^^^^^^^^^^^^^^^^^ - -.. screenshot:: ds_widget.navigation_box.parentWidget() docs-navigation.png - :plot: - -In the top row, you can increase or decrease the dimension of the plotted variable. -Clicking |btn_prev| (or |btn_next|) decreases (or increases) the selected -dimension, whereas |btn_animate_backward| and |btn_animate_forward| makes an -animation. You can control the speed (i.e. frames per second) of the -animation via the slider next to the control |sl_interval| |lbl_interval| - -The |btn_export| menu allows you to export your plots as images files, -animations or to export the plot settings for later usage. The |btn_preset| -button lets you select custom presets for your plots (see the -:ref:`psyplot docs `). - -The |btn_reload| button finally let's you close all open figures and datasets -and automatically recreates the figures with the same settings. This can be -very useful when the file on your disk changed, and you just want to see the -latest version. - -.. |btn_prev| screenshot:: ds_widget.btn_prev docs-btn_prev.png - :height: 1.3em - :enable: - -.. |btn_next| screenshot:: ds_widget.btn_next docs-btn_next.png - :height: 1.3em - :enable: - -.. |btn_animate_backward| screenshot:: ds_widget.btn_animate_backward docs-btn_animate_backward.png - :height: 1.3em - :enable: - -.. |btn_animate_forward| screenshot:: ds_widget.btn_animate_forward docs-btn_animate_forward.png - :height: 1.3em - :enable: - -.. |sl_interval| screenshot:: ds_widget.sl_interval docs-sl_interval.png - :height: 1.3em - :enable: - -.. |lbl_interval| screenshot:: ds_widget.lbl_interval docs-lbl_interval.png - :height: 1.3em - :enable: - -.. |btn_preset| screenshot:: ds_widget.btn_preset docs-btn_preset.png - :height: 1.3em - :enable: - -.. |btn_export| screenshot:: ds_widget.btn_export docs-btn_export.png - :height: 1.3em - :enable: - -.. |btn_reload| screenshot:: ds_widget.btn_reload docs-btn_reload.png - :height: 1.3em - :enable: - -.. _user-guide-select-plot: - -Select the active plot -^^^^^^^^^^^^^^^^^^^^^^ - -.. screenshot:: ds_widget.array_frame docs-array_frame.png - :plot: - -The next section let's you switch between the different open plots. Once you -have created a new plot with one of the variable buttons (see -:ref:`below `), you can - -- create additional plots by clicking the |btn_add| button. This will open a - dialog to select a variable which is then plotted with the current plotmethod -- close existing plots by clicking the |btn_del| button. -- switch between the plots using the combo box |combo_array| which allows you - to change the appearence of a different plot. - -.. |btn_add| screenshot:: ds_widget.btn_add docs-btn_add.png - :width: 1.3em - :enable: - -.. |btn_del| screenshot:: ds_widget.btn_del docs-btn_del.png - :width: 1.3em - :enable: - -.. |combo_array| screenshot:: ds_widget.combo_array docs-combo_array.png - :height: 1.3em - :plot: - - -.. _user-guide-plotmethod: - -Select the plot method -^^^^^^^^^^^^^^^^^^^^^^ - -.. screenshot:: ds_widget.plot_tabs docs-plot_tabs.png - :plot: - -psy-view (currently) supports three of the psyplot plot methods. - -- :attr:`~psy_simple:psyplot.project.plot.plot2d` for 2D scalar fields - (rectilinear or unstructured, see the section :ref:`user-guide-plot2d`) -- :attr:`~psy_maps:psyplot.project.plot.mapplot` for **georeferenced** 2D scalar - fields (rectilinear or unstructured, see the section :ref:`user-guide-mapplot`) -- :attr:`~psy_simple:psyplot.project.plot.lineplot` for 1D lines (see the - section , see the section :ref:`user-guide-lineplot`) - -.. _user-guide-mapplot: - -mapplot -~~~~~~~ - -.. ipython:: - :suppress: - - In [1]: import psyplot.project as psy - ...: with psy.plot.mapplot( - ...: "demo.nc", name="t2m", - ...: cmap="viridis", xgrid=False, ygrid=False, - ...: ) as sp: - ...: sp.export("docs-mapplot-example.png") - -.. image:: docs-mapplot-example.png - -.. screenshot:: ds_widget.plotmethod_widget docs-mapplot.png - :plot: - :plotmethod: mapplot - - -For georeferenced 2D-scalar fields (or more than 2D), you have the following -options: - -- clicking on a grid cell in the plot generates a line plot of the variable at - that location (as you know it from ncview). The x-axis is determined by the - dimension you chose in the navigation (see :ref:`user-guide-navigation`). -- the colormap button |btn_cmap| changes the colormap to another preset -- the |btn_cmap_settings| button opens a dialog for more advanced color settings -- the |btn_proj| button switches to other projections for the basemap -- the |btn_proj_settings| button opens a dialog for formatting the background - (meridionals, parallels, land color, ocean color, coastlines, etc.) -- the :guilabel:`Plot type` menu |combo_plot| let's you select the type of - plotting. You can choose one of the following options - - Default - This mode uses an efficient algorithm for regular lat-lon meshes (using - matplotlibs :func:`~matplotlib.pyplot.pcolormesh` function), or an - explicit drawing of the individual grid cell polygons for unstructured - grids (see `Gridcell polygons` below). These two methods draw each grid - cells explicitly. Gridcell boundaries are thereby extracted following the - CF (or UGRID)-Conventions. If this is not possible, they are interpolated - from the gridcell coordinates. - Filled contours - Different from the `Default` method this is not visualizing each cell - individually, but instead plots the contours using matplotlibs - :func:`~matplotlib.pyplot.contourf` function. - Contours - Similar to `Filled contours`, but we only draw the outlines of the contour - areas using matplotlibs :func:`~matplotlib.pyplot.contour` function. - Gridcell polygons - This mode (which is the default for unstructured grids (not curvilinear - grids) draws each grid cell individually using a variant of matplotlibs - :func:`~matplotlib.pyplot.pcolor` function - Disable - Make no plotting at all. This can be useful if you want to display the - datagrid only (see next point) - - More information on the plot options can be found in the docs of the - :attr:`~psy_maps.plotters.FieldPlotter.plot` formatoption. - -- the |btn_datagrid| toggles the visibility of grid cell boundaries -- the |btn_labels| button opens a dialog to edit colorbar labels, titles, etc. - -Furthermore you have a couple of dropdowns: - -x- and y-dimension - This is the dimension in the netCDF variable that represents the longitudinal - (latitudinal) dimension. -x- and y-coordinate - This is the coordinate in the netCDF file that is used for the finally to - visualize the data (equivalent to the `CF-conventions coordinates attribute`_ - of a netCDF variable.) - -psyplot automatically decodes the variable and sets x- and y-dimension, as well -as the appropriate coordinate. These dropdowns, however, let you modify the -automatic choice of psyplot. - -.. _CF-conventions coordinates attribute: http://cfconventions.org/Data/cf-conventions/cf-conventions-1.8/cf-conventions.html#coordinate-types - -.. |btn_cmap| screenshot:: ds_widget.plotmethod_widget.btn_cmap docs-mapplot-btn_cmap.png - :height: 1.3em - :plot: - -.. |btn_cmap_settings| screenshot:: ds_widget.plotmethod_widget.btn_cmap_settings docs-mapplot-btn_cmap_settings.png - :width: 1.3em - :plot: - -.. |btn_proj| screenshot:: ds_widget.plotmethod_widget.btn_proj docs-mapplot-btn_proj.png - :height: 1.3em - :plot: - -.. |btn_proj_settings| screenshot:: ds_widget.plotmethod_widget.btn_proj_settings docs-mapplot-btn_proj_settings.png - :width: 1.3em - :plot: - -.. |combo_plot| screenshot:: ds_widget.plotmethod_widget.combo_plot docs-mapplot-combo_plot.png - :height: 1.3em - :plot: - -.. |btn_datagrid| screenshot:: ds_widget.plotmethod_widget.btn_datagrid docs-mapplot-btn_datagrid.png - :height: 1.3em - :plot: - -.. |btn_labels| screenshot:: ds_widget.plotmethod_widget.btn_labels docs-mapplot-btn_labels.png - :height: 1.3em - :plot: - - -.. _user-guide-plot2d: - -plot2d -~~~~~~ - -.. ipython:: - :suppress: - - In [1]: import psyplot.project as psy - ...: with psy.plot.plot2d( - ...: "demo.nc", name="t2m", - ...: cmap="viridis", - ...: ) as sp: - ...: sp.export("docs-plot2d-example.png") - -.. image:: docs-plot2d-example.png - -.. screenshot:: ds_widget.plotmethod_widget docs-plot2d.png - :plot: - :plotmethod: plot2d - -Simple 2D plots are also possible for variables with 2 dimensions and more (or -scalar fields on an unstructured grid). The options are the same as for -:ref:`mapplot `, but for obvious reasons there are no -projection and basemap settings. - - -.. _user-guide-lineplot: - -lineplot -~~~~~~~~ - -.. ipython:: - :suppress: - :okwarning: - - In [1]: import psyplot.project as psy - ...: with psy.plot.lineplot( - ...: "demo.nc", name="t2m", x=0, y=[0, 15], z=0, - ...: xticklabels='%B', xticks='data', - ...: legendlabels='%(y)1.0f°N', - ...: legend='lower right', - ...: ylabel='{desc}', - ...: ) as sp: - ...: sp.export("docs-lineplot-example.png") - -.. image:: docs-lineplot-example.png - -.. screenshot:: ds_widget.plotmethod_widget docs-lineplot.png - :plot: - :plotmethod: lineplot - - -The lineplot visualizes your variables as a 1D line. This widget provides the -following functionalities: - - -- choose the x-dimension using the dimension dropdown |combo_dims| -- add new lines to the plot using the |lineplot.btn_add| button -- remove lines from the plot using the |lineplot.btn_del| button -- switch the current line using the dropdown |combo_lines| - -.. note:: - - Changing the variable (see :ref:`user-guide-variables`) or the - dimensions (see :ref:`user-guide-dimensions`) only affects the current - line that you can select with the |combo_lines| dropdown. - - - -.. |combo_dims| screenshot:: ds_widget.plotmethod_widget.combo_dims docs-lineplot-combo_dims.png - :height: 1.3em - :plot: - :plotmethod: lineplot - -.. |lineplot.btn_add| screenshot:: ds_widget.plotmethod_widget.btn_add docs-lineplot-btn_add.png - :width: 1.3em - :enable: - :plotmethod: lineplot - -.. |lineplot.btn_del| screenshot:: ds_widget.plotmethod_widget.btn_del docs-lineplot-btn_del.png - :width: 1.3em - :enable: - :plotmethod: lineplot - -.. |combo_lines| screenshot:: ds_widget.plotmethod_widget.combo_lines docs-lineplot-combo_lines.png - :height: 1.3em - :plot: - :plotmethod: lineplot - - -.. _user-guide-variables: - -Select the variables -^^^^^^^^^^^^^^^^^^^^ - -.. screenshot:: ds_widget.variable_frame docs-variable_frame.png - -The next section in the GUI shows the variables in the active dataset (note that -you can switch to another dataset using the dataset tree, see -:ref:`above `). - -Click on a variable to make a plot. If there is already a plot of a variable in -the dataset, it will be updated to show the new data. - -.. note:: - - The variable buttons will make new plots, if there is None already, or - update the variable in the current plot. If you want to visualize two plots - at the same time, use the |btn_add| button (see the - :ref:`plot selection above `). - - -.. _user-guide-dimensions: - -Select the dimensions -^^^^^^^^^^^^^^^^^^^^^ - -.. screenshot:: ds_widget.dimension_table docs-dimension_table.png - :plot: - :minwidth: 1200 - -The last table is the dimension table. When a variable is plotted, this widget -displays the ranges, of the netCDF dimensions and lets you update the scalar -dimensions (in the screenshot above, `time` |btn_time| and `lev` |btn_lev|). - -Left-click on such a button increases the dimension of the plot by one step, -right-click decreases the dimension. - -.. |btn_time| screenshot:: ds_widget.dimension_table.cellWidget(0,2) docs-time-button.png - :height: 1.3em - :plot: - -.. |btn_lev| screenshot:: ds_widget.dimension_table.cellWidget(1,2) docs-lev-button.png - :height: 1.3em - :plot: - -.. _user-guide-navigate-plot: - -Navigation inside the plot --------------------------- - -psy-view uses matplotlib for the visualization which comes with an interactive -backend to navigate inside the plot. - -.. screenshot:: ds_widget.plotter.ax.figure.canvas.manager.toolbar docs-mpl-toolbar.png - :plot: - -Especially the Pan/Zoom button |btn_mpl_pan| and the zoom-to-rectangle button -|btn_mpl_zoom| are of interest for you. You can enable and disable them by -clicking on the corresponding button in the toolbar. - -.. warning:: - - In principal you can also edit the colormap using the |btn_mpl_settings| - button from the toolbar. But this is known to cause errors for the mapplot - method (see `#25`_), so you should use the corresponding widgets from the gui (see - :ref:`user-guide-mapplot`). - -.. screenshot:: ds_widget.plotter.ax.figure.canvas.manager.toolbar.actions()[4].associatedWidgets()[1] docs-btn_mpl_pan.png - :width: 3em - :plot: - -The ``Pan/Zoom`` button - This button has two modes: pan and zoom. Click the toolbar button - to activate panning and zooming, then put your mouse somewhere - over an axes. Press the left mouse button and hold it to pan the - figure, dragging it to a new position. When you release it, the - data under the point where you pressed will be moved to the point - where you released. If you press 'x' or 'y' while panning the - motion will be constrained to the x or y axis, respectively. Press - the right mouse button to zoom, dragging it to a new position. - The x axis will be zoomed in proportionately to the rightward - movement and zoomed out proportionately to the leftward movement. - The same is true for the y axis and up/down motions. The point under your - mouse when you begin the zoom remains stationary, allowing you to - zoom in or out around that point as much as you wish. You can use the - modifier keys 'x', 'y' or 'CONTROL' to constrain the zoom to the x - axis, the y axis, or aspect ratio preserve, respectively. - - With polar plots, the pan and zoom functionality behaves - differently. The radius axis labels can be dragged using the left - mouse button. The radius scale can be zoomed in and out using the - right mouse button. - -.. screenshot:: ds_widget.plotter.ax.figure.canvas.manager.toolbar.actions()[5].associatedWidgets()[1] docs-btn_mpl_zoom.png - :width: 3em - :plot: - -The ``Zoom-to-rectangle`` button - Click this toolbar button to activate this mode. Put your mouse somewhere - over an axes and press a mouse button. Define a rectangular region by - dragging the mouse while holding the button to a new location. When using - the left mouse button, the axes view limits will be zoomed to the defined - region. When using the right mouse button, the axes view limits will be - zoomed out, placing the original axes in the defined region. - -More information can be found in the `matplotlib documentation`_. - -.. |btn_mpl_pan| image:: _static/docs-btn_mpl_pan.png - :width: 1.3em - -.. |btn_mpl_zoom| image:: _static/docs-btn_mpl_zoom.png - :width: 1.3em - -.. |btn_mpl_settings| screenshot:: ds_widget.plotter.ax.figure.canvas.manager.toolbar.actions()[6].associatedWidgets()[1] docs-btn_mpl_settings.png - :width: 1.3em - :plot: - -.. _#25: https://github.com/psyplot/psy-view/issues/25 -.. _matplotlib documentation: https://matplotlib.org/users/navigation_toolbar.html - -.. _psyplot-gui-embed: - -Using psy-view within the psyplot GUI -------------------------------------- -psy-view is also available from the psyplot GUI. Just type ``psyplot`` in the -terminal to start it. The only difference is that the available plots (see -:ref:`user-guide-select-plot`) are managed through the current main project -(:func:`psyplot.project.gcp`, see also the psyplot GUIs -:ref:`project content `), also accessible through -the ``mp`` variable in the -:ref:`integrated IPython console `. This gives you extra -power as you now cannot only change your plots through the intuitive psy-view -interface, but also from the command line or through the more flexible -:ref:`formatoptions widget `. +

+ The documentation of psy-view is now hosted at, https://psyplot.github.io/psy-view/user-guide.html. + You should be redirected within 5 seconds. +

diff --git a/icon/CreateICNS.sh b/icon/CreateICNS.sh deleted file mode 100644 index 6ea7bfe..0000000 --- a/icon/CreateICNS.sh +++ /dev/null @@ -1,13 +0,0 @@ -mkdir main.iconset -sips -z 16 16 icon1024.png --out main.iconset/icon_16x16.png -sips -z 32 32 icon1024.png --out main.iconset/icon_16x16@2x.png -sips -z 32 32 icon1024.png --out main.iconset/icon_32x32.png -sips -z 64 64 icon1024.png --out main.iconset/icon_32x32@2x.png -sips -z 128 128 icon1024.png --out main.iconset/icon_128x128.png -sips -z 256 256 icon1024.png --out main.iconset/icon_128x128@2x.png -sips -z 256 256 icon1024.png --out main.iconset/icon_256x256.png -sips -z 512 512 icon1024.png --out main.iconset/icon_256x256@2x.png -sips -z 512 512 icon1024.png --out main.iconset/icon_512x512.png -cp icon1024.png main.iconset/icon_512x512@2x.png -iconutil -c icns main.iconset -rm -R main.iconset diff --git a/icon/CreateICO.sh b/icon/CreateICO.sh deleted file mode 100644 index 205b444..0000000 --- a/icon/CreateICO.sh +++ /dev/null @@ -1 +0,0 @@ -convert icon1024.png -define icon:auto-resize=64,48,32,16 psyplot.ico diff --git a/icon/icon.py b/icon/icon.py deleted file mode 100644 index c06f8f7..0000000 --- a/icon/icon.py +++ /dev/null @@ -1,33 +0,0 @@ -"""Create the psyplot icon - -This script creates the psyplot icon with a dpi of 128 and a width and height -of 8 inches. The file is saved it to ``'icon1024.pkl'``""" - -import matplotlib.pyplot as plt -import cartopy.crs as ccrs -import cartopy.feature as cf -from matplotlib.text import FontProperties - -# The path to the font -fontpath = '/usr/share/fonts/truetype/freefont/FreeSansBoldOblique.ttf' - -fig = plt.figure(figsize=(8, 8), dpi=128) - -ax = fig.add_axes([0.0, 0.0, 1.0, 1.0], projection=ccrs.Orthographic( - central_latitude=5)) - -land = ax.add_feature(cf.LAND, facecolor='0.975') -ocean = ax.add_feature(cf.OCEAN, facecolor=plt.get_cmap('Blues')(0.5)) - -text = ax.text( - 0.47, 0.5, 'Psy', - transform=fig.transFigure, - name='FreeSans', - fontproperties=FontProperties(fname=fontpath), - size=256, ha='center', va='center', - weight=400) - -ax.outline_patch.set_edgecolor('none') - -plt.savefig('icon1024.png', transparent=True) -plt.savefig('icon1024.svg', transparent=True) diff --git a/icon/icon1024.png b/icon/icon1024.png deleted file mode 100644 index 28e5198..0000000 Binary files a/icon/icon1024.png and /dev/null differ diff --git a/icon/icon1024.svg b/icon/icon1024.svg deleted file mode 100644 index 491c49e..0000000 --- a/icon/icon1024.svg +++ /dev/null @@ -1,5722 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/icon/psy-view.svg b/icon/psy-view.svg deleted file mode 100644 index 23540d1..0000000 --- a/icon/psy-view.svg +++ /dev/null @@ -1,5709 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/icon/psyplot.svg b/icon/psyplot.svg deleted file mode 100644 index 23540d1..0000000 --- a/icon/psyplot.svg +++ /dev/null @@ -1,5709 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/psy_view/__init__.py b/psy_view/__init__.py deleted file mode 100644 index bf4e161..0000000 --- a/psy_view/__init__.py +++ /dev/null @@ -1,160 +0,0 @@ -# -*- coding: utf-8 -*- -"""ncview-like GUI to the psyplot framework - -**Disclaimer** - -Copyright (C) 2020 Philipp S. Sommer - -This program is free software: you can redistribute it and/or modify -it under the terms of the GNU General Public License as published by -the Free Software Foundation, either version 3 of the License, or -(at your option) any later version. - -This program is distributed in the hope that it will be useful, -but WITHOUT ANY WARRANTY; without even the implied warranty of -MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -GNU General Public License for more details. - -You should have received a copy of the GNU General Public License -along with this program. If not, see https://www.gnu.org/licenses/.""" -from __future__ import annotations -from typing import ( - Dict, - Any, - Optional, - Tuple, - Union, - Type, -) - -import sys -import argparse - -# importing xarray here for some reason speeds up starting the GUI... -import xarray as xr - -from ._version import get_versions - -__version__ = get_versions()['version'] - -del get_versions - -__author__ = "Philipp S. Sommer" - -__copyright__ = "Copyright 2020, Philipp S. Sommer" - -__email__ = "philipp.sommer@hzg.de" - -__status__ = "Development" - -__license__ = "GPLv3" - - -def start_app( - ds: Optional[xr.Dataset], name: Optional[str] = None, - plotmethod: str = 'mapplot', preset: Optional[str] = None - ) -> None: - """Start the standalone GUI application. - - This function creates a `QApplication` instance, an instance of the - :class:`psy_view.ds_widget.DatasetWidget` and enters the main event loop. - - Parameters - ---------- - ds: xarray.Dataset - The dataset to display. If None, the user can select it afterwards - name: str - The variable name in `ds` to display. If None, the user can select it - afterwards - plotmethod: {'mapplot' | 'lineplot' | 'plot2d' } - The plotmethod to use - preset: str - The preset to apply - """ - from PyQt5 import QtWidgets - from PyQt5.QtGui import QIcon # pylint: disable=no-name-in-module - from psyplot_gui import rcParams - - rcParams['help_explorer.use_webengineview'] = False - - from psy_view.ds_widget import DatasetWidgetStandAlone - from psyplot_gui.common import get_icon - - app = QtWidgets.QApplication(sys.argv) - ds_widget = DatasetWidgetStandAlone(ds) - ds_widget.setWindowIcon(QIcon(get_icon('logo.svg'))) - if preset is not None: - ds_widget.load_preset(preset) - if name is not None: - if ds is None: - raise ValueError("Variable specified but without dataset") - elif name not in ds_widget.variable_buttons: - valid = list(ds_widget.variable_buttons) - raise ValueError(f"{name} is not part of the dataset. " - f"Possible variables are {valid}.") - ds_widget.plotmethod = plotmethod - ds_widget.variable = name - ds_widget.make_plot() - ds_widget.refresh() - ds_widget.show() - ds_widget.show_current_figure() - sys.excepthook = ds_widget.excepthook - sys.exit(app.exec_()) - - -def get_parser() -> argparse.ArgumentParser: - """Get the command line parser for psy-view.""" - from textwrap import dedent - parser = argparse.ArgumentParser('psy-view') - - parser.add_argument( - 'input_file', help="The file to visualize", nargs='?', default=None) - - parser.add_argument( - '-n', '--name', - help=("Variable name to display. Don't provide a variable to display " - "the first variable found in the dataset."), - const=object, nargs="?") - - parser.add_argument( - '-pm', '--plotmethod', help="The plotmethod to use", default="mapplot", - choices=["mapplot", "plot2d", "lineplot"]) - - parser.add_argument( - '--preset', help="Apply a preset to the plot") - - parser.add_argument( - '-V', '--version', action='version', version=__version__) - - parser.epilog = dedent(""" - psy-view Copyright (C) 2020 Philipp S. Sommer - - This program comes with ABSOLUTELY NO WARRANTY. - This is free software, and you are welcome to redistribute it - under the conditions of the GNU GENERAL PUBLIC LICENSE, Version 3.""") - - return parser - - -def main() -> None: - """Start the app with the provided command-line options.""" - import psyplot.project as psy - parser = get_parser() - args = parser.parse_known_args()[0] - - if args.input_file is not None: - try: - ds = psy.open_dataset(args.input_file) - except: - ds = psy.open_dataset(args.input_file, decode_times=False) - else: - ds = None - - if args.name is object and ds is not None: - args.name = list(ds)[0] - - start_app(ds, args.name, args.plotmethod, args.preset) - - -if __name__ == "__main__": - main() diff --git a/psy_view/__main__.py b/psy_view/__main__.py deleted file mode 100644 index 38888cf..0000000 --- a/psy_view/__main__.py +++ /dev/null @@ -1,24 +0,0 @@ -# -*- coding: utf-8 -*- -"""main module of straditize - -**Disclaimer** - -Copyright (C) 2020 Philipp S. Sommer - -This program is free software: you can redistribute it and/or modify -it under the terms of the GNU General Public License as published by -the Free Software Foundation, either version 3 of the License, or -(at your option) any later version. - -This program is distributed in the hope that it will be useful, -but WITHOUT ANY WARRANTY; without even the implied warranty of -MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -GNU General Public License for more details. - -You should have received a copy of the GNU General Public License -along with this program. If not, see https://www.gnu.org/licenses/. -""" -import psy_view - -if __name__ == '__main__': - psy_view.main() diff --git a/psy_view/_version.py b/psy_view/_version.py deleted file mode 100644 index 0fbaf50..0000000 --- a/psy_view/_version.py +++ /dev/null @@ -1,524 +0,0 @@ - -# This file helps to compute a version number in source trees obtained from -# git-archive tarball (such as those provided by githubs download-from-tag -# feature). Distribution tarballs (built by setup.py sdist) and build -# directories (produced by setup.py build) will contain a much shorter file -# that just contains the computed version number. - -# This file is released into the public domain. Generated by -# versioneer-0.18 (https://github.com/warner/python-versioneer) - -"""Git implementation of _version.py.""" - -# pylint: skip-file - -from typing import Dict - -import errno -import os -import re -import subprocess -import sys - - -def get_keywords(): - """Get the keywords needed to look up the version information.""" - # these strings will be replaced by git during git-archive. - # setup.py/versioneer.py will grep for the variable names, so they must - # each be defined on a line of their own. _version.py will just call - # get_keywords(). - git_refnames = "$Format:%d$" - git_full = "$Format:%H$" - git_date = "$Format:%ci$" - keywords = {"refnames": git_refnames, "full": git_full, "date": git_date} - return keywords - - -class VersioneerConfig: - """Container for Versioneer configuration parameters.""" - - -def get_config(): - """Create, populate and return the VersioneerConfig() object.""" - # these strings are filled in when 'setup.py versioneer' creates - # _version.py - cfg = VersioneerConfig() - cfg.VCS = "git" - cfg.style = "pep440" - cfg.tag_prefix = "v" - cfg.parentdir_prefix = "psy-view-" - cfg.versionfile_source = "psy_view/_version.py" - cfg.verbose = False - return cfg - - -class NotThisMethod(Exception): - """Exception raised if a method is not valid for the current scenario.""" - - -LONG_VERSION_PY: Dict[str, str] = {} -HANDLERS = {} - - -def register_vcs_handler(vcs, method): # decorator - """Decorator to mark a method as the handler for a particular VCS.""" - def decorate(f): - """Store f in HANDLERS[vcs][method].""" - if vcs not in HANDLERS: - HANDLERS[vcs] = {} - HANDLERS[vcs][method] = f - return f - return decorate - - -def run_command(commands, args, cwd=None, verbose=False, hide_stderr=False, - env=None): - """Call the given command(s).""" - assert isinstance(commands, list) - p = None - for c in commands: - try: - dispcmd = str([c] + args) - # remember shell=False, so use git.cmd on windows, not just git - p = subprocess.Popen([c] + args, cwd=cwd, env=env, - stdout=subprocess.PIPE, - stderr=(subprocess.PIPE if hide_stderr - else None)) - break - except EnvironmentError: - e = sys.exc_info()[1] - if e.errno == errno.ENOENT: - continue - if verbose: - print("unable to run %s" % dispcmd) - print(e) - return None, None - else: - if verbose: - print("unable to find command, tried %s" % (commands,)) - return None, None - stdout = p.communicate()[0].strip() - if sys.version_info[0] >= 3: - stdout = stdout.decode() - if p.returncode != 0: - if verbose: - print("unable to run %s (error)" % dispcmd) - print("stdout was %s" % stdout) - return None, p.returncode - return stdout, p.returncode - - -def versions_from_parentdir(parentdir_prefix, root, verbose): - """Try to determine the version from the parent directory name. - - Source tarballs conventionally unpack into a directory that includes both - the project name and a version string. We will also support searching up - two directory levels for an appropriately named parent directory - """ - rootdirs = [] - - for i in range(3): - dirname = os.path.basename(root) - if dirname.startswith(parentdir_prefix): - return {"version": dirname[len(parentdir_prefix):], - "full-revisionid": None, - "dirty": False, "error": None, "date": None} - else: - rootdirs.append(root) - root = os.path.dirname(root) # up a level - - if verbose: - print("Tried directories %s but none started with prefix %s" % - (str(rootdirs), parentdir_prefix)) - raise NotThisMethod("rootdir doesn't start with parentdir_prefix") - - -@register_vcs_handler("git", "get_keywords") -def git_get_keywords(versionfile_abs): - """Extract version information from the given file.""" - # the code embedded in _version.py can just fetch the value of these - # keywords. When used from setup.py, we don't want to import _version.py, - # so we do it with a regexp instead. This function is not used from - # _version.py. - keywords = {} - try: - f = open(versionfile_abs, "r") - for line in f.readlines(): - if line.strip().startswith("git_refnames ="): - mo = re.search(r'=\s*"(.*)"', line) - if mo: - keywords["refnames"] = mo.group(1) - if line.strip().startswith("git_full ="): - mo = re.search(r'=\s*"(.*)"', line) - if mo: - keywords["full"] = mo.group(1) - if line.strip().startswith("git_date ="): - mo = re.search(r'=\s*"(.*)"', line) - if mo: - keywords["date"] = mo.group(1) - f.close() - except EnvironmentError: - pass - return keywords - - -@register_vcs_handler("git", "keywords") -def git_versions_from_keywords(keywords, tag_prefix, verbose): - """Get version information from git keywords.""" - if not keywords: - raise NotThisMethod("no keywords at all, weird") - date = keywords.get("date") - if date is not None: - # git-2.2.0 added "%cI", which expands to an ISO-8601 -compliant - # datestamp. However we prefer "%ci" (which expands to an "ISO-8601 - # -like" string, which we must then edit to make compliant), because - # it's been around since git-1.5.3, and it's too difficult to - # discover which version we're using, or to work around using an - # older one. - date = date.strip().replace(" ", "T", 1).replace(" ", "", 1) - refnames = keywords["refnames"].strip() - if refnames.startswith("$Format"): - if verbose: - print("keywords are unexpanded, not using") - raise NotThisMethod("unexpanded keywords, not a git-archive tarball") - refs = set([r.strip() for r in refnames.strip("()").split(",")]) - # starting in git-1.8.3, tags are listed as "tag: foo-1.0" instead of - # just "foo-1.0". If we see a "tag: " prefix, prefer those. - TAG = "tag: " - tags = set([r[len(TAG):] for r in refs if r.startswith(TAG)]) - if not tags: - # Either we're using git < 1.8.3, or there really are no tags. We use - # a heuristic: assume all version tags have a digit. The old git %d - # expansion behaves like git log --decorate=short and strips out the - # refs/heads/ and refs/tags/ prefixes that would let us distinguish - # between branches and tags. By ignoring refnames without digits, we - # filter out many common branch names like "release" and - # "stabilization", as well as "HEAD" and "master". - tags = set([r for r in refs if re.search(r'\d', r)]) - if verbose: - print("discarding '%s', no digits" % ",".join(refs - tags)) - if verbose: - print("likely tags: %s" % ",".join(sorted(tags))) - for ref in sorted(tags): - # sorting will prefer e.g. "2.0" over "2.0rc1" - if ref.startswith(tag_prefix): - r = ref[len(tag_prefix):] - if verbose: - print("picking %s" % r) - return {"version": r, - "full-revisionid": keywords["full"].strip(), - "dirty": False, "error": None, - "date": date} - # no suitable tags, so version is "0+unknown", but full hex is still there - if verbose: - print("no suitable tags, using unknown + full revision id") - return {"version": "0+unknown", - "full-revisionid": keywords["full"].strip(), - "dirty": False, "error": "no suitable tags", "date": None} - - -@register_vcs_handler("git", "pieces_from_vcs") -def git_pieces_from_vcs(tag_prefix, root, verbose, run_command=run_command): - """Get version from 'git describe' in the root of the source tree. - - This only gets called if the git-archive 'subst' keywords were *not* - expanded, and _version.py hasn't already been rewritten with a short - version string, meaning we're inside a checked out source tree. - """ - GITS = ["git"] - if sys.platform == "win32": - GITS = ["git.cmd", "git.exe"] - - out, rc = run_command(GITS, ["rev-parse", "--git-dir"], cwd=root, - hide_stderr=True) - if rc != 0: - if verbose: - print("Directory %s not under git control" % root) - raise NotThisMethod("'git rev-parse --git-dir' returned error") - - # if there is a tag matching tag_prefix, this yields TAG-NUM-gHEX[-dirty] - # if there isn't one, this yields HEX[-dirty] (no NUM) - describe_out, rc = run_command(GITS, ["describe", "--tags", "--dirty", - "--always", "--long", - "--match", "%s*" % tag_prefix], - cwd=root) - # --long was added in git-1.5.5 - if describe_out is None: - raise NotThisMethod("'git describe' failed") - describe_out = describe_out.strip() - full_out, rc = run_command(GITS, ["rev-parse", "HEAD"], cwd=root) - if full_out is None: - raise NotThisMethod("'git rev-parse' failed") - full_out = full_out.strip() - - pieces = {} - pieces["long"] = full_out - pieces["short"] = full_out[:7] # maybe improved later - pieces["error"] = None - - # parse describe_out. It will be like TAG-NUM-gHEX[-dirty] or HEX[-dirty] - # TAG might have hyphens. - git_describe = describe_out - - # look for -dirty suffix - dirty = git_describe.endswith("-dirty") - pieces["dirty"] = dirty - if dirty: - git_describe = git_describe[:git_describe.rindex("-dirty")] - - # now we have TAG-NUM-gHEX or HEX - - if "-" in git_describe: - # TAG-NUM-gHEX - mo = re.search(r'^(.+)-(\d+)-g([0-9a-f]+)$', git_describe) - if not mo: - # unparseable. Maybe git-describe is misbehaving? - pieces["error"] = ("unable to parse git-describe output: '%s'" - % describe_out) - return pieces - - # tag - full_tag = mo.group(1) - if not full_tag.startswith(tag_prefix): - if verbose: - fmt = "tag '%s' doesn't start with prefix '%s'" - print(fmt % (full_tag, tag_prefix)) - pieces["error"] = ("tag '%s' doesn't start with prefix '%s'" - % (full_tag, tag_prefix)) - return pieces - pieces["closest-tag"] = full_tag[len(tag_prefix):] - - # distance: number of commits since tag - pieces["distance"] = int(mo.group(2)) - - # commit: short hex revision ID - pieces["short"] = mo.group(3) - - else: - # HEX: no tags - pieces["closest-tag"] = None - count_out, rc = run_command(GITS, ["rev-list", "HEAD", "--count"], - cwd=root) - pieces["distance"] = int(count_out) # total number of commits - - # commit date: see ISO-8601 comment in git_versions_from_keywords() - date = run_command(GITS, ["show", "-s", "--format=%ci", "HEAD"], - cwd=root)[0].strip() - pieces["date"] = date.strip().replace(" ", "T", 1).replace(" ", "", 1) - - return pieces - - -def plus_or_dot(pieces): - """Return a + if we don't already have one, else return a .""" - if "+" in pieces.get("closest-tag", ""): - return "." - return "+" - - -def render_pep440(pieces): - """Build up version string, with post-release "local version identifier". - - Our goal: TAG[+DISTANCE.gHEX[.dirty]] . Note that if you - get a tagged build and then dirty it, you'll get TAG+0.gHEX.dirty - - Exceptions: - 1: no tags. git_describe was just HEX. 0+untagged.DISTANCE.gHEX[.dirty] - """ - if pieces["closest-tag"]: - rendered = pieces["closest-tag"] - if pieces["distance"] or pieces["dirty"]: - rendered += plus_or_dot(pieces) - rendered += "%d.g%s" % (pieces["distance"], pieces["short"]) - if pieces["dirty"]: - rendered += ".dirty" - else: - # exception #1 - rendered = "0+untagged.%d.g%s" % (pieces["distance"], - pieces["short"]) - if pieces["dirty"]: - rendered += ".dirty" - return rendered - - -def render_pep440_pre(pieces): - """TAG[.post.devDISTANCE] -- No -dirty. - - Exceptions: - 1: no tags. 0.post.devDISTANCE - """ - if pieces["closest-tag"]: - rendered = pieces["closest-tag"] - if pieces["distance"]: - rendered += ".post.dev%d" % pieces["distance"] - else: - # exception #1 - rendered = "0.post.dev%d" % pieces["distance"] - return rendered - - -def render_pep440_post(pieces): - """TAG[.postDISTANCE[.dev0]+gHEX] . - - The ".dev0" means dirty. Note that .dev0 sorts backwards - (a dirty tree will appear "older" than the corresponding clean one), - but you shouldn't be releasing software with -dirty anyways. - - Exceptions: - 1: no tags. 0.postDISTANCE[.dev0] - """ - if pieces["closest-tag"]: - rendered = pieces["closest-tag"] - if pieces["distance"] or pieces["dirty"]: - rendered += ".post%d" % pieces["distance"] - if pieces["dirty"]: - rendered += ".dev0" - rendered += plus_or_dot(pieces) - rendered += "g%s" % pieces["short"] - else: - # exception #1 - rendered = "0.post%d" % pieces["distance"] - if pieces["dirty"]: - rendered += ".dev0" - rendered += "+g%s" % pieces["short"] - return rendered - - -def render_pep440_old(pieces): - """TAG[.postDISTANCE[.dev0]] . - - The ".dev0" means dirty. - - Eexceptions: - 1: no tags. 0.postDISTANCE[.dev0] - """ - if pieces["closest-tag"]: - rendered = pieces["closest-tag"] - if pieces["distance"] or pieces["dirty"]: - rendered += ".post%d" % pieces["distance"] - if pieces["dirty"]: - rendered += ".dev0" - else: - # exception #1 - rendered = "0.post%d" % pieces["distance"] - if pieces["dirty"]: - rendered += ".dev0" - return rendered - - -def render_git_describe(pieces): - """TAG[-DISTANCE-gHEX][-dirty]. - - Like 'git describe --tags --dirty --always'. - - Exceptions: - 1: no tags. HEX[-dirty] (note: no 'g' prefix) - """ - if pieces["closest-tag"]: - rendered = pieces["closest-tag"] - if pieces["distance"]: - rendered += "-%d-g%s" % (pieces["distance"], pieces["short"]) - else: - # exception #1 - rendered = pieces["short"] - if pieces["dirty"]: - rendered += "-dirty" - return rendered - - -def render_git_describe_long(pieces): - """TAG-DISTANCE-gHEX[-dirty]. - - Like 'git describe --tags --dirty --always -long'. - The distance/hash is unconditional. - - Exceptions: - 1: no tags. HEX[-dirty] (note: no 'g' prefix) - """ - if pieces["closest-tag"]: - rendered = pieces["closest-tag"] - rendered += "-%d-g%s" % (pieces["distance"], pieces["short"]) - else: - # exception #1 - rendered = pieces["short"] - if pieces["dirty"]: - rendered += "-dirty" - return rendered - - -def render(pieces, style): - """Render the given version pieces into the requested style.""" - if pieces["error"]: - return {"version": "unknown", - "full-revisionid": pieces.get("long"), - "dirty": None, - "error": pieces["error"], - "date": None} - - if not style or style == "default": - style = "pep440" # the default - - if style == "pep440": - rendered = render_pep440(pieces) - elif style == "pep440-pre": - rendered = render_pep440_pre(pieces) - elif style == "pep440-post": - rendered = render_pep440_post(pieces) - elif style == "pep440-old": - rendered = render_pep440_old(pieces) - elif style == "git-describe": - rendered = render_git_describe(pieces) - elif style == "git-describe-long": - rendered = render_git_describe_long(pieces) - else: - raise ValueError("unknown style '%s'" % style) - - return {"version": rendered, "full-revisionid": pieces["long"], - "dirty": pieces["dirty"], "error": None, - "date": pieces.get("date")} - - -def get_versions(): - """Get version information or return default if unable to do so.""" - # I am in _version.py, which lives at ROOT/VERSIONFILE_SOURCE. If we have - # __file__, we can work backwards from there to the root. Some - # py2exe/bbfreeze/non-CPython implementations don't do __file__, in which - # case we can only use expanded keywords. - - cfg = get_config() - verbose = cfg.verbose - - try: - return git_versions_from_keywords(get_keywords(), cfg.tag_prefix, - verbose) - except NotThisMethod: - pass - - try: - root = os.path.realpath(__file__) - # versionfile_source is the relative path from the top of the source - # tree (where the .git directory might live) to this file. Invert - # this to find the root from __file__. - for i in cfg.versionfile_source.split('/'): - root = os.path.dirname(root) - except NameError: - return {"version": "0+unknown", "full-revisionid": None, - "dirty": None, - "error": "unable to find root of source tree", - "date": None} - - try: - pieces = git_pieces_from_vcs(cfg.tag_prefix, root, verbose) - return render(pieces, cfg.style) - except NotThisMethod: - pass - - try: - if cfg.parentdir_prefix: - return versions_from_parentdir(cfg.parentdir_prefix, root, verbose) - except NotThisMethod: - pass - - return {"version": "0+unknown", "full-revisionid": None, - "dirty": None, - "error": "unable to compute version", "date": None} diff --git a/psy_view/dialogs.py b/psy_view/dialogs.py deleted file mode 100644 index 2acb644..0000000 --- a/psy_view/dialogs.py +++ /dev/null @@ -1,1039 +0,0 @@ -"""Dialogs for manipulating formatoptions. - -**Disclaimer** - -Copyright (C) 2020 Philipp S. Sommer - -This program is free software: you can redistribute it and/or modify -it under the terms of the GNU General Public License as published by -the Free Software Foundation, either version 3 of the License, or -(at your option) any later version. - -This program is distributed in the hope that it will be useful, -but WITHOUT ANY WARRANTY; without even the implied warranty of -MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -GNU General Public License for more details. - -You should have received a copy of the GNU General Public License -along with this program. If not, see https://www.gnu.org/licenses/. -""" -from __future__ import annotations -from typing import ( - TYPE_CHECKING, - Dict, - Any, - Optional, - Tuple, - Union, - Type, -) - -import yaml -from PyQt5 import QtWidgets, QtGui -from matplotlib.backends.backend_qt5agg import ( - FigureCanvasQTAgg as FigureCanvas) -from matplotlib.figure import Figure - -from psyplot.plotter import Plotter, Formatoption - -if TYPE_CHECKING: - from psyplot.project import Project - from PyQt5.QtCore import QEvent # pylint: disable=no-name-in-module - - -#: TODO: Find a more appropriate description here -Color = Any - -#: TODO: Find a more appropriate description here -LSM_T = Dict[str, Any] - - -class BasemapDialog(QtWidgets.QDialog): - """A dialog to modify the basemap settings.""" - - xgrid_value: Optional[Union[str, Tuple[Any, Any]]] - ygrid_value: Optional[Union[str, Tuple[Any, Any]]] - - def __init__(self, plotter: Plotter, *args, **kwargs) -> None: - """ - Parameters - ---------- - plotter: psy_maps.plotters.MapPlotter - The psyplot plotter to configure - """ - import psy_simple.widgets.colors as pswc - import pandas as pd - super().__init__(*args, **kwargs) - vbox = QtWidgets.QVBoxLayout(self) - - #: colors that affect the map background - self.colors = ['background', 'land', 'ocean', 'coast'] - - #: QGridLayout to display the various colors - grid = QtWidgets.QGridLayout() - - defaults = self.default_colors - - #: :class:`pandas.DataFrame` of widgets to modifiy the :attr:`colors` - self.widgets = widgets = pd.DataFrame( - index=['enable', 'color'], columns=self.colors, dtype=object) - - for i, col in enumerate(self.colors): - widgets.iloc[0, i] = cb = QtWidgets.QCheckBox() - cb.setChecked(False) - widgets.iloc[1, i] = lbl = pswc.ColorLabel(defaults[col]) - lbl.setEnabled(False) - - cb.stateChanged.connect(lbl.setEnabled) - - grid.addWidget(QtWidgets.QLabel(col), 0, i) - grid.addWidget(cb, 1, i) - grid.addWidget(lbl, 2, i) - - vbox.addLayout(grid) - - #: Button box to cancel the operator or update the plotter - self.button_box = QtWidgets.QDialogButtonBox( - QtWidgets.QDialogButtonBox.Ok | QtWidgets.QDialogButtonBox.Cancel, - self) - - self.button_box.accepted.connect(self.accept) - self.button_box.rejected.connect(self.reject) - - proj_box = QtWidgets.QGroupBox("Projection settings") - layout = QtWidgets.QFormLayout(proj_box) - - #: text box for the central longitude (clon formatoption) - self.txt_clon = QtWidgets.QLineEdit() - self.txt_clon.setPlaceholderText('auto') - self.txt_clon.setToolTip('Central longitude in degrees East') - self.txt_clon.setValidator(QtGui.QDoubleValidator(-360, 360, 7)) - layout.addRow('Central longitude: ', self.txt_clon) - - #: text box for the central latitude (clat formatoption) - self.txt_clat = QtWidgets.QLineEdit() - self.txt_clat.setPlaceholderText('auto') - self.txt_clat.setToolTip('Central latitude in degrees North') - self.txt_clat.setValidator(QtGui.QDoubleValidator(-90, 90, 7)) - layout.addRow('Central latitude: ', self.txt_clat) - - vbox.addWidget(proj_box) - - #: group box for modifying the resolution of the land-sea-mask, see - #: :attr:`opt_110m`, :attr:`opt_50m`, :attr:`opt_10m` - self.lsm_box = QtWidgets.QGroupBox('Coastlines') - self.lsm_box.setCheckable(True) - hbox = QtWidgets.QHBoxLayout(self.lsm_box) - hbox.addWidget(QtWidgets.QLabel("Resolution:")) - - #: Radiobutton for 110m resolution of lsm - self.opt_110m = QtWidgets.QRadioButton("110m") - - #: Radiobutton for 50m resolution of lsm - self.opt_50m = QtWidgets.QRadioButton("50m") - - #: Radiobutton for 10m resolution of lsm - self.opt_10m = QtWidgets.QRadioButton("10m") - hbox.addWidget(self.opt_110m) - hbox.addWidget(self.opt_50m) - hbox.addWidget(self.opt_10m) - - vbox.addWidget(self.lsm_box) - - #: group box drawing grid lines and labels - self.grid_labels_box = QtWidgets.QGroupBox('Labels') - self.grid_labels_box.setToolTip("Draw labels of meridionals and " - "parallels") - self.grid_labels_box.setCheckable(True) - - #: text box for the fontsize of grid labels - self.txt_grid_fontsize = QtWidgets.QLineEdit() - - form = QtWidgets.QFormLayout(self.grid_labels_box) - form.addRow("Font size:", self.txt_grid_fontsize) - - vbox.addWidget(self.grid_labels_box) - - #: Group box for options specific to meridionals (see - #: :attr:`opt_meri_auto`, :attr:`opt_meri_at` and - #: :attr:`opt_meri_every`, :attr:`opt_meri_num`) - self.meridionals_box = QtWidgets.QGroupBox('Meridionals') - self.meridionals_box.setCheckable(True) - - #: Radiobutton for automatic drawing of meridionals - self.opt_meri_auto = QtWidgets.QRadioButton("auto") - - #: Radiobutton for giving the exact position of meridionals (see - #: :attr:`txt_meri_at`) - self.opt_meri_at = QtWidgets.QRadioButton("At:") - - #: Text field to enter the location of the meridionals on the map (see - #: :attr:`opt_meri_at`) - self.txt_meri_at = QtWidgets.QLineEdit() - self.txt_meri_at.setPlaceholderText("30, 60, 90, 120, ... °E") - # TODO: Add validator - - #: Radiobutton for equal-width spaced meridionals (see - #: :attr:`txt_meri_every`) - self.opt_meri_every = QtWidgets.QRadioButton("Every:") - - #: Text box to specify the distance between two meridionals (see - #: :attr:`opt_meri_every`) - self.txt_meri_every = QtWidgets.QLineEdit() - self.txt_meri_every.setPlaceholderText("30 °E") - self.txt_meri_every.setValidator(QtGui.QDoubleValidator(0, 360, 7)) - - #: Radiobutton to draw a specific number of meridionals with - #: equal-distance (see also :attr:`txt_meri_num`) - self.opt_meri_num = QtWidgets.QRadioButton("Number:") - - #: Text box to set the number of meridionals to be shown (see - #: :attr:`opt_meri_num`) - self.txt_meri_num = QtWidgets.QLineEdit() - self.txt_meri_num.setPlaceholderText("5") - self.txt_meri_num.setValidator(QtGui.QIntValidator(1, 720)) - - form = QtWidgets.QFormLayout(self.meridionals_box) - form.addRow(self.opt_meri_auto) - form.addRow(self.opt_meri_at, self.txt_meri_at) - form.addRow(self.opt_meri_every, self.txt_meri_every) - form.addRow(self.opt_meri_num, self.txt_meri_num) - - vbox.addWidget(self.meridionals_box) - - #: Group box for options specific to parallels (see - #: :attr:`opt_para_auto`, :attr:`opt_para_at` and - #: :attr:`opt_para_every`, :attr:`opt_para_num`) - self.parallels_box = QtWidgets.QGroupBox('Parallels') - self.parallels_box.setCheckable(True) - - #: Radiobutton for automatic drawing of parallels - self.opt_para_auto = QtWidgets.QRadioButton("auto") - - #: Radiobutton for giving the exact position of parallels (see - #: :attr:`txt_para_at`) - self.opt_para_at = QtWidgets.QRadioButton("At:") - - #: Text field to enter the location of the parallels on the map (see - #: :attr:`opt_para_at`) - self.txt_para_at = QtWidgets.QLineEdit() - self.txt_para_at.setPlaceholderText("-60, -30, 0, 30, ... °N") - # TODO: Add validator - - #: Radiobutton for equal-width spaced parallels (see - #: :attr:`txt_para_every`) - self.opt_para_every = QtWidgets.QRadioButton("Every:") - - #: Text box to specify the distance between two parallels (see - #: :attr:`opt_para_every`) - self.txt_para_every = QtWidgets.QLineEdit() - self.txt_para_every.setPlaceholderText("30 °N") - self.txt_para_every.setValidator(QtGui.QDoubleValidator(0, 90, 7)) - - #: Radiobutton to draw a specific number of parallels with - #: equal-distance (see also :attr:`txt_para_num`) - self.opt_para_num = QtWidgets.QRadioButton("Number:") - - #: Text box to set the number of parallels to be shown (see - #: :attr:`opt_para_num`) - self.txt_para_num = QtWidgets.QLineEdit() - self.txt_para_num.setPlaceholderText("5") - self.txt_para_num.setValidator(QtGui.QIntValidator(1, 360)) - - form = QtWidgets.QFormLayout(self.parallels_box) - form.addRow(self.opt_para_auto) - form.addRow(self.opt_para_at, self.txt_para_at) - form.addRow(self.opt_para_every, self.txt_para_every) - form.addRow(self.opt_para_num, self.txt_para_num) - - vbox.addWidget(self.parallels_box) - - vbox.addWidget(self.button_box) - - self.fill_from_plotter(plotter) - - for button in [self.opt_meri_at, self.opt_meri_auto, self.opt_meri_num, - self.opt_meri_every, self.opt_para_at, - self.opt_para_auto, self.opt_para_num, - self.opt_para_every]: - button.clicked.connect(self.update_forms) - - @property - def default_colors(self) -> Dict[str, Color]: - """Get default colors for the color labels in :attr:`widgets`.""" - import cartopy.feature as cf - import matplotlib as mpl - return { - 'background': mpl.rcParams['axes.facecolor'], - 'land': cf.LAND._kwargs['facecolor'], - 'ocean': cf.OCEAN._kwargs['facecolor'], - 'coast': 'k', - } - - def get_colors(self, plotter: Plotter) -> Dict[str, Color]: - """Get the colors for :attr:`widgets` from the plotter formatoptions. - - Parameters - ---------- - plotter: psy_maps.plotters.MapPlotter - The plotter with the formatoptions - - Returns - ------- - dict - A mapping from formatoptions in :attr:`colors` to the corresponding - color in the `plotter`. - """ - ret = {} - if plotter.background.value != 'rc': - ret['background'] = plotter.background.value - lsm = plotter.lsm.value - for part in ['land', 'ocean', 'coast']: - if part in lsm: - ret[part] = lsm[part] - return ret - - def fill_from_plotter(self, plotter: Plotter) -> None: - """Fill the dialog from a given plotter. - - Parameters - ---------- - plotter: psy_maps.plotters.MapPlotter - The plotter to get the formatoptions from. - """ - chosen_colors = self.get_colors(plotter) - - for i, col in enumerate(self.colors): - enable = col in chosen_colors - cb = self.widgets.iloc[0, i] - lbl = self.widgets.iloc[1, i] - cb.setChecked(enable) - if enable: - lbl._set_color(chosen_colors[col]) - - if plotter.clon.value is not None: - self.txt_clon.setText(str(plotter.clon.value)) - if plotter.clat.value is not None: - self.txt_clat.setText(str(plotter.clat.value)) - - lsm = plotter.lsm.value - - if not lsm: - self.lsm_box.setChecked(False) - else: - res = lsm['res'] - getattr(self, 'opt_' + res).setChecked(True) - - grid_labels = plotter.grid_labels.value - if grid_labels is None: - grid_labels = True - self.grid_labels_box.setChecked(grid_labels) - self.txt_grid_fontsize.setText(str(plotter.grid_labelsize.value)) - - self.xgrid_value = None - value = plotter.xgrid.value - if not value: - self.meridionals_box.setChecked(False) - elif value is True: - self.opt_meri_auto.setChecked(True) - elif isinstance(value[0], str): - self.xgrid_value = value[0] - self.opt_meri_num.setChecked(True) - self.txt_meri_num.setText(str(value[1])) - elif isinstance(value, tuple): - self.xgrid_value: Tuple[Any, Any] = value[:2] # type: ignore - self.opt_meri_num.setChecked(True) - steps = 11 if len(value) == 2 else value[3] - self.txt_meri_num.setText(str(steps)) - else: - self.opt_meri_at.setChecked(True) - self.txt_meri_at.setText(', '.join(map(str, value))) - - self.ygrid_value = None - value = plotter.ygrid.value - if not value: - self.parallels_box.setChecked(False) - elif value is True: - self.opt_para_auto.setChecked(True) - elif isinstance(value[0], str): - self.opt_para_num.setChecked(True) - self.txt_para_num.setText(str(value[1])) - self.ygrid_value = value[0] - elif isinstance(value, tuple): - self.ygrid_value: Tuple[Any, Any] = value[:2] # type: ignore - self.opt_para_num.setChecked(True) - steps = 11 if len(value) == 2 else value[3] - self.txt_para_num.setText(str(steps)) - else: - self.opt_para_at.setChecked(True) - self.txt_para_at.setText(', '.join(map(str, value))) - - def update_forms(self) -> None: - """Update text widgets for the options to draw merdionals and parallels. - """ - if self.meridionals_box.isChecked(): - self.txt_meri_at.setEnabled(self.opt_meri_at.isChecked()) - self.txt_meri_every.setEnabled(self.opt_meri_every.isChecked()) - self.txt_meri_num.setEnabled(self.opt_meri_num.isChecked()) - if self.parallels_box.isChecked(): - self.txt_para_at.setEnabled(self.opt_para_at.isChecked()) - self.txt_para_every.setEnabled(self.opt_para_every.isChecked()) - self.txt_para_num.setEnabled(self.opt_para_num.isChecked()) - - @property - def value(self) -> Dict[str, Any]: - """Get the formatoptions of this dialog to update a plotter.""" - import numpy as np - ret: Dict[str, Any] = {} - ret['clon'] = None if not self.txt_clon.text().strip() else float( - self.txt_clon.text().strip()) - ret['clat'] = None if not self.txt_clat.text().strip() else float( - self.txt_clat.text().strip()) - - lsm: LSM_T = {} - - for col in ['land', 'ocean', 'coast']: - lbl = self.widgets.loc['color', col] - if lbl.isEnabled(): - lsm[col] = list(lbl.color.getRgbF()) - - if lsm or self.lsm_box.isChecked(): - if self.opt_110m.isChecked(): - lsm['res'] = '110m' - elif self.opt_50m.isChecked(): - lsm['res'] = '50m' - elif self.opt_10m.isChecked(): - lsm['res'] = '10m' - else: - lsm['res'] = '110m' - else: - lsm['res'] = False - if lsm: - ret['lsm'] = lsm - - bc_lbl = self.widgets.loc['color', 'background'] - if bc_lbl.isEnabled(): - ret['background'] = list(bc_lbl.color.getRgbF()) - - ret["grid_labels"] = self.grid_labels_box.isChecked() - if ret["grid_labels"]: - ret["grid_labels"] = None - labelsize = self.txt_grid_fontsize.text().strip() - if labelsize: - try: - labelsize = float(labelsize) - except TypeError: - pass - ret["grid_labelsize"] = labelsize - - if not self.meridionals_box.isChecked(): - ret['xgrid'] = False - elif self.opt_meri_auto.isChecked(): - ret['xgrid'] = True - elif self.opt_meri_every.isChecked(): - ret['xgrid'] = np.arange( - -180, 180, float(self.txt_meri_every.text().strip() or 30)) - elif self.opt_meri_at.isChecked(): - ret['xgrid'] = list(map( - float, self.txt_meri_at.text().split(','))) or False - elif self.opt_meri_num.isChecked(): - if self.xgrid_value is None: - ret['xgrid'] = ['rounded', int(self.txt_meri_num.text() or 5)] - elif isinstance(self.xgrid_value, str): - ret['xgrid'] = [self.xgrid_value, - int(self.txt_meri_num.text() or 5)] - else: - ret['xgrid'] = tuple(self.xgrid_value) + ( - int(self.txt_meri_num.text() or 5), ) - - if not self.parallels_box.isChecked(): - ret['ygrid'] = False - elif self.opt_para_auto.isChecked(): - ret['ygrid'] = True - elif self.opt_para_every.isChecked(): - ret['ygrid'] = np.arange( - -180, 180, float(self.txt_para_every.text().strip() or 30)) - elif self.opt_para_at.isChecked(): - ret['ygrid'] = list(map( - float, self.txt_para_at.text().split(','))) or False - elif self.opt_para_num.isChecked(): - if self.ygrid_value is None: - ret['ygrid'] = ['rounded', int(self.txt_para_num.text() or 5)] - elif isinstance(self.ygrid_value, str): - ret['ygrid'] = [self.ygrid_value, - int(self.txt_para_num.text() or 5)] - else: - ret['ygrid'] = tuple(self.ygrid_value) + ( - int(self.txt_para_num.text() or 5), ) - return ret - - @classmethod - def update_plotter(cls, plotter: Plotter) -> None: - """Open a :class:`BasemapDialog` to update a plotter. - - Parameters - ---------- - plotter: psy_maps.plotters.MapPlotter - The plotter to update. - """ - dialog = cls(plotter) - dialog.show() - dialog.raise_() - dialog.activateWindow() - dialog.exec_() - if dialog.result() == QtWidgets.QDialog.Accepted: - plotter.update( - **dialog.value) - - -class CmapDialog(QtWidgets.QDialog): - """A dialog to modify color bounds and colormaps.""" - - def __init__(self, project: Project, *args, **kwargs) -> None: - """ - Parameters - ---------- - project: psyplot.project.Project - The psyplot project to update. Note that we will only use the - very first plotter in this project - """ - import psy_simple.widgets.colors as pswc - super().__init__(*args, **kwargs) - - #: Button box to accept or cancel this dialog - self.button_box = QtWidgets.QDialogButtonBox( - QtWidgets.QDialogButtonBox.Ok | QtWidgets.QDialogButtonBox.Cancel, - self) - self.button_box.accepted.connect(self.accept) - self.button_box.rejected.connect(self.reject) - - #: Mapping from formatoption key to :class:`LabelWidgetLine` widgets to - #: controlling the formatoption - self.fmt_widgets = {} - plotter = project(fmts=['cmap', 'bounds']).plotters[0] - - #: Widget for manipulating the color map - self.cmap_widget = self.fmt_widgets['cmap'] = LabelWidgetLine( - plotter.cmap, project, pswc.CMapFmtWidget, - widget_kws=dict(properties=False)) - self.cmap_widget.editor.setVisible(False) - self.cmap_widget.editor.line_edit.textChanged.connect( - self.update_preview) - - #: tabs for switching between bounds (:attr:`bounds_widget`) and - #: colorbar ticks (:attr:`cticks_widget`) - self.tabs = QtWidgets.QTabWidget() - - #: :class:`LabelWidgetLine` to controll the colorbar bounds - self.bounds_widget = self.fmt_widgets['bounds'] = LabelWidgetLine( - plotter.bounds, project, pswc.BoundsFmtWidget, - widget_kws=dict(properties=False)) - self.bounds_widget.editor.line_edit.textChanged.connect( - self.update_preview) - self.tabs.addTab(self.bounds_widget, "Colormap boundaries") - - #: :class:`LabelWidgetLine` to controll the ctick positions - self.cticks_widget = self.fmt_widgets['cticks'] = LabelWidgetLine( - plotter.cticks, project, pswc.CTicksFmtWidget, - widget_kws=dict(properties=False)) - self.cticks_widget.editor.line_edit.textChanged.connect( - self.update_preview) - self.tabs.addTab(self.cticks_widget, "Colorbar ticks") - - #: :class:`ColorbarPreview` to show a preview of the colorbar with - #: the selected formatoption in :attr:`fmt_widgets` - self.cbar_preview = ColorbarPreview(plotter) - self.cbar_preview.setMaximumHeight(self.tabs.sizeHint().height() // 3) - - vbox = QtWidgets.QVBoxLayout(self) - vbox.addWidget(self.cmap_widget) - vbox.addWidget(self.tabs) - vbox.addWidget(self.cbar_preview) - vbox.addWidget(self.button_box) - - @property - def plotter(self) -> Plotter: - """Get the plotter with the formatoptions we use to fill this dialog.""" - return self.bounds_widget.editor.fmto.plotter - - def update_preview(self) -> None: - """Update the :attr:`cbar_preview` from the various :attr:`fmt_widgets`. - """ - try: - bounds = self.bounds_widget.editor.value - except Exception: - bounds = self.plotter.bounds.value - try: - cticks = self.cticks_widget.editor.value - except Exception: - cticks = self.plotter.cticks.value - try: - cmap = self.cmap_widget.editor.value - except Exception: - cmap = self.plotter.cmap.value - self.cbar_preview.update_colorbar( - bounds=bounds, cticks=cticks, cmap=cmap) - - @property - def fmts(self) -> Dict[str, Any]: - """Map from formatoption in :attr:`fmt_widgets` to values.""" - ret = {} - for fmt, widget in self.fmt_widgets.items(): - if widget.editor.changed: - try: - value = widget.editor.value - except: - raise IOError(f"{fmt}-value {widget.editor.text} could " - "not be parsed to python!") - else: - ret[fmt] = value - return ret - - @classmethod - def update_project(cls, project: Project) -> None: - """Create a :class:`CmapDialog` to update a `project` - - This classmethod creates a new :class:`CmapDialog` instance, fills it - with the formatoptions of the first plotter in `project`, enters the - main event loop, and updates the `project` upon acceptance. - - Parameters - ---------- - project: psyplot.project.Project - The psyplot project to update - """ - dialog = cls(project) - dialog.show() - dialog.raise_() - dialog.activateWindow() - dialog.exec_() - if dialog.result() == QtWidgets.QDialog.Accepted: - project.update(**dialog.fmts) - - -class _DummyFormatOption(Formatoption): - """Dummy formatoption for static type checking. - - This is just a workaround for the static type checker to be able to tell - what the :class:`FakePlotter` formatoptions are, used in - :attr:`ColorbarPreview.fake_plotter` - """ - def update(self,): - pass - - -class FakePlotter(Plotter): - """A dummy plotter for the colorbar preview.""" - - bounds: Formatoption = _DummyFormatOption('bounds') - cmap: Formatoption = _DummyFormatOption('cmap') - cticks: Formatoption = _DummyFormatOption('cticks') - cbar: Formatoption = _DummyFormatOption('cbar') - - -class ColorbarPreview(FigureCanvas): - """A preview widget of a colorbar. - - This matplotlib figure contains one single axes to display the colorbar - filled by the formatoptions of a given `plotter`.""" - - def __init__( - self, - plotter: Plotter, - parent: Optional[QtWidgets.QWidget] = None, - *args, **kwargs - ) -> None: - """ - Parameters - ---------- - plotter: psy_simple.plotters.Base2D - The plotter to use to draw the colorbar from - parent: QtWidget.QWidget - The parent widget - """ - fig = Figure(*args, **kwargs) - - FigureCanvas.__init__(self, fig) - self.setParent(parent) - - FigureCanvas.setSizePolicy(self, - QtWidgets.QSizePolicy.Expanding, - QtWidgets.QSizePolicy.Expanding) - FigureCanvas.updateGeometry(self) - self.axes_counter = 0 - - #: The plotter to use for displaying the colorbar - self.plotter = plotter - self.init_colorbar(plotter) - - def resizeEvent(self, event: QEvent) -> Any: - """Reimplemented to make sure we cannot get smaller than 0.""" - h = event.size().height() - if h <= 0: - return - return super().resizeEvent(event) - - def init_colorbar(self, plotter: Plotter) -> None: - """Initialize the colorbar. - - This method extracts the formatoptions of the given `plotter` and draws - the colorbar. - """ - from matplotlib.cm import ScalarMappable - norm = plotter.bounds.norm - cmap = plotter.cmap.get_cmap(self.plotter.plot.array) - - self.mappable = sm = ScalarMappable(cmap=cmap, norm=norm) - sm.set_array([]) - - self.cax = self.figure.add_axes([0.1, 0.5, 0.8, 0.5], - label=self.axes_counter) - - self.cbar = self.figure.colorbar( - sm, norm=norm, cmap=cmap, cax=self.cax, orientation='horizontal') - - @property - def fake_plotter(self) -> FakePlotter: - """Create a plotter with the formatoptions of the real :attr:`plotter`. - - We can update this plotter without impacting the origin :attr:`plotter` - """ - from psyplot.plotter import Plotter - - class _FakePlotter(FakePlotter): - bounds = self.plotter.bounds.__class__('bounds') - cmap = self.plotter.cmap.__class__('cmap') - cticks = self.plotter.cticks.__class__('cticks') - cbar = self.plotter.cbar.__class__('cbar') - - _rcparams_string = self.plotter._get_rc_strings() - - ref = self.plotter - fig = Figure() - ax = fig.add_subplot() - - plotter = _FakePlotter( - ref.data.copy(), make_plot=False, bounds=ref['bounds'], - cmap=ref['cmap'], cticks=ref['cticks'], cbar='', ax=ax) - - plotter.cticks._colorbar = self.cbar - - plotter.plot_data = ref.plot_data - return plotter - - def update_colorbar(self, **kwargs) -> None: - """Update the colorbar with new formatoptions. - - This method takes the :attr:`fake_plotter`, updates it from the given - `kwargs`, updates the colorbar preview. - - Parameters - ---------- - ``**kwargs`` - `bounds`, `cmap`, `cticks` or `cbar` formatoption keyword-value - pairs - """ - - # create a dummy plotter - plotter = self.fake_plotter - - # update from the given kwargs - try: - for key, val in kwargs.items(): - plotter[key] = val - except (ValueError, TypeError): - return - - plotter.initialize_plot(ax=plotter.ax) - - current_norm = self.mappable.norm - current_cmap = self.mappable.get_cmap() - current_locator = self.cbar.locator - - # update the preview with the norm of the plotter - try: - try: - plotter.bounds.norm._check_vmin_vmax() - except (AttributeError, TypeError): - pass - try: - plotter.bounds.norm.autoscale_None(plotter.bounds.array) - except AttributeError: - pass - self.mappable.set_norm(plotter.bounds.norm) - self.mappable.set_cmap(plotter.cmap.get_cmap( - self.plotter.plot.array)) - plotter.cticks.colorbar = self.cbar - plotter.cticks.default_locator = \ - self.plotter.cticks.default_locator - plotter.cticks.update_axis(plotter.cticks.value) - self.draw() - - except Exception: - self.mappable.set_norm(current_norm) - self.mappable.set_cmap(current_cmap) - self.cbar.locator = current_locator - self.cbar.update_ticks() - - -class FormatoptionsEditor(QtWidgets.QWidget): - """A widget to update a formatoption. - - This widget is a light-weight version of the - :class:`psyplot_gui.fmt_widget.FormatoptionsWidget` class. It contains - a line editor and a text editor to set the value of a specific formatoption. - """ - - def __init__(self, fmto: Formatoption, *args, **kwargs) -> None: - """ - Parameters - ---------- - fmto: psyplot.plotter.Formatoption - The formatoption instance to display the value from - """ - super().__init__(*args, **kwargs) - layout = QtWidgets.QHBoxLayout() - - #: The :class:`~psyplot.plotter.Formatoption` that fills this widget - self.fmto = fmto - - #: A single line editor holding the formatoption value (see also - #: :attr:`text_edit` and :attr:`btn_multiline`) - self.line_edit = QtWidgets.QLineEdit() - layout.addWidget(self.line_edit) - - #: A multi-line editor holiding the value of :attr:`fmto` (see also - #: :attr:`line_edit` and :attr:`btn_multiline`) - self.text_edit = QtWidgets.QTextEdit() - self.text_edit.setVisible(False) - layout.addWidget(self.text_edit) - - #: A tool button to switch from the single line editor :attr:`line_edit` - #: to the multi-line editor :attr:`text_edit` - self.btn_multiline = QtWidgets.QToolButton() - self.btn_multiline.setText('⌵') - self.btn_multiline.setCheckable(True) - self.btn_multiline.setToolTip("Toggle multiline editor") - self.btn_multiline.clicked.connect(self.toggle_multiline) - layout.addWidget(self.btn_multiline) - - self.insert_obj(fmto.value) - - #: Value of the :attr:`fmto` at the initialization of this widget - self.initial_value = self.line_edit.text() - - self.setLayout(layout) - - @property - def changed(self) -> bool: - """Check if the value in this editor differs from the original `fmto`. - """ - return self.fmto.diff(self.fmto.validate(self.get_obj())) - - def toggle_multiline(self) -> None: - """Switch from :attr:`line_edit` and :attr:`text_edit` or back.""" - multiline = self.multiline - self.text_edit.setVisible(multiline) - self.line_edit.setVisible(not multiline) - if multiline: - self.text_edit.setPlainText(self.line_edit.text()) - else: - self.line_edit.setText(self.text_edit.toPlainText()) - - @property - def multiline(self) -> bool: - """True if the :attr:`text_edit` should be visible.""" - return self.btn_multiline.isChecked() - - @property - def text(self) -> str: - """Text of the :attr:`text_edit` (or :attr:`line_edit`).""" - return (self.text_edit.toPlainText() if self.multiline else - self.line_edit.text()) - - @text.setter - def text(self, s: str) -> None: - self.clear_text() - if self.multiline: - self.text_edit.insertPlainText(s) - else: - self.line_edit.insert(s) - - @property - def value(self) -> Any: - """Load the value of :attr:`text` with yaml.""" - text = self.text - return yaml.load(text, Loader=yaml.Loader) - - def clear_text(self) -> None: - """Clear the editor.""" - if self.multiline: - self.text_edit.clear() - else: - self.line_edit.clear() - - def set_obj(self, obj: Any) -> None: - """Clear the editor and set another object.""" - self.clear_text() - self.insert_obj(obj) - - def get_obj(self) -> Any: - """Alias for :attr:`value`.""" - return self.value - - def insert_obj(self, obj: Any) -> None: - """Add a string to the formatoption widget. - - Parameters - ---------- - obj: object - The object to insert into the line editor. it will be dumped - using yaml and displayed in the :attr:`text_edit` (or - :attr:`line_edit`) - """ - current = self.text - use_line_edit = not self.multiline - # strings are treated separately such that we consider quotation marks - # at the borders - if isinstance(obj, str) and current: - if use_line_edit: - pos = self.line_edit.cursorPosition() - else: - pos = self.text_edit.textCursor().position() - if pos not in [0, len(current)]: - s = obj - else: - if current[0] in ['"', "'"]: - current = current[1:-1] - self.clear_text() - if pos == 0: - s = '"' + obj + current + '"' - else: - s = '"' + current + obj + '"' - current = '' - elif isinstance(obj, str): # add quotation marks - s = '"' + obj + '"' - else: - s = yaml.dump(obj, default_flow_style=True).strip() - if s.endswith('\n...'): - s = s[:-4] - if use_line_edit: - self.line_edit.insert(s) - else: - self.text_edit.insertPlainText(s) - - -class LabelWidgetLine(QtWidgets.QGroupBox): - """A widget to change a formatoption. - - This class holds a :class:`FormatoptionsEditor` to control the - appearance of a specific formatoption. Additionally it displays the - formatoption specific line widget (see - :meth:`psyplot.plotter.Formatoption.get_fmt_widget`) to contol it. - """ - - def __init__(self, fmto: Formatoption, project: Project, - fmto_widget: Type[QtWidgets.QWidget], - widget_kws: Dict[str, Any] = {}, *args, **kwargs) -> None: - """ - Parameters - ---------- - fmto: psyplot.plotter.Formatoption - The formatoption to manipulate - project: psyplot.project.Project - The project to use to fill this formatoption - fmto_widget: type - A subclass of the :class:`QWidget` that can be used to control - the formatoption. This class is commonly used in the - :meth:`psyplot.plotter.Formatoption.get_fmt_widget` of the given - `fmto` - widget_kws: dict - Further keywords that are passed to the creation of the - `fmto_widget` instance. - """ - super().__init__(f'{fmto.name} ({fmto.key})', *args, **kwargs) - self.editor = FormatoptionsEditor(fmto) - vbox = QtWidgets.QVBoxLayout() - vbox.addWidget( - fmto_widget(self.editor, fmto, project, **widget_kws)) - vbox.addWidget(self.editor) - self.setLayout(vbox) - - -class LabelDialog(QtWidgets.QDialog): - """A dialog to change labels. - - This class contains one :class:`LabelWidgetLine` per text formatoption.""" - - def __init__(self, project: Project, *fmts: str) -> None: - """ - Parameters - ---------- - project: psyplot.project.Project - The psyplot project to update. Note that we will only use the - very first plotter in this project - ``*fmts`` - The formatoption keys to display. Each formatoption should be a - subclass of :class:`psy_simple.base.TextBase` - """ - from psy_simple.widgets.texts import LabelWidget - super().__init__() - self.project = project - layout = QtWidgets.QVBoxLayout() - plotter = project.plotters[0] - self.fmt_widgets = {} - for fmt in fmts: - fmto = getattr(plotter, fmt) - fmt_widget = LabelWidgetLine( - fmto, project, LabelWidget, widget_kws=dict(properties=False)) - self.fmt_widgets[fmt] = fmt_widget - layout.addWidget(fmt_widget) - - self.button_box = QtWidgets.QDialogButtonBox( - QtWidgets.QDialogButtonBox.Ok | QtWidgets.QDialogButtonBox.Cancel, - self) - self.button_box.accepted.connect(self.accept) - self.button_box.rejected.connect(self.reject) - layout.addWidget(self.button_box) - self.setLayout(layout) - - @property - def fmts(self) -> Dict[str, Any]: - """Mapping from formatoption key to value in this dialog.""" - ret = {} - for fmt, widget in self.fmt_widgets.items(): - if widget.editor.changed: - try: - value = widget.editor.value - except Exception: - raise IOError(f"{fmt}-value {widget.editor.text} could " - "not be parsed to python!") - else: - ret[fmt] = value - return ret - - @classmethod - def update_project(cls, project: Project, *fmts: str) -> None: - """Create a :class:`LabelDialog` to update the labels in a `project`. - - This classmethod creates a new :class:`LabelDialog` instance, fills it - with the formatoptions of the first plotter in `project`, enters the - main event loop, and updates the `project` upon acceptance. - - Parameters - ---------- - project: psyplot.project.Project - The psyplot project to update. Note that we will only use the - very first plotter in this project - ``*fmts`` - The formatoption keys to display. Each formatoption should be a - subclass of :class:`psy_simple.base.TextBase` - """ - dialog = cls(project, *fmts) - dialog.show() - dialog.raise_() - dialog.activateWindow() - dialog.exec_() - if dialog.result() == QtWidgets.QDialog.Accepted: - project.update( - **dialog.fmts) diff --git a/psy_view/ds_widget.py b/psy_view/ds_widget.py deleted file mode 100644 index 0ac5aa4..0000000 --- a/psy_view/ds_widget.py +++ /dev/null @@ -1,1740 +0,0 @@ -# -*- coding: utf-8 -*- -"""Dataset widget to display the contents of a dataset - -Copyright (C) 2020 Philipp S. Sommer - -This program is free software: you can redistribute it and/or modify -it under the terms of the GNU General Public License as published by -the Free Software Foundation, either version 3 of the License, or -(at your option) any later version. - -This program is distributed in the hope that it will be useful, -but WITHOUT ANY WARRANTY; without even the implied warranty of -MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -GNU General Public License for more details. - -You should have received a copy of the GNU General Public License -along with this program. If not, see https://www.gnu.org/licenses/.""" -from __future__ import annotations - -import os.path as osp -import os - -from typing import ( - List, - TYPE_CHECKING, - Optional, - Union, - Dict, - Iterator, - Type, - Any, - Callable, - Hashable, - Tuple, -) - -import contextlib - -import yaml -from PyQt5 import QtWidgets, QtGui -from PyQt5.QtCore import Qt # pylint: disable=no-name-in-module -import psy_view.utils as utils -from psyplot_gui.content_widget import ( - DatasetTree, DatasetTreeItem, escape_html) -from psyplot_gui.common import ( - DockMixin, get_icon as get_psy_icon, PyErrorMessage) -import psyplot.data as psyd -from psy_view.rcsetup import rcParams -from psy_view.plotmethods import ( - PlotMethodWidget, - MapPlotWidget, - Plot2DWidget, - LinePlotWidget, -) -from psyplot.config.rcsetup import get_configdir - -from matplotlib.animation import FuncAnimation - -if TYPE_CHECKING: - from xarray import DataArray, Dataset - from psyplot.project import PlotterInterface, Project - from psyplot.plotter import Plotter - from matplotlib.figure import Figure - from matplotlib.backend_bases import MouseEvent - from psyplot_gui.main import MainWindow - - -NOTSET = "__NOVARIABLEAVAILABLE" - - -def get_dims_to_iterate(arr: DataArray) -> List[str]: - """Get the dimensions of an array to iterate over - - This function takes a data array and returns the dimension in the base - dataset that one can interator over. - - Parameters - ---------- - arr: xarray.DataArray - The data array to iterate over - - Returns - ------- - list of strings - The dimension strings - """ - base_var = next(arr.psy.iter_base_variables) - return [dim for dim, size in zip(base_var.dims, base_var.shape) - if size > 1 and arr[dim].ndim == 0] - -TOO_MANY_FIGURES_WARNING = """ -Multiple figures are open but you specified only {} filenames: {}.
- -Saving the figures will cause that not all images are saved! We recommend to -export to a single PDF (that then includes multiple pages), or modify your -filename with strings like - - - -Shall I continue anyway and save the figures? -""" - - -class DatasetWidget(QtWidgets.QSplitter): - """A widget to control the visualization of the variables in a dataset""" - - #: The title of the widget - title: str = 'psy-view Plot Control' - - #: Display the dock widget at the right side of the GUI - dock_position = Qt.RightDockWidgetArea - - _animating: bool = False - - _ani: Optional[FuncAnimation] = None - - _init_step: int = 0 - - #: A :class:`PyQt5.QtWidgets.QGroupBox` that contains the variable buttons - variable_frame: Optional[QtWidgets.QGroupBox] = None - - #: Buttons for selecting variables in the :attr:`ds` - variable_buttons: Dict[str, QtWidgets.QPushButton] - - _new_plot: bool = False - - _preset: Optional[Union[str, Dict]] = None - - #: Attributes to use in the dataset tree - ds_attr_columns: List[str] = ['long_name', 'dims', 'shape'] - - def __init__(self, ds: Optional[Dataset] = None, *args, **kwargs) -> None: - """ - Parameters - ---------- - ds: xarray.Dataset - A dataset to visualize with this widget - """ - super().__init__(*args, **kwargs) - - self._ds_nums: Dict[int, Dataset] = {} - - self.setChildrenCollapsible(False) - - self.ds: Optional[Dataset] = ds - - self.setOrientation(Qt.Vertical) - - self.error_msg = PyErrorMessage(self) - - # first row: dataset name - self.open_box = QtWidgets.QHBoxLayout() - self.lbl_ds = QtWidgets.QLineEdit() - self.open_box.addWidget(self.lbl_ds) - self.btn_open = utils.add_pushbutton( - get_psy_icon('run_arrow.png'), lambda: self.set_dataset(), - "Select and open a netCDF dataset", self.open_box, icon=True) - self.open_widget = QtWidgets.QWidget() - self.open_widget.setLayout(self.open_box) - self.addWidget(self.open_widget) - - - # second row: dataset representation - self.setup_ds_tree() - if ds is not None: - self.add_ds_item() - - self.ds_tree.itemExpanded.connect(self.change_ds) - self.ds_tree.itemExpanded.connect(self.load_variable_desc) - - self.addWidget(self.ds_tree) - - # third row, navigation - self.navigation_box = QtWidgets.QHBoxLayout() - - # -- animate backwards button - self.btn_animate_backward = utils.add_pushbutton( - "◀◀", lambda: self.animate_backward(), - "Animate the time dimension backwards", self.navigation_box) - self.btn_animate_backward.setCheckable(True) - - # -- go to previous button - self.btn_prev = utils.add_pushbutton( - '◀', self.go_to_previous_step, - "Go to previous time step", self.navigation_box) - - # -- dimension menu for animation - self.combo_dims = QtWidgets.QComboBox() - self.navigation_box.addWidget(self.combo_dims) - - # -- go to next button - self.btn_next = utils.add_pushbutton( - '▶', self.go_to_next_step, - "Go to next time step", self.navigation_box) - - # -- animate forward button - self.btn_animate_forward = utils.add_pushbutton( - "▶▶", lambda: self.animate_forward(), - "Animate the time dimension", self.navigation_box) - self.btn_animate_forward.setCheckable(True) - - # -- interval slider - self.sl_interval = QtWidgets.QSlider(Qt.Horizontal) - self.sl_interval.setMinimum(40) # 24 fps - self.sl_interval.setMaximum(10000) - self.sl_interval.setSingleStep(50) - self.sl_interval.setPageStep(500) - self.sl_interval.setValue(500) - self.sl_interval.valueChanged.connect(self.reset_timer_interval) - self.navigation_box.addWidget(self.sl_interval) - - # -- interval label - self.lbl_interval = QtWidgets.QLabel('500 ms') - self.navigation_box.addWidget(self.lbl_interval) - - # --- export/import menus - self.export_box = QtWidgets.QHBoxLayout() - - # -- Export button - self.btn_export = QtWidgets.QToolButton() - self.btn_export.setText('Export') - self.btn_export.setPopupMode(QtWidgets.QToolButton.InstantPopup) - self.btn_export.setMenu(self.setup_export_menu()) - self.btn_export.setEnabled(False) - self.export_box.addWidget(self.btn_export) - - # --- Presets button - self.frm_preset = QtWidgets.QFrame() - self.frm_preset.setFrameStyle(QtWidgets.QFrame.StyledPanel) - hbox = QtWidgets.QHBoxLayout(self.frm_preset) - - self.btn_preset = QtWidgets.QToolButton() - self.btn_preset.setText('Preset') - self.btn_preset.setPopupMode(QtWidgets.QToolButton.InstantPopup) - self.btn_preset.setMenu(self.setup_preset_menu()) - hbox.addWidget(self.btn_preset) - - # --- presets label - self.lbl_preset = QtWidgets.QLabel('') - self.lbl_preset.setVisible(False) - hbox.addWidget(self.lbl_preset) - - # --- unset preset button - self.btn_unset_preset = utils.add_pushbutton( - get_psy_icon('invalid.png'), self.unset_preset, - "Unset the current preset", hbox, icon=True) - self.btn_unset_preset.setVisible(False) - - self.export_box.addWidget(self.frm_preset) - - self.btn_reload = utils.add_pushbutton( - get_psy_icon("refresh.png"), self.reload, - "Close all open datasets and recreate the plots", - self.export_box, icon=True - ) - - self.export_box.addStretch(0) - - vbox = QtWidgets.QVBoxLayout() - vbox.addLayout(self.navigation_box) - vbox.addLayout(self.export_box) - - self.addLayout(vbox) - - # fourth row: array selector - - self.array_frame = QtWidgets.QGroupBox('Current plot') - hbox = QtWidgets.QHBoxLayout() - - self.combo_array = QtWidgets.QComboBox() - self.combo_array.setEditable(False) - self.combo_array.currentIndexChanged.connect(lambda: self.refresh()) - self.combo_array.currentIndexChanged.connect(self.show_current_figure) - hbox.addWidget(self.combo_array) - - self.btn_add = utils.add_pushbutton( - QtGui.QIcon(get_psy_icon('plus')), self.new_plot, - "Create a new plot", hbox, icon=True) - self.btn_add.setEnabled(ds is not None) - self.btn_del = utils.add_pushbutton( - QtGui.QIcon(get_psy_icon('minus')), self.close_current_plot, - "Remove the current plot", hbox, icon=True) - self.btn_del.setEnabled(False) - - hbox.addWidget(self.btn_add) - hbox.addWidget(self.btn_del) - self.array_frame.setLayout(hbox) - self.addWidget(self.array_frame) - - # fifth row: plot interface - self.plot_tabs = QtWidgets.QTabWidget() - self.setup_plot_tabs() - self.plot_tabs.currentChanged.connect(self.switch_tab) - - self.addWidget(self.plot_tabs) - - # sixth row: variables - self.variable_scroll = QtWidgets.QScrollArea() - self.variable_scroll.setWidgetResizable(True) - self.setup_variable_buttons() - self.addWidget(self.variable_scroll) - - # seventh row: dimensions - self.dimension_table = QtWidgets.QTableWidget() - self.addWidget(self.dimension_table) - - self.disable_navigation() - - if self.ds is not None: - self.refresh() - - self.cids: Dict[str, int] = {} - - def reload(self) -> None: - """Close the plot and recreate it.""" - import psyplot.project as psy - - sp = self._sp - fname = sp.dsnames_map[self.ds.psy.num] # type: ignore - project = sp.save_project() - sp.close(True, True, True) - self.ds_tree.clear() - self._ds_nums.clear() - self.refresh() - self._sp = sp = psy.Project.load_project(project) - self._ds_nums = sp.datasets - num = next(num for num, f in sp.dsnames_map.items() if f == fname) - self.ds = self.open_datasets[num] - for ds in self._ds_nums.values(): - self._add_ds_item(ds) - sp.show() - self.refresh() - - def setup_ds_tree(self) -> None: - """Setup the number of columns and the header of the dataset tree.""" - self.ds_tree = tree = QtWidgets.QTreeWidget() - tree.setColumnCount(len(self.ds_attr_columns) + 1) - tree.setHeaderLabels([''] + self.ds_attr_columns) - - def showEvent(self, event): - ret = super().showEvent(event) - current_size = self.size() - current_sizes = self.sizes() - - itree = self.indexOf(self.ds_tree) - itable = self.indexOf(self.dimension_table) - diff = 0 - if current_sizes[itree] < 400: - diff += 400 - current_sizes[itree] - current_sizes[itree] = 400 - if current_sizes[itable] < 300: - diff += 300 - current_sizes[itable] - current_sizes[itable] = 300 - if diff: - self.resize(current_size.width(), current_size.height() + diff) - self.setSizes(current_sizes) - return ret - - def close_current_plot(self) -> None: - """Close the figure of the current variable.""" - self.variable_buttons[self.variable].click() - - def excepthook(self, type, value, traceback) -> None: - """A method to replace the sys.excepthook""" - self.error_msg.excepthook(type, value, traceback) - - @property - def arr_name(self) -> Optional[str]: - """Get the name of the array of the current plot (if there is one).""" - if not self.combo_array.count(): - return None - else: - return self.combo_array.currentText().split(':')[0] - - def change_ds(self, ds_item: DatasetTreeItem) -> None: - """Change the current dataset to another one. - - Parameters - ---------- - ds_item: psyplot_gui.content_widget.DatasetTreeItem - The item in the tree of the new dataset to use - """ - ds_items = self.ds_items - if ds_item in ds_items: - with self.block_tree(): - self.ds = ds_item.ds() - self.expand_ds_item(ds_item) - self.setup_variable_buttons() - self.change_combo_array() - self.refresh(reset_combo=False) - - def expand_ds_item(self, ds_item: DatasetTreeItem) -> None: - """Expand an item of a dataset. - - Parameters - ---------- - ds_item: DatasetTreeItem - The item to expand - """ - tree = self.ds_tree - - tree.collapseAll() - - tree.expandItem(ds_item) - - ds = ds_item.ds() - if len(ds) <= 10: - tree.expandItem(ds_item.child(0)) - if len(ds.coords) <= 10: - tree.expandItem(ds_item.child(1)) - if len(ds.attrs) <= 10: - tree.expandItem(ds_item.attrs) - - def _open_dataset(self) -> Optional[Dataset]: - """Open a dialog to open a new dataset from disk. - - Returns - ------- - xarray.Dataset or None - The :class:`xarray.Dataset` of the selected file, or None if the - user aborted the dialog. - """ - current = self.lbl_ds.text() - if not current or not osp.exists(current): - current = os.getcwd() - fname, ok = QtWidgets.QFileDialog.getOpenFileName( - self, 'Open dataset', current, - 'NetCDF files (*.nc *.nc4);;' - 'Shape files (*.shp);;' - 'All files (*)' - ) - if not ok: - return None - ds = psyd.open_dataset(fname) - return ds - - @contextlib.contextmanager - def block_tree(self) -> Iterator[None]: - """Block all signals of a tree temporarily. - - Use this via:: - - with self.block_tree(): - do_something - """ - self.ds_tree.blockSignals(True) - yield - self.ds_tree.blockSignals(False) - - def set_dataset(self, ds: Optional[Dataset] = None) -> None: - """Ask for a file name and open the dataset.""" - if ds is None: - ds = self._open_dataset() - if ds is None: - return - self.ds = ds - with self.block_tree(): - self.add_ds_item() - self.setup_variable_buttons() - self.btn_add.setEnabled(True) - self.btn_del.setEnabled(True) - - def add_ds_item(self) -> None: - """Add a new :class:`DatasetTreeItem` for the current :attr:`ds`.""" - ds: Dataset = self.ds # type: ignore - self._add_ds_item(ds) - - def _add_ds_item(self, ds: Dataset) -> None: - tree = self.ds_tree - ds_item = DatasetTreeItem(ds, self.ds_attr_columns, 0) - fname = psyd.get_filename_ds(ds, False)[0] - if fname is not None: - self.lbl_ds.setText(fname) - fname = osp.basename(fname) - else: - self.lbl_ds.setText('') - fname = '' - ds_item.setText(0, fname) - tree.addTopLevelItem(ds_item) - - self.expand_ds_item(ds_item) - - tree.resizeColumnToContents(0) - - if ds.psy.num not in self.open_datasets: - # make sure we do not loose track of open datasets - self._ds_nums[ds.psy.num] = ds - - - @property - def open_datasets(self) -> Dict[int, Dataset]: - """Get a mapping from path to dataset number of the open datasets.""" - return self._ds_nums - - @property - def ds_items(self) -> List[DatasetTreeItem]: - """Get the :class:`DatasetTreeItems` for the open datasets.""" - tree = self.ds_tree - return list(map(tree.topLevelItem, range(tree.topLevelItemCount()))) - - @property - def ds_item(self) -> Optional[DatasetTreeItem]: - """Get the current dataset item (if there is one).""" - ds = self.ds - for item in self.ds_items: - if item.ds() is ds: - return item - return None - - def expand_current_variable( - self, variable: Optional[Union[Any, Hashable]] = None) -> None: - """Expand the item in the dataset tree of variable. - - Parameters - ---------- - variable: str - The name of the variable to expand. If None, the current variable is - used. - """ - tree = self.ds_tree - top: DatasetTreeItem = self.ds_item # type: ignore - tree.expandItem(top) - tree.expandItem(top.child(0)) - if variable is None: - variable: str = self.variable # type: ignore - for var_item in map(top.child(0).child, - range(top.child(0).childCount())): - if var_item.text(0) == variable: - tree.expandItem(var_item) - else: - tree.collapseItem(var_item) - - def setup_variable_buttons(self, ncols: int = 4) -> None: - """Setup the variable buttons for the current dataset.""" - variable_frame = QtWidgets.QGroupBox('Variables') - - self.variable_scroll.setWidget(variable_frame) - self.variable_frame = variable_frame - self.variable_layout = QtWidgets.QGridLayout(self.variable_frame) - self.variable_buttons = {} - - ds = self.ds - - if ds is not None: - - for i, v in enumerate(ds): - btn = utils.add_pushbutton( - v, self._draw_variable(v), f"Visualize variable {v}") - btn.setCheckable(True) - self.variable_buttons[v] = btn - self.variable_layout.addWidget(btn, i // ncols, i % ncols) - - if len(ds): - rows = len(ds) // ncols - minrows = max(1, min(3, rows)) - self.variable_scroll.setMinimumHeight( - (minrows + 2) * btn.sizeHint().height()) - - def load_variable_desc(self, item: QtWidgets.QTreeWidgetItem) -> None: - """Load the description of the variable of a given tree item. - - Parameters - ---------- - item: PyQt5.QtWidget.QTreeWidgetItem - The item of the variable in the :attr:`ds_tree`. If this is not an - item of a variable, nothing is done. - """ - parent = item.parent() - - tree = self.ds_tree - - if parent is tree or parent is None or not ( - DatasetTree.is_variable(item) or DatasetTree.is_coord(item)): - return - - if tree.isColumnHidden(1): - tree.showColumn(1) - tree.resizeColumnToContents(0) - - top = item - while top.parent() and top.parent() is not self: - top = top.parent() - ds = top.ds() - if ds is None: - return - desc = escape_html(str(ds.variables[item.text(0)])) - item.setToolTip(0, '
' + desc + '
') - - def clear_table(self) -> None: - """Clear the table that shows the available dimensions.""" - self.dimension_table.clear() - self.dimension_table.setColumnCount(5) - self.dimension_table.setHorizontalHeaderLabels( - ['Type', 'First', 'Current', 'Last', 'Units']) - self.dimension_table.setRowCount(0) - - def addLayout(self, layout: QtWidgets.QLayout) -> QtWidgets.QWidget: - """Add a layout to the splitter. - - This convenience function creates a new QWidget that wraps the given - layout and returns it. - - Parameters - ---------- - layout: QtWidget.QLayout - The layout to add - - Returns - ------- - QtWidgets.QWidget - The widget that wraps the given layout - """ - widget = QtWidgets.QWidget() - widget.setLayout(layout) - self.addWidget(widget) - return widget - - def go_to_previous_step(self) -> None: - """Decrease the movie dimension to the previous step.""" - dim = self.combo_dims.currentText() - self.increase_dim(dim, -1)() - - def go_to_next_step(self) -> None: - """Increase the movie dimension to the next step.""" - dim = self.combo_dims.currentText() - self.increase_dim(dim)() - - def animate_backward(self) -> None: - """Start the current animation in backward direction, or stop it.""" - if self._animating: - self.stop_animation() - self.btn_animate_backward.setText('◀◀') - self.enable_navigation() - else: - self._animate_forward = False - self.btn_animate_backward.setText('■') - self.disable_navigation(self.btn_animate_backward) - self.start_animation() - - def animate_forward(self, nframes=None): - """Start the current animation in forward direction, or stop it.""" - if self._animating: - self.stop_animation() - self.btn_animate_forward.setText('▶▶') - self.enable_navigation() - else: - self._animate_forward = True - self.btn_animate_forward.setText('■') - self.disable_navigation(self.btn_animate_forward) - self.start_animation(nframes) - - def setup_plot_tabs(self) -> None: - """Setup the tabs of the various plot methods.""" - self.plot_tabs.addTab(MapPlotWidget(self.get_sp, self.ds), - 'mapplot') - self.plot_tabs.addTab(Plot2DWidget(self.get_sp, self.ds), - 'plot2d') - lineplot_widget = LinePlotWidget(self.get_sp, self.ds) - self.plot_tabs.addTab(lineplot_widget, 'lineplot') - - for w in map(self.plot_tabs.widget, range(self.plot_tabs.count())): - w.replot.connect(self.replot) - w.reset.connect(self.reset) - w.changed.connect(lambda: self.refresh()) - - def replot(self, plotmethod: str) -> None: - """Regenerate the plot of a given plotmethod, without closing it. - - Parameters - ---------- - plotmethod: str - The name of the plotmethod - - See Also - -------- - reset: The same method, but closes the plot before genereting a new one. - """ - self.plotmethod = plotmethod - self.make_plot() - self.refresh() - - def reset(self, plotmethod: str) -> None: - """Close the plot of the given plotmethod and regenerate it. - - The same as :meth:`replot`, but closes the plot. - - Parameters - ---------- - plotmethod: str - The name of the plotmethod - - See Also - -------- - reset: The same method, but closes the plot before genereting a new one. - """ - self.plotmethod = plotmethod - self.close_sp() - self.make_plot() - self.refresh() - - def disable_navigation( - self, but: Optional[QtWidgets.QPushButton] = None - ) -> None: - """Disable the navigation buttons. - - This function disables all navigation buttons but the one you specify. - - Parameters - ---------- - but: PyQt5.QtWidgets.QPushButton - If not None, this button is not disabled. - """ - for item in map(self.navigation_box.itemAt, - range(self.navigation_box.count())): - w = item.widget() - if w is not but and w is not self.sl_interval: - w.setEnabled(False) - - def enable_navigation(self) -> None: - """Enable all navigation buttons again.""" - for item in map(self.navigation_box.itemAt, - range(self.navigation_box.count())): - w = item.widget() - w.setEnabled(True) - - def disable_variables(self): - """Disable all variable selection buttons.""" - for btn in self.variable_buttons.values(): - btn.setEnabled(False) - - def enable_variables(self): - """Enable all variable selection buttons again.""" - valid_variables = self.plotmethod_widget.valid_variables(self.ds) - for v, btn in self.variable_buttons.items(): - btn.setEnabled(v in valid_variables) - - def start_animation(self, nframes: Optional[int] = None): - """Start the animation along the selected dimension. - - Parameters - ---------- - nframes: int or None - If not None, the number of frames to draw - - See Also - -------- - animation_frames: The iterator to generate the frames - """ - self._animating = True - self._animation_frames = nframes - self._starting_step = 1 - self.disable_variables() - self.plot_tabs.setEnabled(False) - if self.sp is not None: - if self.animation is None or self.animation.event_source is None: - self.animation = FuncAnimation( - self.fig, self.update_dims, frames=self.animation_frames(), - init_func=self.sp.draw, interval=self.sl_interval.value(), - repeat=False) - # HACK: Make sure that the animation starts although the figure - # is already shown - self.animation._draw_frame(next(self.animation_frames())) - else: - self.animation.event_source.start() - - def reset_timer_interval(self, value: int) -> None: - """Change the interval of the timer.""" - self.lbl_interval.setText('%i ms' % value) - if self.animation is None or self.animation.event_source is None: - pass - else: - self.animation.event_source.stop() - self.animation._interval = value - self.animation.event_source.interval = value - self.animation.event_source.start() - - def stop_animation(self) -> None: - """Stop the current animation.""" - self._animating = False - if (self.animation is not None and - self.animation.event_source is not None): - self.animation.event_source.stop() - self.plot_tabs.setEnabled(True) - self.enable_variables() - self.refresh() - - def animation_frames(self) -> Iterator[Dict[str, int]]: - """Get the animation frames for the :attr:`combo_dims` dimension.""" - while self._animating and self._animation_frames is None or \ - self._animation_frames: - if self._animation_frames is not None and not self._init_step: - self._animation_frames -= 1 - dim = self.combo_dims.currentText() - i = self.data.psy.idims[dim] - imax = self.ds.dims[dim] - 1 # type: ignore - if self._init_step: - self._init_step -= 1 - elif self._starting_step: - self._starting_step -= 1 - elif self._animate_forward: - i += -i if i == imax else 1 - else: - i += imax if i == 0 else -1 - yield {dim: i} - - def update_dims(self, dims: Dict[str, Any]): - if self.sp is not None: - self.sp.update(dims=dims) - - def _load_preset(self) -> None: - """Open a file dialog and load the selected preset.""" - fname, ok = QtWidgets.QFileDialog.getOpenFileName( - self, 'Load preset', osp.join(get_configdir(), 'presets'), - 'YAML files (*.yml *.yaml);;' - 'All files (*)') - if ok: - self.load_preset(fname) - - def load_preset(self, preset: Optional[Union[str, Dict[str, Any]]]): - """Load a given preset from disk. - - Parameters - ---------- - preset: str or dict - The name or path to the preset, or a dictionary - """ - self.preset = preset # type: ignore - if self.sp: - loaded_preset: Dict[str, Any] = self.preset # now that it's loaded - if loaded_preset: - self.sp.load_preset(loaded_preset) - self.refresh() - self.maybe_show_preset() - - @property - def preset(self) -> Dict[str, Any]: - """Get the currently loaded preset.""" - if self._preset is None: - return {} - import psyplot.project as psy - preset = self._preset - try: - preset = psy.Project._load_preset(preset) - except yaml.constructor.ConstructorError: - answer = QtWidgets.QMessageBox.question( - self, "Can I trust this?", - f"Failed to load the preset at {preset} in safe mode. Can we " - "trust this preset and load it in unsafe mode?") - if answer == QtWidgets.QMessageBox.Yes: - psyd.rcParams['presets.trusted'].append( - psy.Project._resolve_preset_path(preset)) - preset = psy.Project._load_preset(preset) - else: - preset = {} - return preset # type: ignore - - @preset.setter - def preset(self, value: Optional[Union[str, Dict[str, Any]]]): - self._preset = value - - - def unset_preset(self) -> None: - """Unset the current preset and do not use it anymore.""" - self.preset = None # type: ignore - self.maybe_show_preset() - - def maybe_show_preset(self) -> None: - """Show the name of the current preset if one is selected.""" - if self._preset is not None and isinstance(self._preset, str): - self.lbl_preset.setText('' + - osp.basename(osp.splitext(self._preset)[0]) + '') - self.lbl_preset.setVisible(True) - self.btn_unset_preset.setVisible(True) - elif self._preset is not None: - self.lbl_preset.setText('custom') - self.lbl_preset.setVisible(True) - self.btn_unset_preset.setVisible(True) - else: - self.lbl_preset.setVisible(False) - self.btn_unset_preset.setVisible(False) - - def save_current_preset(self) -> None: - """Save the preset of the current plot to a file.""" - if self.sp is not None: - preset_func = self.sp.save_preset - self._save_preset(preset_func) - - def save_full_preset(self) -> None: - """Save the preset of all open plots to a file.""" - sp = self._sp - if sp is not None: - return self._save_preset(sp.save_preset) - return None - - def _save_preset(self, save_func: Callable[[str], Any]) -> None: - """Save the preset to a file. - - Parameters - ---------- - save_func: function - The function that is called to save the preset. Must accept the - path as an argument - """ - fname, ok = QtWidgets.QFileDialog.getSaveFileName( - self, 'Save preset', osp.join(get_configdir(), 'presets'), - 'YAML files (*.yml *.yaml);;' - 'All files (*)') - if not ok: - return None - save_func(fname) - - def setup_preset_menu(self) -> QtWidgets.QMenu: - """Set up the menu to select/load presets.""" - self.preset_menu = menu = QtWidgets.QMenu() - self._save_preset_actions = [] - - self._load_preset_action = menu.addAction( - "Load preset", self._load_preset) - self._unset_preset_action = menu.addAction( - "Unset preset", self.unset_preset) - - menu.addSeparator() - - self._save_preset_actions.append( - menu.addAction('Save format of current plot as preset', - self.save_current_preset)) - self._save_preset_actions.append( - menu.addAction('Save format of all plots as preset', - self.save_full_preset)) - - for action in self._save_preset_actions: - action.setEnabled(False) - - return menu - - def setup_export_menu(self) -> QtWidgets.QMenu: - """Set up the menu to export the current plot.""" - self.export_menu = menu = QtWidgets.QMenu() - menu.addAction('image (PDF, PNG, etc.)', self.export_image) - menu.addAction('all images (PDF, PNG, etc.)', self.export_all_images) - menu.addAction('animation (GIF, MP4, etc.', self.export_animation) - menu.addAction('psyplot project (.pkl file)', self.export_project) - menu.addAction('psyplot project with data', - self.export_project_with_data) - py_action = menu.addAction('python script (.py)', self.export_python) - py_action.setEnabled(False) # psyplot does not yet export to python - return menu - - def export_image(self) -> None: - """Ask for a filename and export the current plot to a file.""" - if self.sp is not None: - fname, ok = QtWidgets.QFileDialog.getSaveFileName( - self, "Export image", os.getcwd(), - "Images (*.png *.pdf *.jpg *.svg)") - if ok: - self.sp.export(fname, **rcParams['savefig_kws']) - - def export_all_images(self) -> None: - """Ask for a filename and export all plots to one (or more) files.""" - fname, ok = QtWidgets.QFileDialog.getSaveFileName( - self, "Export image", os.getcwd(), - "Images (*.png *.pdf *.jpg *.svg)") - if ok and self._sp: - # test filenames - if not osp.splitext(fname)[-1].lower() == '.pdf': - fnames = [ - sp.format_string(fname, False, i) - for i, sp in enumerate(self._sp.figs.values())] - if len(fnames) != len(set(fnames)): - answer = QtWidgets.QMessageBox.question( - self, "Too many figures", - TOO_MANY_FIGURES_WARNING.format( - len(set(fnames)), ', '.join(set(fnames)))) - if answer == QtWidgets.QMessageBox.No: - return - self._sp.export(fname, **rcParams['savefig_kws']) - - def export_animation(self) -> None: - """Ask for a filename and export the animation.""" - fname, ok = QtWidgets.QFileDialog.getSaveFileName( - self, "Export animation", os.getcwd(), - "Movie (*.mp4 *.mov *.gif)") - if ok: - dim = self.combo_dims.currentText() - nframes: int = self.ds.dims[dim] # type: ignore - - self._init_step = 1 - self.animate_forward(nframes) - if self.animation is not None: - self.animation.save( - fname, **rcParams['animations.export_kws'], - fps=round(1000. / self.sl_interval.value())) - self.animate_forward() - self.animation = None - - def export_project(self) -> None: - """Ask for a filename and export the psyplot project as .pkl file.""" - if self.sp is not None: - fname, ok = QtWidgets.QFileDialog.getSaveFileName( - self, "Export project", os.getcwd(), - "Psyplot projects (*.pkl)") - if ok: - self.sp.save_project(fname) - - def export_project_with_data(self) -> None: - """Ask for a filename export project (incl. data) as .pkl file. - - Same as :meth:`export_project`, but adds the data to the pickle dump. - """ - if self.sp is not None: - fname, ok = QtWidgets.QFileDialog.getSaveFileName( - self, "Export project", os.getcwd(), - "Psyplot projects (*.pkl)") - if ok: - self.sp.save_project(fname, ds_description={"ds"}) - - def export_python(self): - """Export the project as python file. - - This method is not yet implemented as the functionality is missing in - psyplot. - """ - pass - - def _draw_variable(self, v): - def func(): - """Visualize variable v""" - btn = self.variable_buttons[v] - if not btn.isChecked(): - self.close_sp() - if self.combo_array.count() > 1: - with self.block_widgets(self.combo_array): - current = self.combo_array.currentIndex() - self.combo_array.setCurrentIndex(current - 1) - - else: - with self.silence_variable_buttons(): - for var, btn in self.variable_buttons.items(): - if var != v: - btn.setChecked(False) - self.make_plot() - self.refresh() - - return func - - @contextlib.contextmanager - def silence_variable_buttons(self) -> Iterator[None]: - """Context manager to disable variable selection buttons.""" - yield self.block_widgets(*self.variable_buttons.values()) # type: ignore - - @property - def variable(self) -> str: - """The current variable""" - for v, btn in self.variable_buttons.items(): - if btn.isChecked(): - return v - return NOTSET - - @variable.setter - def variable(self, value: str) -> None: - with self.silence_variable_buttons(): - for v, btn in self.variable_buttons.items(): - btn.setChecked(v == value) - - @property - def available_plotmethods(self) -> List[str]: - """Get the plotmethods that can visualize the selected variable. - - Returns - ------- - list of str - A list of plotmethod names that can visualize the current - :attr:`variable` - """ - v = self.variable - if v == NOTSET: - return [] - ret = [] - ds: Dataset = self.ds # type: ignore - plot = ds.psy.plot - for plotmethod in self.plotmethods: - if plotmethod in plot._plot_methods: - if getattr(plot, plotmethod).check_data(ds, v, {})[0]: - ret.append(plotmethod) - return ret - - @property - def plot(self) -> PlotterInterface: - """Get the plotting function of the currently selected plotmethod.""" - if self.ds is not None: - return getattr(self.ds.psy.plot, self.plotmethod) - else: - raise ValueError( - "No dataset has yet been selected, so no plot method!") - - @property - def plot_options(self) -> Dict[str, Any]: - """Get further keyword arguments for the :attr:`plot` function.""" - if self.ds is not None: - ret: Dict[str, Any] = self.plotmethod_widget.get_fmts( # type: ignore - self.ds.psy[self.variable], True) - preset = self.preset - if preset: - import psyplot.project as psy - preset = psy.Project.extract_fmts_from_preset( - preset, self.plotmethod) - ret.update(dict(preset)) - return ret - return {} - - @property - def plotmethod(self) -> str: - """Get the name of the current plotmethod.""" - return self.plot_tabs.tabText(self.plot_tabs.currentIndex()) - - @plotmethod.setter - def plotmethod(self, label: str): - i = next((i for i in range(self.plot_tabs.count()) - if self.plot_tabs.tabText(i) == label), None) - if i is not None: - self.plot_tabs.setCurrentIndex(i) - - @property - def plotmethods(self) -> List[str]: - """Get a list of available plotmethods.""" - return list(map(self.plot_tabs.tabText, range(self.plot_tabs.count()))) - - @property - def plotmethod_widget(self) -> PlotMethodWidget: - """Get widget of the current plotmethod.""" - label = self.plotmethod - i = next((i for i in range(self.plot_tabs.count()) - if self.plot_tabs.tabText(i) == label), None) - return self.plot_tabs.widget(i) - - @property - def plotmethod_widgets(self) -> Dict[str, PlotMethodWidget]: - """Get a list of available plotmethod widgets.""" - return dict(zip(self.plotmethods, map(self.plot_tabs.widget, - range(self.plot_tabs.count())))) - - _sp = None - - def get_sp(self) -> Optional[Project]: - sp = self._sp - if sp is None: - return sp - return self.filter_sp(sp) - - def filter_sp(self, sp: Project, ds_only: bool = False) -> Project: - """Filter the psyplot project to only include the arrays of :attr:`ds` - """ - if self._new_plot: - return None - if self.ds is None: - return sp - num = self.ds.psy.num - ret = sp[:0] - for i in range(len(sp)): - if list(sp[i:i+1].datasets) == [num]: - ret += sp[i:i+1] - if ds_only: - return ret - arr_name = self.arr_name - if arr_name is None: - return ret - return ret(arr_name=arr_name) - - def new_plot(self) -> None: - """Select a new variable and make a plot. - - This method asks for a variable and them makes a new plot with the - selected plotmethod. - - See Also - -------- - make_plot: plot the currently selected variable without asking - """ - if self.ds is not None: - name, ok = QtWidgets.QInputDialog.getItem( - self, 'New plot', 'Select a variable', - self.plotmethod_widget.valid_variables(self.ds)) - if not ok: - return - with self.silence_variable_buttons(): - for v, btn in self.variable_buttons.items(): - btn.setChecked(v == name) - with self.creating_new_plot(): - self.make_plot() - self.btn_del.setEnabled(True) - self.refresh() - - @contextlib.contextmanager - def creating_new_plot(self) -> Iterator[None]: - """Tell that we are making a new plot.""" - self._new_plot = True - yield - self._new_plot = False - - @property - def sp(self) -> Optional[Project]: - """Get the psyplot project of the current plotmethod.""" - return self.plotmethod_widget.sp or None - - @sp.setter - def sp(self, sp: Optional[Project]): - if sp is None and (not self._sp or not getattr( - self._sp, self.plotmethod)): - pass - else: - # first remove the current arrays - if self.get_sp() and getattr(self.get_sp(), self.plotmethod): - to_remove = getattr(self.get_sp(), self.plotmethod).arr_names - _sp: Project = self._sp # type: ignore - for i in list(reversed(range(len(_sp)))): - if _sp[i].psy.arr_name in to_remove: - _sp.pop(i) - # then add the new arrays - if sp: - if self._sp: - self._sp.extend(list(sp), new_name=True) - else: - self._sp = sp - - @property - def data(self) -> Union[psyd.InteractiveList, DataArray]: - """Get the raw data of the current plot.""" - return self.plotmethod_widget.data - - @property - def plotter(self) -> Plotter: - """Get the psyplot plotter of the current plot.""" - return self.plotmethod_widget.plotter - - @property - def fig(self) -> Figure: - """Get the figure of the current plot.""" - if self.sp: - return list(self.sp.figs)[0] - - _animations: Dict[str, FuncAnimation] = {} - - @property - def animation(self) -> Optional[FuncAnimation]: - """Get the animation of the current plotmethod.""" - return self._animations.get(self.plotmethod) - - @animation.setter - def animation(self, ani: Optional[FuncAnimation]): - if ani is None: - self._animations.pop(self.plotmethod, None) - else: - self._animations[self.plotmethod] = ani - - def make_plot(self) -> None: - """Make or update the plot of the current variable. - - See Also - -------- - new_plot: A function to select the variable first - """ - plotmethods = self.available_plotmethods - plotmethod = self.plotmethod - if plotmethod not in plotmethods: - if not plotmethods: - QtWidgets.QMessageBox.critical( - self, "Visualization impossible", - f"Found no plotmethod for variable {self.variable}") - return - plotmethod, ok = QtWidgets.QInputDialog.getItem( - self, "Choose a plot method", "Plot method:", plotmethods) - if not ok: - return - self.plotmethod = plotmethod - new_v = self.variable - fmts: Dict[str, Any] = {} - dims: Dict[Hashable, int] = {} - if self.sp: - ds: Dataset = self.ds # type: ignore - if not set(self.data.dims) <= set(ds[new_v].dims): - self.close_sp() - else: - for dim in set(ds[new_v].dims) - set(self.data.psy.idims): - dims[dim] = 0 - for dim in set(self.data.psy.idims) - set(ds[new_v].dims): - del self.data.psy.idims[dim] - if self.sp: - if self.data.psy.plotter is None: - self.data.psy.update(name=self.variable) - self.data.psy.update(dims=dims, **fmts) - self.sp.update(replot=True) - else: - self.data.psy.update(name=self.variable, dims=dims, **fmts) - self.show_fig(self.sp) - else: - self.ani = None - self.sp = sp = self.plot(name=self.variable, **self.plot_options) - self._preset = None - cid = sp.plotters[0].ax.figure.canvas.mpl_connect( - 'button_press_event', self.display_line) - self.cids[self.plotmethod] = cid - self.show_fig(sp) - descr = sp[0].psy._short_info() - with self.block_widgets(self.combo_array): - self.combo_array.addItem(descr) - self.combo_array.setCurrentText(descr) - self.expand_current_variable() - self.enable_navigation() - - @contextlib.contextmanager - def block_widgets(self, *widgets: QtWidgets.QWidget) -> Iterator[None]: - """Temporarilly block all signals for the given widgets.""" - for w in widgets: - w.blockSignals(True) - yield - for w in widgets: - w.blockSignals(False) - - def display_line(self, event: MouseEvent) -> None: - """Display the line when clicked on a 2D-plot.""" - if not event.inaxes: - return - else: - sl = None - for widget in map(self.plot_tabs.widget, - range(self.plot_tabs.count())): - if widget.sp and event.inaxes == widget.plotter.ax: - sl = widget.get_slice(event.xdata, event.ydata) - break - variable = widget.data.name - raw_data = widget.data.psy.base.psy[variable] - if (sl is None or widget.plotmethod not in ['mapplot', 'plot2d'] or - raw_data.ndim == 2 or - widget.plotter.ax.figure.canvas.manager.toolbar.mode != ''): - return - # check if the mappable contains the event - if not self.plotter.plot.mappable.contains(event)[0] and ( - not hasattr(self.plotter.plot, '_wrapped_plot') or - not self.plotter.plot._wrapped_plot.contains(event)[0]): - return - current_pm = self.plotmethod - self.plotmethod = 'lineplot' - linewidget = self.plotmethod_widget - xdim = linewidget.xdim - if xdim is None: - xdim = self.combo_dims.currentText() - - if not linewidget.sp or (linewidget.xdim and - linewidget.xdim not in raw_data.dims): - with self.silence_variable_buttons(): - for v, btn in self.variable_buttons.items(): - btn.setChecked(v == variable) - self.make_plot() - linewidget.xdim = xdim - else: - linewidget.xdim = xdim - linewidget.add_line(variable, **sl) - self.plotmethod = current_pm - - - def close_sp(self) -> None: - """Close the current subproject.""" - sp = self.sp - self.sp = None - if sp is not None: - sp.close(figs=True, data=True, ds=False) - - def show_current_figure(self) -> None: - """Show figure of the current plotmethod.""" - if self.sp is not None: - self.show_fig(self.sp) - - def show_fig(self, sp: Project) -> None: - """Show the first figure in a psyplot project.""" - if len(sp): - try: - fig = sp.plotters[0].ax.figure - fig.canvas.window().show() - fig.canvas.window().raise_() - except AttributeError: - sp.show() - - def switch_tab(self) -> None: - """Select a valid variable when switching the plotmethod tabs.""" - with self.silence_variable_buttons(): - if self.sp: - name = self.data.name - else: - name = NOTSET - for v, btn in self.variable_buttons.items(): - btn.setChecked(v == name) - self.refresh() - - def change_combo_array(self) -> None: - """Update the iteration dimension depending on the selected variable.""" - with self.block_widgets(self.combo_array): - sp = self.filter_sp(self._sp, ds_only=True) - if sp and self.arr_name not in sp.arr_names: - new_arr = sp.arr_names[0] - all_arrays = getattr(self._sp, self.plotmethod) - try: - idx_arr = all_arrays.arr_names.index(new_arr) - except ValueError: - idx_arr = 0 - self.combo_array.setCurrentIndex(idx_arr) - try: - vname = self.data.name - except Exception: - vname = self.variable - if vname != NOTSET: - self.expand_current_variable(vname) - self.show_fig(sp[:1]) - - def reset_combo_array(self) -> None: - """Clear and fill the iteration dimension based on :attr:`ds`.""" - curr_arr_name = self.arr_name - with self.block_widgets(self.combo_array): - self.combo_array.clear() - if self._sp: - all_arrays = getattr(self._sp, self.plotmethod) - current_ds = self.ds - if all_arrays: - for arr in all_arrays: - self.combo_array.addItem(arr.psy._short_info()) - if curr_arr_name in all_arrays.arr_names: - idx_arr = all_arrays.arr_names.index(curr_arr_name) - self.combo_array.setCurrentIndex(idx_arr) - else: - idx_arr = 0 - self.ds = list( - all_arrays[idx_arr:idx_arr+1].datasets.values())[0] - if self.ds is not current_ds: - with self.block_tree(): - self.expand_ds_item(self.ds_item) - self.expand_current_variable(self.data.name) - - def refresh(self, reset_combo: bool = True) -> None: - """Refresh the state of this widget. - - This method refreshes the widget based on the selected project, - variable, etc. - - Parameters - ---------- - reset_combo: bool - If True (default), the :meth:`reset_combo_array` is called - """ - self.clear_table() - - if reset_combo: - self.reset_combo_array() - - if self.sp: - variable = self.data.name - for action in self._save_preset_actions: - action.setEnabled(True) - self.btn_del.setEnabled(True) - self.btn_export.setEnabled(True) - else: - variable = self.variable - for action in self._save_preset_actions: - action.setEnabled(False) - self.btn_del.setEnabled(False) - self.btn_export.setEnabled(False) - - - # refresh variable buttons - with self.silence_variable_buttons(): - for v, btn in self.variable_buttons.items(): - btn.setChecked(v == variable) - - # refresh tabs - for i in range(self.plot_tabs.count()): - w = self.plot_tabs.widget(i) - w.refresh(self.ds) - if self.ds is not None and self.variable_buttons: - valid_variables = self.plotmethod_widget.valid_variables(self.ds) - for v, btn in self.variable_buttons.items(): - btn.setEnabled(v in valid_variables) - elif self.ds is None or variable == NOTSET or not self.sp: - return - - table = self.dimension_table - - if self.sp: - data = self.data - ds_data = self.ds[self.variable] - - with self.silence_variable_buttons(): - self.variable_buttons[self.variable].setChecked(True) - - dims: Tuple[Hashable, ...] = ds_data.dims # type: ignore - table.setRowCount(ds_data.ndim) - table.setVerticalHeaderLabels(ds_data.dims) - - # set time, z, x, y info - for c in 'XYTZ': - cname = ds_data.psy.get_dim(c) - if cname and cname in dims: - table.setItem( - dims.index(cname), 0, QtWidgets.QTableWidgetItem(c)) - - for i, dim in enumerate(dims): - coord = self.ds[dim] - if 'units' in coord.attrs: - table.setItem( - i, 4, QtWidgets.QTableWidgetItem( - str(coord.attrs['units']))) - try: - coord = list(map("{:1.4f}".format, coord.values)) # type: ignore - except (ValueError, TypeError): - try: - coord = coord.to_pandas().dt.to_pydatetime() # type: ignore - except AttributeError: - coord = list(map(str, coord.values)) # type: ignore - else: - coord = [t.isoformat() for t in coord] # type: ignore - first = coord[0] - last = coord[-1] - table.setItem( - i, 1, QtWidgets.QTableWidgetItem(first)) - table.setItem( - i, 3, QtWidgets.QTableWidgetItem(last)) - - current = data.psy.idims.get(dim) - if current is not None and isinstance(current, int): - table.setCellWidget( - i, 2, self.new_dimension_button(dim, coord[current])) - - # update animation checkbox - dims_to_animate = get_dims_to_iterate(data) - - current_dims_to_animate = list(map( - self.combo_dims.itemText, - range(self.combo_dims.count()))) - if dims_to_animate != current_dims_to_animate: - self.combo_dims.clear() - self.combo_dims.addItems(dims_to_animate) - - table.resizeColumnsToContents() - - # update plots items - for ds_item in self.ds_items: - for item in map(ds_item.child, range(ds_item.childCount())): - for child in map(item.child, range(item.childCount())): - if DatasetTree.is_variable(child): - plots_item = ds_item.get_plots_item(child) - ds_item.refresh_plots_item( - plots_item, child.text(0), self._sp, self.sp) - - def new_dimension_button( - self, dim: Hashable, label: Any) -> utils.QRightPushButton: - """Generate a new button to increase of decrease a dimension.""" - btn = utils.QRightPushButton(label) - btn.clicked.connect(self.increase_dim(str(dim))) - btn.rightclicked.connect(self.increase_dim(str(dim), -1)) - btn.setToolTip(f"Increase dimension {dim} with left-click, and " - "decrease with right-click.") - return btn - - def update_project(self, *args, **kwargs) -> None: - """Update the correct project :attr:`sp` and refresh the widget.""" - sp = self.sp - if sp is not None: - sp.update(*args, **kwargs) - self.refresh() - - def increase_dim(self, dim: str, increase: int = 1) -> Callable[[], None]: - """Get a function to update a specific dimension. - - Parameters - ---------- - dim: str - The dimension name - increase: int - The number of steps to increase (or decrease) the given `dim`. - """ - def update(): - i = self.data.psy.idims[dim] - self.data.psy.update(dims={dim: (i+increase) % self.ds.dims[dim]}) - if self.data.psy.plotter is None: - self.sp.update(replot=True) - self.refresh() - return update - - -class DatasetWidgetStandAlone(DatasetWidget): - """A :class:`DatasetWidget` that is supposed to work as a standalone GUI""" - - def closeEvent(self, event: Any): - """Reimplemented close event to stop the running ``QApplication``.""" - ret = super().closeEvent(event) - QtWidgets.QApplication.instance().quit() - return ret - - -class DatasetWidgetPlugin(DatasetWidget, DockMixin): - """A :class:`DatasetWidget` plugin for the psyplot GUI. - - This widget can be embeded in the psyplot GUI. Different from the standalone - :class:`DatasetWidget` class, this one here uses the current psyplot project - (:func:`psyplot.project.gcp`) - """ - - #: The title of the widget - title = 'psy-view Dataset viewer' - - #: Display the dock widget at the right side of the GUI - dock_position = Qt.RightDockWidgetArea - - def __init__(self, *args, **kwargs): - import psyplot.project as psy - super().__init__(*args, **kwargs) - psy.Project.oncpchange.connect(self.oncpchange) - - @property # type: ignore - def _sp(self) -> Project: # type: ignore - import psyplot.project as psy - return psy.gcp(True) - - @_sp.setter - def _sp(self, value): - pass - - @property - def sp(self) -> Optional[Project]: - """Get the psyplot project of the current plotmethod.""" - return self.plotmethod_widget.sp or None - - @sp.setter - def sp(self, sp: Optional[Project]): - current = self.get_sp() - if sp is None or not current: - return - elif getattr(current, self.plotmethod, []): - - if len(current) == 1 and len(sp) == 1: - pass - # first remove the current arrays - if current and getattr(current, self.plotmethod): - to_remove = getattr(self.get_sp(), self.plotmethod).arr_names - for i in list(reversed(range(len(current)))): - if current[i].psy.arr_name in to_remove: - current.pop(i) - # then add the new arrays - if sp: - if current: - current.extend(list(sp), new_name=True) - else: - current = sp - current.oncpchange.emit(current) - - @property - def open_datasets(self) -> Dict[int, Dataset]: - """Get a mapping from path to dataset number of the open datasets.""" - ret = self._sp.datasets - ret.update(self._ds_nums) - return ret - - def close_sp(self) -> None: - ds = self.ds - super().close_sp() - if ds is not None: - if ds.psy.num not in self._sp.datasets: - self.set_dataset(ds) - - def reload(self) -> None: - """Close the plot and recreate it.""" - import psyplot.project as psy - - if not all(self._sp.dsnames_map.values()): - # we have datasets that only exist in memory, so better ask - answer = QtWidgets.QMessageBox.question( - self, "Shall I close this?", - "Reloading the data closes all open plots. Any data in the memory " - "is lost and open files are reloaded from disk! " - "Shall I really continue?") - if answer != QtWidgets.QMessageBox.Yes: - return - - sp = self._sp - fname = sp.dsnames_map[self.ds.psy.num] # type: ignore - project = sp.save_project() - sp.close(True, True, True) - self.ds_tree.clear() - self._ds_nums.clear() - self.refresh() - self._sp = sp = psy.Project.load_project(project) - num = next(num for num, f in sp.dsnames_map.items() if f == fname) - self.ds = self.open_datasets[num] - sp.show() - self.refresh() - - def oncpchange(self, sp: Optional[Project]) -> None: - """Update this widget from the current psyplot main (or sub) project.""" - self.reset_combo_array() - if self.ds is not None and self.ds.psy.num not in self._sp.datasets: - self.ds = None - self.disable_navigation() - self.setup_variable_buttons() - self.btn_add.setEnabled(False) - self.btn_del.setEnabled(False) - elif self.ds is None and self._sp: - self.set_dataset(next(iter(self._sp.datasets.values()))) - elif self.ds is not None and self._sp: - self.enable_navigation() - - def show_fig(self, sp: Optional[Project]) -> None: - """Show the figure of the the current subproject.""" - from psyplot_gui.main import mainwindow - super().show_fig(sp) - if mainwindow.figures and sp: - try: - dock = sp.plotters[0].ax.figure.canvas.manager.window - dock.widget().show_plugin() - dock.raise_() - except AttributeError: - pass - - def setup_ds_tree(self) -> None: - """Setup the number of columns and the header of the dataset tree. - - Reimplemented to use the :class:`psyplot_gui.content_widget.DatasetTree` - """ - self.ds_tree = tree = DatasetTree() - tree.setColumnCount(len(self.ds_attr_columns) + 1) - tree.setHeaderLabels([''] + self.ds_attr_columns) - - def position_dock(self, main: MainWindow, *args, **kwargs) -> None: - height = main.help_explorer.dock.size().height() - main.splitDockWidget(main.help_explorer.dock, self.dock, Qt.Vertical) - if hasattr(main, 'resizeDocks'): # qt >= 5.6 - main.resizeDocks([main.help_explorer.dock, self.dock], - [height // 2, height // 2], Qt.Vertical) diff --git a/psy_view/icons/color_settings.png b/psy_view/icons/color_settings.png deleted file mode 100644 index b986fca..0000000 Binary files a/psy_view/icons/color_settings.png and /dev/null differ diff --git a/psy_view/icons/proj_settings.png b/psy_view/icons/proj_settings.png deleted file mode 100644 index ef5af74..0000000 Binary files a/psy_view/icons/proj_settings.png and /dev/null differ diff --git a/psy_view/plotmethods.py b/psy_view/plotmethods.py deleted file mode 100644 index fa8dd53..0000000 --- a/psy_view/plotmethods.py +++ /dev/null @@ -1,1387 +0,0 @@ -"""Plotmethod widgets. - -This module defines the widgets to interface with the mapplot, plot2d and -lineplot plotmethods - -**Disclaimer** - -Copyright (C) 2020 Philipp S. Sommer - -This program is free software: you can redistribute it and/or modify -it under the terms of the GNU General Public License as published by -the Free Software Foundation, either version 3 of the License, or -(at your option) any later version. - -This program is distributed in the hope that it will be useful, -but WITHOUT ANY WARRANTY; without even the implied warranty of -MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -GNU General Public License for more details. - -You should have received a copy of the GNU General Public License -along with this program.If not, see https: // www.gnu.org / licenses / . """ -from __future__ import annotations -import os.path as osp - -from typing import ( - TYPE_CHECKING, - ClassVar, - Callable, - Optional, - Union, - List, - Hashable, - Dict, - Any, - Tuple, - Iterator, - TypeVar, - Type, -) -from enum import Enum - -from functools import partial -from itertools import chain, cycle -import contextlib -import textwrap - -import dataclasses - -import xarray as xr -from psyplot.utils import unique_everseen - -from PyQt5 import QtWidgets, QtCore, QtGui -import psy_view.dialogs as dialogs -import psy_view.utils as utils -from psy_view.rcsetup import rcParams - -from psyplot_gui.common import get_icon as get_psy_icon -import psy_simple.widgets.colors as pswc -import matplotlib.colors as mcol - -if TYPE_CHECKING: - from xarray import DataArray, Dataset, Variable - from psyplot.project import PlotterInterface, Project - from psyplot.data import InteractiveList - from psyplot.plotter import Plotter - - -T = TypeVar("T", bound="GridCell") - - -class PlotType(str, Enum): - """A value for the 2D ``plot`` formatoption. - - See Also - -------- - psy_simple.plotters.Simple2DPlotter.plot - psy_maps.plotters.FieldPlotter.plot - """ - - mesh = "mesh" - contourf = "contourf" - contour = "contour" - poly = "poly" - - -#: A mapping from projection identifier to the text we want to use in the GUI -projection_map = { - "cf": "Default", - "cyl": "Cylindric", - "robin": "Robinson", - "ortho": "Orthographic", - "moll": "Mollweide", - "northpole": "Arctic (Northpole)", - "southpole": "Antarctic (Southpole)", -} - - -@dataclasses.dataclass -class GridCell: - """A grid cell within a QGridLayout managing one QWidget.""" - - #: the :class:`PyQt5.QtWidgets.QWidget` instance (i.e. the widget) or a - #: layout (:class:`PyQt5.QtWidgets.QLayout`) - qobject: Union[QtWidgets.QWidget, QtWidgets.QLayout] - - #: The starting column for the widget. If None, it will be estimated based - #: on the other widgets in the row - column: Optional[int] = None - - #: The number of columns to cover - colspan: int = 1 - - #: A boolean whether to add stretch or not - stretch: bool = False - - @classmethod - def from_alias( - cls: Type[T], - o: Union[QtWidgets.QWidget, QtWidgets.QLayout], - c: Optional[int] = None, - cs: int = 1, - s: bool = False - ) -> T: - """Create a :class:`GridCell` from shorter kws. - - Parameters - ---------- - o: QWidget or QLayout - The alias for :attr:`qobject` - c: int or None, optional - The alias for :attr:`column` - cs: int, optional - The alias for :attr:`colspan` - s: bool, optional - The alias for :attr:`stretch` - - Returns - ------- - GridCell - The generated instance of :class:`GridCell` - """ - return cls(qobject=o, column=c, colspan=cs, stretch=s) - - -class PlotMethodWidget(QtWidgets.QWidget): - """Base class for interfacing a psyplot plotmethod. - - This method serves as a base class for interfacing any of the psyplot - plot methods registered via :func:`psyplot.project.register_plotter`. - - The name of the plotmethod should be implemented as the :attr:`plotmethod` - attribute. - """ - - plotmethod: ClassVar[str] = '' - - #: trigger a replot of this widget. This can be emitted with the - #: :meth:`trigger_replot` method - replot = QtCore.pyqtSignal(str) - - #: trigger a replot of this widget. This can be emitted with the - #: :meth:`trigger_reset` method - reset = QtCore.pyqtSignal(str) - - #: signalize that the widget has been changed but not plot changes are - #: needed - changed = QtCore.pyqtSignal(str) - - array_info = None - - layout: QtWidgets.QGridLayout = None - - def __init__( - self, get_sp: Callable[[], Optional[Project]], - ds: Optional[Dataset]): - super().__init__() - self._get_sp = get_sp - - self.setup() - - if hasattr(self, "layout"): - self.setLayout(self.layout) - - self.refresh(ds) - - def setup(self) -> None: - """Set up the widget during initialization.""" - self.layout = QtWidgets.QGridLayout() - self.setup_widgets() - self.setup_widget_grid() - - @property - def formatoption_rows(self) -> List[List[GridCell]]: - """Get a mapping from row name to a row of :class:`GridCells`.""" - rows: List[List[GridCell]] = [] - for func in self.fmt_setup_functions: - rows.extend(self.get_rows(func)) - return rows - - - def get_rows(self, func: Callable) -> List[List[GridCell]]: - """Get the rows of the formatoption widgets. - - This method should take callable from the :attr:`fmt_setup_functions` - list and return the rows corresponding to :attr:`formatoption_rows`. - """ - return [[]] - - @property - def fmt_setup_functions(self) -> List[Callable]: - """Get a list of rows for formatoptions. - - This property returns a list of callable. Each callable should setup - a horizonal (or widget) that is added to the :attr:`layout` vbox. - """ - return [] - - def setup_widgets(self) -> None: - """Set up the widgets for this plotmethod.""" - for func in self.fmt_setup_functions: - func() - - def setup_separation_line(self) -> None: - """Just a convenience function to create a separation line. - - This method does nothing but tells :meth:`get_rows` to add an instance - of :class:`QHline`. - """ - pass - - def setup_widget_grid(self) -> None: - """Setup the widget grid based on :attr:`formatoption_rows`.""" - rows = self.formatoption_rows - layout = self.layout - for i, row in enumerate(rows): - col: int = 0 - for gc in row: - col = gc.column if gc.column is not None else col - if isinstance(gc.qobject, QtWidgets.QLayout): - layout.addLayout(gc.qobject, i, col, 1, gc.colspan) - else: - layout.addWidget(gc.qobject, i, col, 1, gc.colspan) - col += gc.colspan - layout.setRowStretch(len(rows), 1) - @property - def sp(self) -> Optional[Project]: - """Get the subproject of this plotmethod interface.""" - return getattr(self._get_sp(), self.plotmethod, None) - - @property - def data(self) -> Union[DataArray, InteractiveList]: - """Get the data of this plotmethod interface.""" - if self.sp is None: - raise ValueError("No plot has yet been initialized") - else: - return self.sp[0] - - @property - def plotter(self) -> Optional[Plotter]: - """Get the first plotter of the :attr:`sp` project.""" - if self.sp and self.sp.plotters: - return self.sp.plotters[0] - else: - return None - - @property - def formatoptions(self) -> List[str]: - """Get the formatoption keys of this plotmethod.""" - if self.plotter is not None: - return list(self.plotter) - else: - import psyplot.project as psy - return list(getattr(psy.plot, self.plotmethod).plotter_cls()) - - def get_fmts( - self, var: DataArray, init: bool = False - ) -> Dict[Union[Hashable, str, Any], Any]: - """Get the formatoptions for a new plot. - - Parameters - ---------- - var: xarray.Variable - The variable in the base dataset - init: bool - If True, call the :meth:`init_dims` method to inject necessary - formatoptions and dimensions for the initialization. - - Returns - ------- - dict - A mapping from formatoption or dimension to the corresponding value - for the plotmethod. - """ - ret = {} - if init: - ret.update(self.init_dims(var)) - return ret - - def init_dims( - self, var: DataArray - ) -> Dict[Union[Hashable, str, Any], Any]: - """Get the formatoptions for a new plot. - - Parameters - ---------- - var: xarray.Variable - The variable in the base dataset - - Returns - ------- - dict - A mapping from formatoption or dimension to the corresponding value - for the plotmethod. - - """ - return {} - - def refresh(self, ds: Optional[Dataset]) -> None: - """Refresh this widget from the given dataset.""" - self.setEnabled(bool(self.sp)) - - def trigger_replot(self) -> None: - """Emit the :attr:`replot` signal to replot the project.""" - self.replot.emit(self.plotmethod) - - def trigger_reset(self): - """Emit the :attr:`reset` signal to reinitialize the project.""" - self.array_info = self.sp.array_info( - standardize_dims=False)[self.sp[0].psy.arr_name] - self.reset.emit(self.plotmethod) - - def trigger_refresh(self): - """Emit the :attr:`changed` signal to notify changes in the plot.""" - self.changed.emit(self.plotmethod) - - def get_slice( - self, x: float, y: float - ) -> Optional[Dict[Hashable, Union[int, slice]]]: - """Get the slice for the selected coordinates. - - This method is called when the user clicks on the coordinates in the - plot. - - See Also - -------- - psy_view.ds_widget.DatasetWidget.display_line - - Notes - ----- - This is reimplemented in the :class:`MapPlotWidget`. - """ - return None - - def valid_variables(self, ds: Dataset) -> List[Hashable]: - """Get a list of variables that can be visualized with this plotmethod. - - Parameters - ---------- - ds: xarray.Dataset - The dataset to use - - Returns - ------- - list of str - List of variable names to plot - """ - ret = [] - plotmethod = getattr(ds.psy.plot, self.plotmethod) - for v in list(ds): - init_kws = self.init_dims(ds[v]) # type: ignore - dims = init_kws.get('dims', {}) - decoder = init_kws.get('decoder') - if plotmethod.check_data(ds, v, dims, decoder)[0][0]: - ret.append(v) - return ret - - -class QHLine(QtWidgets.QFrame): - """A horizontal seperation line.""" - def __init__(self): - super().__init__() - self.setMinimumWidth(1) - self.setFixedHeight(20) - self.setFrameShape(QtWidgets.QFrame.HLine) - self.setFrameShadow(QtWidgets.QFrame.Sunken) - self.setSizePolicy( - QtWidgets.QSizePolicy.Preferred, - QtWidgets.QSizePolicy.Minimum - ) - - -class MapPlotWidget(PlotMethodWidget): - """A widget to control the mapplot plotmethod.""" - - plotmethod = 'mapplot' - - def get_rows(self, func: Callable) -> List[List[GridCell]]: - """Get the rows of the formatoption widgets. - - This method should take callable from the :attr:`fmt_setup_functions` - list and return the rows corresponding to :attr:`formatoption_rows`. - """ - if func == self.setup_color_buttons: - row = [ - GridCell(QtWidgets.QLabel("Colormap")), - GridCell(self.btn_cmap), - GridCell(self.btn_cmap_settings, stretch=True), - ] - elif func == self.setup_plot_buttons: - row = [ - GridCell(QtWidgets.QLabel("Plot type")), - GridCell(self.combo_plot), - GridCell(self.btn_datagrid, stretch=True), - ] - elif func == self.setup_projection_buttons: - row = [ - GridCell(QtWidgets.QLabel("Projection")), - GridCell(self.btn_proj), - GridCell(self.btn_proj_settings, stretch=True), - ] - elif func == self.setup_labels_button: - row = [GridCell(self.btn_labels, colspan=3)] - elif func == self.setup_separation_line: - row = [GridCell(QHLine(), colspan=3)] - elif func == self.setup_dimension_box: - row = [GridCell(self.dimension_box, colspan=3)] - else: - raise ValueError(f"Unknown function {func}") - return [row] - - @property - def fmt_setup_functions(self) -> List[Callable]: - """Get a list of rows for formatoptions. - - This property returns a list of callable. Each callable should setup - a horizonal (or widget) that is added to the :attr:`layout` vbox. - """ - return [ - self.setup_color_buttons, self.setup_plot_buttons, - self.setup_projection_buttons, self.setup_labels_button, - self.setup_separation_line, - self.setup_dimension_box, - ] - - def setup_labels_button(self) -> None: - """Add a button to modify the text labels.""" - self.btn_labels = utils.add_pushbutton( - "Edit labels", self.edit_labels, "Edit title, colorbar labels, etc." - ) - - def setup_plot_buttons(self) -> None: - """Setup the second row of formatoption widgets.""" - self.combo_plot = QtWidgets.QComboBox() - self.plot_types: List[Optional[PlotType]] = [ - PlotType.mesh, - PlotType.contourf, - PlotType.contour, - PlotType.poly, - None - ] - self.combo_plot.setEditable(False) - self.combo_plot.addItems([ - "Default", "Filled contours", "Contours", "Gridcell polygons", - "Disable" - ]) - self.combo_plot.currentIndexChanged.connect(self._set_plot_type) - - self.btn_datagrid = utils.add_pushbutton( - "Gridcell boundaries", self.toggle_datagrid, - "Toggle the visibility of grid cell boundaries") - self.btn_datagrid.setCheckable(True) - - return - - def setup_color_buttons(self) -> None: - """Set up the buttons to change the colormap, etc.""" - self.btn_cmap = pswc.CmapButton() - self.btn_cmap.setSizePolicy( - QtWidgets.QSizePolicy.Expanding, QtWidgets.QSizePolicy.Expanding - ) - self.btn_cmap.setToolTip("Select a different colormap") - - self.btn_cmap.colormap_changed.connect(self.set_cmap) - self.btn_cmap.colormap_changed[mcol.Colormap].connect(self.set_cmap) - self.setup_cmap_menu() - - self.btn_cmap_settings = utils.add_pushbutton( - utils.get_icon('color_settings'), self.edit_color_settings, - "Edit color settings", - icon=True) - - def setup_cmap_menu(self) -> QtWidgets.QMenu: - """Set up the menu to change the colormaps.""" - menu = self.btn_cmap.cmap_menu - - menu.addSeparator() - self.select_cmap_action = menu.addAction( - 'More colormaps', self.open_cmap_dialog) - - self.color_settings_action = menu.addAction( - QtGui.QIcon(utils.get_icon('color_settings')), 'More options', - self.edit_color_settings) - - return menu - - def open_cmap_dialog(self, N: int = 10) -> None: - """Open the dialog to change the colormap. - - Parameters - ---------- - N: int - The number of colormaps to show - - See Also - -------- - psy_simple.widgets.colors.CmapButton - """ - if self.plotter: - N = self.plotter.plot.mappable.get_cmap().N - else: - N = 10 - self.btn_cmap.open_cmap_dialog(N) - - def setup_projection_menu(self) -> QtWidgets.QMenu: - """Set up the menu to modify the basemap.""" - menu = QtWidgets.QMenu() - for projection in rcParams['projections']: - menu.addAction( - projection_map.get(projection, projection), - partial(self.set_projection, projection), - ) - menu.addSeparator() - self.proj_settings_action = menu.addAction( - QtGui.QIcon(utils.get_icon('proj_settings')), - "Customize basemap...", self.edit_basemap_settings) - return menu - - def get_projection_label(self, proj: str) -> str: - """Get the label for a projection in the GUI. - - Parameters - ---------- - proj: str - The projection value for the - :attr:`~psy_maps.plotters.FieldPlotter.plot` formatoption - - Returns - ------- - str - The label of the projection in the GUI - - See Also - -------- - get_projection_label - projection_map - psy_maps.plotters.FieldPlotter.plot - """ - return projection_map.get(proj, proj) - - def get_projection_value(self, label: str) -> str: - """Get the value for the `projection` formatoption. - - This method is the inverse of :meth:`get_projection_label`. - - Parameters - ---------- - label: str - The projection label that is used in the GUI - :attr:`~psy_maps.plotters.FieldPlotter.plot` formatoption - - Returns - ------- - str - The value to use for the ``projection`` formatoption - - See Also - -------- - get_projection_label - projection_map - psy_maps.plotters.FieldPlotter.plot - """ - inv_map = {lbl: proj for proj, lbl in projection_map.items()} - return inv_map.get(label, rcParams["projections"][0]) - - def setup_projection_buttons(self) -> None: - """Set up the buttons to modify the basemap.""" - self.btn_proj = utils.add_pushbutton( - self.get_projection_label(rcParams["projections"][0]), - self.choose_next_projection, "Change the basemap projection", - toolbutton=True) - self.btn_proj.setMenu(self.setup_projection_menu()) - - self.btn_proj.setSizePolicy( - QtWidgets.QSizePolicy.Expanding, QtWidgets.QSizePolicy.Expanding - ) - self.btn_proj.setPopupMode(QtWidgets.QToolButton.MenuButtonPopup) - - self.btn_proj_settings = utils.add_pushbutton( - utils.get_icon('proj_settings'), self.edit_basemap_settings, - "Edit basemap settings", - icon=True) - - def setup_dimension_box(self) -> None: - """Set up a box to control, what is the x and y-dimension.""" - self.dimension_box = QtWidgets.QGridLayout() - - self.dimension_box.addWidget(QtWidgets.QLabel('x-Dimension:'), 0, 0) - self.combo_xdim = QtWidgets.QComboBox() - self.dimension_box.addWidget(self.combo_xdim, 0, 1) - - self.dimension_box.addWidget(QtWidgets.QLabel('y-Dimension:'), 0, 2) - self.combo_ydim = QtWidgets.QComboBox() - self.dimension_box.addWidget(self.combo_ydim, 0, 3) - - self.dimension_box.addWidget(QtWidgets.QLabel('x-Coordinate:'), 1, 0) - self.combo_xcoord = QtWidgets.QComboBox() - self.dimension_box.addWidget(self.combo_xcoord, 1, 1) - - self.dimension_box.addWidget(QtWidgets.QLabel('y-Coordinate:'), 1, 2) - self.combo_ycoord = QtWidgets.QComboBox() - self.dimension_box.addWidget(self.combo_ycoord, 1, 3) - - self.combo_xdim.currentTextChanged.connect(self.set_xcoord) - self.combo_ydim.currentTextChanged.connect(self.set_ycoord) - - for combo in self.coord_combos: - combo.currentIndexChanged.connect(self.trigger_refresh) - - def set_xcoord(self, text: str) -> None: - """Set the name of the x-coordinate.""" - self.set_combo_text(self.combo_xcoord, text) - - def set_ycoord(self, text: str) -> None: - """Set the name of the y-coordinate.""" - self.set_combo_text(self.combo_ycoord, text) - - def set_combo_text(self, combo: QtWidgets.QComboBox, text: str) -> None: - """Convenience function to update set the current text of a combobox. - - Parameters - ---------- - combo: PyQt5.QtWidgets.QComboBox - The combobox to modify - text: str - The item to use""" - items = list(map(combo.itemText, range(combo.count()))) - if text in items: - combo.setCurrentIndex(items.index(text)) - - def init_dims( - self, var: DataArray - ) -> Dict[Union[Hashable, str, Any], Any]: - """Get the formatoptions for a new plot. - - This method updates the coordinates combo boxes with the - x- and y-coordinate of the variable. - - Parameters - ---------- - var: xarray.Variable - The variable in the base dataset - - Returns - ------- - dict - A mapping from formatoption or dimension to the corresponding value - for the plotmethod. - """ - ret = super().init_dims(var) - - dims: Dict[Hashable, Union[int, slice]] = {} - xdim = ydim = None - - if self.combo_xdim.currentIndex(): - xdim = self.combo_xdim.currentText() - if xdim in var.dims: - dims[xdim] = slice(None) - - if self.combo_ydim.currentIndex(): - ydim = self.combo_ydim.currentText() - if ydim in var.dims: - dims[ydim] = slice(None) - - if dims: - missing = [dim for dim in var.dims if dim not in dims] - for dim in missing: - dims[dim] = 0 - if len(dims) == 1 and xdim != ydim: - if xdim is None: - xdim = missing[-1] - else: - ydim = missing[-1] - dims[missing[-1]] = slice(None) # keep the last dimension - ret['dims'] = dims - - - if self.combo_xcoord.currentIndex(): - xcoord = self.combo_xcoord.currentText() - ret['decoder'] = {'x': {xcoord}} - if self.combo_ycoord.currentIndex(): - ycoord = self.combo_ycoord.currentText() - ret.setdefault('decoder', {}) - ret['decoder']['y'] = {ycoord} - - if (xdim is not None and xdim in var.dims and - ydim is not None and ydim in var.dims): - ret['transpose'] = var.dims.index(xdim) < var.dims.index(ydim) - - return ret - - def valid_variables(self, ds: Dataset) -> List[Hashable]: - """Get a list of variables that can be visualized with this plotmethod. - - Parameters - ---------- - ds: xarray.Dataset - The dataset to use - - Returns - ------- - list of str - List of variable names to plot - """ - valid = super().valid_variables(ds) - if (not any(combo.count() for combo in self.coord_combos) or - not any(combo.currentIndex() for combo in self.coord_combos)): - return valid - if self.combo_xdim.currentIndex(): - xdim = self.combo_xdim.currentText() - valid = [v for v in valid if xdim in ds[v].dims] - if self.combo_ydim.currentIndex(): - ydim = self.combo_xdim.currentText() - valid = [v for v in valid if ydim in ds[v].dims] - if self.combo_xcoord.currentIndex(): - xc_dims = set(ds[self.combo_xcoord.currentText()].dims) - valid = [v for v in valid - if xc_dims.intersection(ds[v].dims)] - if self.combo_ycoord.currentIndex(): - yc_dims = set(ds[self.combo_ycoord.currentText()].dims) - valid = [v for v in valid - if yc_dims.intersection(ds[v].dims)] - return valid - - @property - def coord_combos(self) -> List[QtWidgets.QComboBox]: - """Get the combo boxes for x- and y-dimension and -coordinates.""" - return [self.combo_xdim, self.combo_ydim, self.combo_xcoord, - self.combo_ycoord] - - @contextlib.contextmanager - def block_combos(self) -> Iterator[None]: - """Temporarilly block any signal of the :attr:`coord_combos`.""" - for combo in self.coord_combos: - combo.blockSignals(True) - yield - for combo in self.coord_combos: - combo.blockSignals(False) - - def setEnabled(self, b: bool) -> None: - """Enable or disable the projection and color buttons. - - Parameters - ---------- - b: bool - If True, enable the buttons, else disable. - """ - self.btn_proj_settings.setEnabled(b) - self.proj_settings_action.setEnabled(b) - self.btn_datagrid.setEnabled(b) - self.color_settings_action.setEnabled(b) - self.btn_cmap_settings.setEnabled(b) - self.btn_labels.setEnabled(b) - - def set_cmap(self, cmap: str) -> None: - """Update the plotter with the given colormap. - - Parameters - ---------- - cmap: str - The colormap name. - """ - plotter = self.plotter - if plotter and 'cmap' in plotter: - plotter.update(cmap=cmap) - - def toggle_datagrid(self) -> None: - """Toggle the visibility of the grid cell boundaries.""" - if self.plotter: - if self.btn_datagrid.isChecked(): - self.plotter.update(datagrid='k-') - else: - self.plotter.update(datagrid=None) - - def edit_labels(self) -> None: - """Open the dialog to edit the text labels in the plot.""" - dialogs.LabelDialog.update_project( - self.sp, 'figtitle', 'title', 'clabel') - - def edit_color_settings(self) -> None: - """Open the dialog to edit the color settings.""" - if self.sp and self.plotter: - dialogs.CmapDialog.update_project(self.sp) - if isinstance(self.plotter.cmap.value, str): - self.btn_cmap.setText(self.plotter.cmap.value) - else: - self.btn_cmap.setText('Custom') - - def choose_next_projection(self) -> None: - """Choose the next projection from the rcParams `projection` value.""" - select = False - nprojections = len(rcParams['projections']) - current = self.get_projection_value(self.btn_proj.text()) - - for i, proj in enumerate(cycle(rcParams['projections'])): - if proj == current: - select = True - elif select or i == nprojections: - break - self.set_projection(proj) - - def set_projection(self, proj: str) -> None: - """Update the projection of the plot with the given projection. - - Parameters - ---------- - projection: str - The projection name for the - :attr:`~psy_maps.plotters.FieldPlotter.projection` formatoption. - """ - self.btn_proj.setText(self.get_projection_label(proj)) - plotter = self.plotter - if plotter and 'projection' in plotter: - plotter.update(projection=proj) - - def _set_plot_type(self, i: int) -> None: - """Set the plot type from the index in :attr:`combo_plot`.""" - self.set_plot_type(self.plot_types[i]) - - def set_plot_type(self, plot_type: Optional[PlotType]) -> None: - """Update the value for the ``plot`` formatoption - - Parameters - ---------- - ploy_type: :class:`PlotType` or None - The value for the :attr:`~psy_simple.plotters.Simple2DPlotter.plot` - formatoption. - """ - plotter = self.plotter - if plotter: - plotter.update(plot=plot_type) - - def edit_basemap_settings(self) -> None: - """Open a dialog to edit the basemap and projection settings.""" - if self.plotter: - dialogs.BasemapDialog.update_plotter(self.plotter) - - def get_fmts( - self, var: DataArray, - init: bool = False - ) -> Dict[Union[Hashable, str, Any], Any]: - """Get the formatoptions for a new plot. - - Parameters - ---------- - var: xarray.Variable - The variable in the base dataset - init: bool - If True, call the :meth:`init_dims` method to inject necessary - formatoptions and dimensions for the initialization. - - Returns - ------- - dict - A mapping from formatoption or dimension to the corresponding value - for the plotmethod. - """ - fmts: Dict[Union[Hashable, str, Any], Any] = {} - - fmts['cmap'] = self.btn_cmap.text() - - if 'projection' in self.formatoptions: - fmts['projection'] = self.get_projection_value( - self.btn_proj.text() - ) - - if 'time' in var.dims: - fmts['title'] = '%(time)s' - - if 'long_name' in var.attrs: - fmts['clabel'] = '%(long_name)s' - else: - fmts['clabel'] = '%(name)s' - if 'units' in var.attrs: - fmts['clabel'] += ' %(units)s' - - fmts['plot'] = self.plot_types[self.combo_plot.currentIndex()] - if fmts['plot'] == 'contour': - # we need to set a global map extend, see - # https://github.com/SciTools/cartopy/issues/1673 - fmts['map_extent'] = 'global' - - if init: - fmts.update(self.init_dims(var)) - - return fmts - - def refresh(self, ds: Optional[Dataset]) -> None: - """Refresh this widget from the given dataset.""" - self.setEnabled(bool(self.sp)) - - auto = 'Set automatically' - - self.refresh_from_sp() - - with self.block_combos(): - - if ds is None: - ds = xr.Dataset() - - current_dims = set(map( - self.combo_xdim.itemText, range(1, self.combo_xdim.count()))) - ds_dims = list( - map(str, (dim for dim, n in ds.dims.items() if n > 1))) - if current_dims != set(ds_dims): - self.combo_xdim.clear() - self.combo_ydim.clear() - self.combo_xdim.addItems([auto] + ds_dims) - self.combo_ydim.addItems([auto] + ds_dims) - - current_coords = set(map( - self.combo_xcoord.itemText, range(1, self.combo_xcoord.count()))) - ds_coords = list( - map(str, (c for c, arr in ds.coords.items() if arr.ndim))) - if current_coords != set(ds_coords): - self.combo_xcoord.clear() - self.combo_ycoord.clear() - self.combo_xcoord.addItems([auto] + ds_coords) - self.combo_ycoord.addItems([auto] + ds_coords) - - enable_combos = not bool(self.sp) - - if not enable_combos and self.combo_xdim.isEnabled(): - self.reset_combos = [combo.currentIndex() == 0 - for combo in self.coord_combos] - elif enable_combos and not self.combo_xdim.isEnabled(): - for reset, combo in zip(self.reset_combos, self.coord_combos): - if reset: - combo.setCurrentIndex(0) - self.reset_combos = [False] * len(self.coord_combos) - - for combo in self.coord_combos: - combo.setEnabled(enable_combos) - - if not enable_combos: - data = self.data - xdim = str(data.psy.get_dim('x')) - ydim = str(data.psy.get_dim('y')) - self.combo_xdim.setCurrentText(xdim) - self.combo_ydim.setCurrentText(ydim) - xcoord = data.psy.get_coord('x') - xcoord = xcoord.name if xcoord is not None else xdim - ycoord = data.psy.get_coord('y') - ycoord = ycoord.name if ycoord is not None else ydim - - self.combo_xcoord.setCurrentText(xcoord) - self.combo_ycoord.setCurrentText(ycoord) - - def refresh_from_sp(self) -> None: - """Refresh this widget from the plotters project.""" - plotter = self.plotter - if plotter: - if isinstance(plotter.projection.value, str): - self.btn_proj.setText( - self.get_projection_label(plotter.projection.value) - ) - else: - self.btn_proj.setText('Custom') - if isinstance(plotter.cmap.value, str): - self.btn_cmap.setText(plotter.cmap.value) - else: - self.btn_cmap.setText('Custom') - - def transform(self, x: float, y: float) -> Tuple[float, float]: - """Transform coordinates of a point to the plots projection. - - Parameters - ---------- - x: float - The x-coordinate in axes coordinates - y: float - The y-coordinate in axes coordinates - - Returns - ------- - float - The transformed x-coordinate `x` - float - The transformed y-coordinate `y` - """ - import cartopy.crs as ccrs - import numpy as np - plotter = self.plotter - if not plotter: - raise ValueError( - "Cannot transform the coordinates as no plot is shown " - "currently!") - x, y = plotter.transform.projection.transform_point( - x, y, plotter.ax.projection) - # shift if necessary - if isinstance(plotter.transform.projection, ccrs.PlateCarree): - coord = plotter.plot.xcoord - if coord.min() >= 0 and x < 0: - x -= 360 - elif coord.max() <= 180 and x > 180: - x -= 360 - if 'rad' in coord.attrs.get('units', '').lower(): - x = np.deg2rad(x) - y = np.deg2rad(y) - return x, y - - def get_slice( - self, x: float, y: float - ) -> Optional[Dict[Hashable, Union[int, slice]]]: - """Get the slice for the selected coordinates. - - This method is called when the user clicks on the coordinates in the - plot. - - See Also - -------- - psy_view.ds_widget.DatasetWidget.display_line - - Notes - ----- - This is reimplemented in the :class:`MapPlotWidget`. - """ - import numpy as np - data = self.data.psy.base.psy[self.data.name] - x, y = self.transform(x, y) - plotter = self.plotter - - if not plotter: - raise ValueError( - "Cannot transform the coordinates as no plot is shown " - "currently!") - - fmto = plotter.plot - - xcoord = fmto.xcoord - ycoord = fmto.ycoord - if fmto.decoder.is_unstructured(fmto.raw_data) or xcoord.ndim == 2: - xy = xcoord.values.ravel() + 1j * ycoord.values.ravel() - dist = np.abs(xy - (x + 1j * y)) - imin = np.nanargmin(dist) - if xcoord.ndim == 2: - ncols = data.shape[-2] - return dict(zip(data.dims[-2:], - [imin // ncols, imin % ncols])) - else: - return {data.dims[-1]: imin} - else: - ix: int = xcoord.indexes[xcoord.name].get_loc(x, method='nearest') - iy: int = ycoord.indexes[ycoord.name].get_loc(y, method='nearest') - return dict(zip(data.dims[-2:], [iy, ix])) - - -class Plot2DWidget(MapPlotWidget): - """A widget to control the plot2d plotmethod.""" - - plotmethod = 'plot2d' - - @property - def fmt_setup_functions(self) -> List[Callable]: - """Get a list of rows for formatoptions. - - This property returns a list of callable. Each callable should setup - a horizonal (or widget) that is added to the :attr:`layout` vbox. - """ - ret = super().fmt_setup_functions - ret.remove(self.setup_projection_buttons) - return ret - - def setEnabled(self, b: bool) -> None: - """Enable or disable the datagrid and color buttons. - - Parameters - ---------- - b: bool - If True, enable the buttons, else disable. - """ - self.btn_datagrid.setEnabled(b) - self.btn_cmap_settings.setEnabled(b) - self.btn_labels.setEnabled(b) - - def edit_labels(self) -> None: - """Open the dialog to edit the text labels in the plot.""" - dialogs.LabelDialog.update_project( - self.sp, 'figtitle', 'title', 'clabel', 'xlabel', 'ylabel') - - def transform(self, x: float, y: float) -> Tuple[float, float]: - """Reimplemented to not transform the coordinates.""" - return x, y - - def refresh_from_sp(self) -> None: - """Refresh this widget from the plotters project.""" - plotter = self.plotter - if plotter: - if isinstance(plotter.cmap.value, str): - self.btn_cmap.setText(plotter.cmap.value) - - -class LinePlotWidget(PlotMethodWidget): - """A widget to control the lineplot plotmethod.""" - - plotmethod = 'lineplot' - - @property - def fmt_setup_functions(self) -> List[Callable]: - return [ - self.setup_dimension_combo, - self.setup_line_selection, - self.setup_labels_button, - ] - - def get_rows(self, func: Callable) -> List[List[GridCell]]: - """Get the rows of the formatoption widgets. - - This method should take callable from the :attr:`fmt_setup_functions` - list and return the rows corresponding to :attr:`formatoption_rows`. - """ - if func == self.setup_dimension_combo: - row = [ - GridCell(QtWidgets.QLabel('x-Dimension:')), - GridCell(self.combo_dims) - ] - elif func == self.setup_line_selection: - row = [ - GridCell(QtWidgets.QLabel('Active line:')), - GridCell(self.combo_lines), - GridCell(self.btn_add), - GridCell(self.btn_del) - ] - elif func == self.setup_labels_button: - row = [GridCell(self.btn_labels, colspan=4)] - else: - raise ValueError(f"Unknown function {func}") - return [row] - - def setup_dimension_combo(self) -> None: - """Set up the combobox for selecting the x-dimension.""" - self.combo_dims = QtWidgets.QComboBox() - self.combo_dims.setEditable(False) - self.combo_dims.currentIndexChanged.connect(self.trigger_reset) - self.combo_dims.setSizePolicy( - QtWidgets.QSizePolicy.Expanding, QtWidgets.QSizePolicy.Expanding - ) - - def setup_line_selection(self) -> None: - """Setup the row for selecting new lines.""" - self.combo_lines = QtWidgets.QComboBox() - self.combo_lines.setEditable(False) - - self.combo_lines.setSizePolicy( - QtWidgets.QSizePolicy.Expanding, QtWidgets.QSizePolicy.Expanding - ) - self.combo_lines.currentIndexChanged.connect(self.trigger_refresh) - - self.btn_add = utils.add_pushbutton( - QtGui.QIcon(get_psy_icon('plus')), lambda: self.add_line(), - "Add a line to the plot", icon=True) - self.btn_del = utils.add_pushbutton( - QtGui.QIcon(get_psy_icon('minus')), self.remove_line, - "Add a line to the plot", icon=True) - - def setup_labels_button(self) -> None: - """Add a button to modify the text labels.""" - self.btn_labels = utils.add_pushbutton( - "Edit labels", self.edit_labels, - "Edit title, x-label, legendlabels, etc.") - - @property - def xdim(self) -> str: - """Get the x-dimension for the plot.""" - return self.combo_dims.currentText() - - @xdim.setter - def xdim(self, xdim: Hashable) -> None: - if xdim != self.combo_dims.currentText(): - self.combo_dims.setCurrentText(str(xdim)) - - @property - def data(self) -> DataArray: - """The first array in the list.""" - data = super().data - if len(data) - 1 < self.combo_lines.currentIndex(): - return data[0] - else: - return data[self.combo_lines.currentIndex()] - - def add_line(self, name: Hashable = None, **sl) -> None: - """Add a line to the plot. - - This method adds a new line for the plot specified by the given - `name` of the variable and the slices. - - Parameters - ---------- - name: str - The variable name to display - ``**sl`` - The slices to turn the `name` variable into a 1D-array. - """ - if not self.sp: - raise ValueError("No plot has yet been initialized!") - ds = self.data.psy.base - xdim = self.xdim - if name is None: - name, ok = QtWidgets.QInputDialog.getItem( - self, 'New line', 'Select a variable', - [key for key, var in ds.items() - if xdim in var.dims]) - if not ok: - return - arr = ds.psy[name] - for key, val in self.data.psy.idims.items(): - if key in arr.dims: - sl.setdefault(key, val) - for dim in arr.dims: - if dim != xdim: - sl.setdefault(dim, 0) - self.sp[0].append(arr.psy[sl], new_name=True) - item = self.item_texts[-1] - self.sp.update(replot=True) - self.combo_lines.addItem(item) - self.combo_lines.setCurrentText(item) - self.trigger_refresh() - - def remove_line(self) -> None: - """Remove the current line from the plot.""" - if not self.sp: - raise ValueError( - "No plot has yet been initialized, so I cannot remove any line!" - ) - i = self.combo_lines.currentIndex() - self.sp[0].pop(i) - self.sp.update(replot=True) - self.combo_lines.setCurrentText(self.item_texts[i - 1 if i else 0]) - self.changed.emit(self.plotmethod) - - @property - def item_texts(self) -> List[str]: - """Get the labels for the individual lines.""" - if not self.sp: - return [] - return [f'Line {i}: {arr.psy._short_info()}' - for i, arr in enumerate(self.sp[0])] - - def init_dims( - self, var: DataArray - ) -> Dict[Union[Hashable, str, Any], Any]: - """Get the formatoptions for a new plot. - - Parameters - ---------- - var: xarray.Variable - The variable in the base dataset - - Returns - ------- - dict - A mapping from formatoption or dimension to the corresponding value - for the plotmethod. - - """ - ret: Dict[Union[Hashable, str, Any], Any] = {} - xdim: Union[None, Hashable, str] = self.xdim or next( - (d for d in var.dims if var[d].size > 1), None # type: ignore - ) - if self.array_info: - arr_names = {} - for arrname, d in self.array_info.items(): - if arrname != 'attrs': - dims = d['dims'].copy() - if xdim in dims: - for dim, sl in dims.items(): - if not isinstance(sl, int): - dims[dim] = 0 - dims[xdim] = slice(None) - dims['name'] = d['name'] - arr_names[arrname] = dims - ret['arr_names'] = arr_names - del self.array_info - else: - if xdim not in var.dims: - xdim = next((d for d in var.dims if var[d].size > 1), None) - if xdim is None: - raise ValueError( - f"Cannot plot variable {var.name} with size smaller than " - "2") - ret[xdim] = slice(None) - for d in var.dims: - if d != xdim: - ret[d] = 0 - return ret - - def edit_labels(self) -> None: - """Open the dialog to edit the text labels in the plot.""" - dialogs.LabelDialog.update_project( - self.sp, 'figtitle', 'title', 'xlabel', 'ylabel', 'legendlabels') - - @contextlib.contextmanager - def block_combos(self) -> Iterator[None]: - """Temporarilly block any signal of the combo boxes.""" - self.combo_dims.blockSignals(True) - self.combo_lines.blockSignals(True) - yield - self.combo_dims.blockSignals(False) - self.combo_lines.blockSignals(False) - - def valid_variables(self, ds: Dataset) -> List[Hashable]: - """Get a list of variables that can be visualized with this plotmethod. - - Parameters - ---------- - ds: xarray.Dataset - The dataset to use - - Returns - ------- - list of str - List of variable names to plot - """ - valid = list(ds) - if not self.sp or len(self.sp[0]) < 2: - return valid - else: - current_dim = self.combo_dims.currentText() - return [v for v in valid if current_dim in ds[v].dims] - - def setEnabled(self, b: bool) -> None: - """Enable or disable the datagrid and color buttons. - - Parameters - ---------- - b: bool - If True, enable the buttons, else disable. - """ - self.btn_add.setEnabled(b) - self.btn_del.setEnabled(b and self.sp and len(self.sp[0]) > 1) - self.btn_labels.setEnabled(b) - - def refresh(self, ds) -> None: - """Refresh this widget from the given dataset.""" - self.setEnabled(bool(self.sp)) - - if self.sp: - with self.block_combos(): - self.combo_dims.clear() - all_dims = list(chain.from_iterable( - [[d for i, d in enumerate(a.dims) if a.shape[i] > 1] - for a in arr.psy.iter_base_variables] - for arr in self.sp[0])) - intersection = set(all_dims[0]) - for dims in all_dims[1:]: - intersection.intersection_update(dims) - new_dims = list( - filter(lambda d: d in intersection, - unique_everseen(chain.from_iterable(all_dims)))) - - self.combo_dims.addItems(new_dims) - self.combo_dims.setCurrentIndex( - new_dims.index(self.data.dims[-1])) - - # fill lines combo - current = self.combo_lines.currentIndex() - self.combo_lines.clear() - descriptions = self.item_texts - short_descs = [textwrap.shorten(s, 50) for s in descriptions] - self.combo_lines.addItems(short_descs) - for i, desc in enumerate(descriptions): - self.combo_lines.setItemData(i, desc, QtCore.Qt.ToolTipRole) - if current < len(descriptions): - self.combo_lines.setCurrentText(short_descs[current]) - else: - with self.block_combos(): - self.combo_dims.clear() - self.combo_lines.clear() diff --git a/psy_view/rcsetup.py b/psy_view/rcsetup.py deleted file mode 100644 index 700ec59..0000000 --- a/psy_view/rcsetup.py +++ /dev/null @@ -1,77 +0,0 @@ -"""Configuration parameters for psy-view - -**Disclaimer** - -Copyright (C) 2020 Philipp S. Sommer - -This program is free software: you can redistribute it and/or modify -it under the terms of the GNU General Public License as published by -the Free Software Foundation, either version 3 of the License, or -(at your option) any later version. - -This program is distributed in the hope that it will be useful, -but WITHOUT ANY WARRANTY; without even the implied warranty of -MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -GNU General Public License for more details. - -You should have received a copy of the GNU General Public License -along with this program. If not, see https://www.gnu.org/licenses/. -""" -from __future__ import annotations -from typing import ( - Dict, - List, - Any, - Optional, -) - -from psyplot_gui.config.rcsetup import ( - RcParams, validate_stringlist, psyplot_fname) -from psyplot.config.rcsetup import validate_dict - - -defaultParams: Dict[str, List[Any]] = { - "projections": [ - ["cf", "cyl", "robin", "ortho", "moll", "northpole", "southpole"], - validate_stringlist, "The names of available projections"], - "savefig_kws": [ - dict(dpi=250), validate_dict, - "Options that are passed to plt.savefig when exporting images"], - "animations.export_kws": [ - dict(writer="ffmpeg"), validate_dict, - "Options that are passed to FuncAnimation.save"], - } - - -class PsyViewRcParams(RcParams): - """RcParams for the psyplot-gui package.""" - - HEADER: str = RcParams.HEADER.replace( - 'psyplotrc.yml', 'psyviewrc.yml').replace( - 'PSYVIEWRC', 'psyviewrc.yml') - - def load_from_file(self, fname: Optional[str] = None): - """ - Update rcParams from user-defined settings - - This function updates the instance with what is found in `fname` - - Parameters - ---------- - fname: str - Path to the yaml configuration file. Possible keys of the - dictionary are defined by :data:`config.rcsetup.defaultParams`. - If None, the :func:`config.rcsetup.psyplot_fname` function is used. - - See Also - -------- - dump_to_file, psyplot_fname""" - fname = fname or psyplot_fname(env_key='PSYVIEWRC', - fname='psyviewrc.yml') - if fname: - super().load_from_file(fname) - - -rcParams = PsyViewRcParams(defaultParams=defaultParams) -rcParams.update_from_defaultParams() -rcParams.load_from_file() diff --git a/psy_view/utils.py b/psy_view/utils.py deleted file mode 100644 index 3d6d8fe..0000000 --- a/psy_view/utils.py +++ /dev/null @@ -1,75 +0,0 @@ -"""Utility functions for psy-view. - -**Disclaimer** - -Copyright (C) 2020 Philipp S. Sommer - -This program is free software: you can redistribute it and/or modify -it under the terms of the GNU General Public License as published by -the Free Software Foundation, either version 3 of the License, or -(at your option) any later version. - -This program is distributed in the hope that it will be useful, -but WITHOUT ANY WARRANTY; without even the implied warranty of -MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -GNU General Public License for more details. - -You should have received a copy of the GNU General Public License -along with this program.If not, see https: // www.gnu.org / licenses / . -""" -from __future__ import annotations -import os.path as osp - -from typing import Callable, Optional, Union, List, cast, TYPE_CHECKING - -from PyQt5 import QtWidgets, QtCore, QtGui - -if TYPE_CHECKING: - from PyQt5.QtCore import QEvent # pylint: disable=no-name-in-module - - -def get_icon(name: str, ending: str = '.png') -> str: - return osp.join(osp.dirname(__file__), 'icons', name + ending) - - -def add_pushbutton( - label: str, - connections: Optional[Union[List[Callable], Callable]] = None, - tooltip: Optional[str] = None, - layout: Optional[QtWidgets.QLayout] = None, - icon: bool = False, toolbutton: bool = False, *args, **kwargs - ) -> Union[QtWidgets.QPushButton, QtWidgets.QToolButton]: - if icon or toolbutton: - btn = QtWidgets.QToolButton(*args, **kwargs) - if icon: - btn.setIcon(QtGui.QIcon(label)) - else: - btn.setText(label) - else: - btn = QtWidgets.QPushButton(label, *args, **kwargs) - if tooltip is not None: - btn.setToolTip(tooltip) - if connections is not None: - try: - iter(connections) # type: ignore - except TypeError: - connections = [connections] # type: ignore - connections = cast(List[Callable], connections) - for con in connections: - btn.clicked.connect(con) - if layout is not None: - layout.addWidget(btn) - return btn - - -class QRightPushButton(QtWidgets.QPushButton): - """A push button that acts differently when right-clicked""" - - rightclicked = QtCore.pyqtSignal() - - def mousePressEvent(self, event: QEvent): - if event.button() == QtCore.Qt.RightButton: - self.rightclicked.emit() - event.accept() - else: - return super().mousePressEvent(event) diff --git a/setup.cfg b/setup.cfg deleted file mode 100644 index effce11..0000000 --- a/setup.cfg +++ /dev/null @@ -1,7 +0,0 @@ -[versioneer] -VCS = git -style = pep440 -versionfile_source = psy_view/_version.py -versionfile_build = psy_view/_version.py -tag_prefix = v -parentdir_prefix = psy-view- diff --git a/setup.py b/setup.py deleted file mode 100644 index 079c123..0000000 --- a/setup.py +++ /dev/null @@ -1,94 +0,0 @@ -import os -import os.path as osp -from setuptools import setup, find_packages -from setuptools.command.test import test as TestCommand -import sys - -import versioneer - - -class PyTest(TestCommand): - user_options = [('pytest-args=', 'a', "Arguments to pass to pytest")] - - def initialize_options(self): - TestCommand.initialize_options(self) - self.pytest_args = '' - - def run_tests(self): - import shlex - # import here, cause outside the eggs aren't loaded - import pytest - errno = pytest.main(shlex.split(self.pytest_args)) - sys.exit(errno) - - -def readme(): - with open('README.rst') as f: - return f.read().replace( - 'docs/_static/screenshot.png', - 'https://raw.githubusercontent.com/psyplot/psy-view/master/' - 'docs/_static/screenshot.png') - - -version = versioneer.get_version() - -dependencies = [ - 'psyplot-gui>=1.3.0', - 'psy-maps>=1.3.0', - 'netCDF4', -] - -# Test for PyQt5 dependency. During a conda build, this is handled by the -# meta.yaml so we can skip this dependency -if not os.getenv('CONDA_BUILD'): - # The package might nevertheless be installed, just registered with a - # different name - try: - import PyQt5 - except ImportError: - dependencies.append('pyqt5!=5.12') - dependencies.append('PyQtWebEngine') - dependencies.append('pyqt5-sip') - - -cmdclass = versioneer.get_cmdclass({'test': PyTest}) - - -setup(name='psy-view', - version=version, - description='ncview-like interface to psyplot', - long_description=readme(), - long_description_content_type="text/x-rst", - classifiers=[ - 'Development Status :: 5 - Production/Stable', - 'Intended Audience :: Science/Research', - 'Topic :: Scientific/Engineering :: Visualization', - 'Topic :: Scientific/Engineering :: GIS', - 'Topic :: Scientific/Engineering', - 'License :: OSI Approved :: GNU General Public License v3 (GPLv3)', - 'Programming Language :: Python :: 3', - 'Programming Language :: Python :: 3.6', - 'Programming Language :: Python :: 3.7', - 'Programming Language :: Python :: 3.8', - 'Programming Language :: Python :: 3.9', - 'Operating System :: OS Independent', - ], - keywords=('visualization earth-sciences paleo climate paleoclimate ' - 'pollen diagram digitization database'), - url='https://github.com/psyplot/psy-view', - author='Philipp S. Sommer', - author_email='philipp.sommer@hereon.de', - license="GPLv3", - packages=find_packages(exclude=['docs', 'tests*', 'examples']), - install_requires=dependencies, - package_data={'psy_view': [ - osp.join('psy_view', 'icons', '*.png'), - ]}, - include_package_data=True, - tests_require=['pytest', 'pytest-qt'], - cmdclass=cmdclass, - entry_points={ - 'console_scripts': ['psy-view=psy_view:main'], - 'psyplot_gui': ['psy-view=psy_view.ds_widget:DatasetWidgetPlugin'], - }, - zip_safe=False) diff --git a/tests/conftest.py b/tests/conftest.py deleted file mode 100644 index f19b6fb..0000000 --- a/tests/conftest.py +++ /dev/null @@ -1,37 +0,0 @@ -import os.path as osp -import pytest -import psyplot_gui.compat.qtcompat - - -_test_dir = osp.dirname(__file__) - - -@pytest.fixture -def test_dir() -> str: - return _test_dir - - -@pytest.fixture(params=["regular-test.nc", "regional-icon-test.nc", - "rotated-pole-test.nc", "icon-test.nc"]) -def test_file(test_dir, request): - return osp.join(test_dir, request.param) - - -@pytest.fixture -def test_ds(test_file): - import psyplot.data as psyd - with psyd.open_dataset(test_file) as ds: - yield ds - - -@pytest.fixture -def ds_widget(qtbot, test_ds): - import psyplot.project as psy - import matplotlib.pyplot as plt - from psy_view.ds_widget import DatasetWidget - w = DatasetWidget(test_ds) - qtbot.addWidget(w) - yield w - w._sp = None - psy.close('all') - plt.close('all') diff --git a/tests/icon-test.nc b/tests/icon-test.nc deleted file mode 100644 index 969ecb0..0000000 Binary files a/tests/icon-test.nc and /dev/null differ diff --git a/tests/pytest.ini b/tests/pytest.ini deleted file mode 100644 index 3becfac..0000000 --- a/tests/pytest.ini +++ /dev/null @@ -1,3 +0,0 @@ -[pytest] -qt_api=pyqt5 - diff --git a/tests/regional-icon-test.nc b/tests/regional-icon-test.nc deleted file mode 100644 index bafe98e..0000000 Binary files a/tests/regional-icon-test.nc and /dev/null differ diff --git a/tests/regular-test.nc b/tests/regular-test.nc deleted file mode 100644 index c615be2..0000000 Binary files a/tests/regular-test.nc and /dev/null differ diff --git a/tests/rotated-pole-test.nc b/tests/rotated-pole-test.nc deleted file mode 100644 index 4bd9b07..0000000 Binary files a/tests/rotated-pole-test.nc and /dev/null differ diff --git a/tests/test_dialogs.py b/tests/test_dialogs.py deleted file mode 100644 index f9d179a..0000000 --- a/tests/test_dialogs.py +++ /dev/null @@ -1,80 +0,0 @@ -"""Test the formatoption dialogs""" -import pytest - - -@pytest.fixture -def test_project(test_ds): - sp = test_ds.psy.plot.mapplot(name='t2m') - yield sp - sp.close() - - -@pytest.fixture -def cmap_dialog(qtbot, test_project): - from psy_view.dialogs import CmapDialog - dialog = CmapDialog(test_project) - qtbot.addWidget(dialog) - return dialog - - -def test_colorbar_preview_valid_bounds(cmap_dialog): - """Test whether the update to a new bounds setting works""" - bounds = [240, 270, 310] - cmap_dialog.bounds_widget.editor.set_obj(bounds) - - assert list(cmap_dialog.cbar_preview.cbar.norm.boundaries) == bounds - - -def test_colorbar_preview_valid_cmap(cmap_dialog): - """Test whether the update to a new cmap setting works""" - cmap = 'Blues' - cmap_dialog.cmap_widget.editor.set_obj(cmap) - - assert cmap_dialog.cbar_preview.cbar.cmap.name == cmap - - -def test_colorbar_preview_valid_ticks(cmap_dialog): - """Test whether the update to a new cticks setting works""" - ticks = [285, 290] - cmap_dialog.cticks_widget.editor.set_obj(ticks) - - assert list(cmap_dialog.cbar_preview.cbar.get_ticks()) == ticks - - -def test_colorbar_preview_invalid_bounds(cmap_dialog): - """Test whether the update to a invalid bounds setting works""" - bounds = list(cmap_dialog.cbar_preview.cbar.norm.boundaries) - - # set invalid bounds - cmap_dialog.bounds_widget.editor.text = '[1, 2, 3' - - assert list(cmap_dialog.cbar_preview.cbar.norm.boundaries) == bounds - - -def test_colorbar_preview_invalid_cmap(cmap_dialog): - """Test whether the update to a invalued cmap setting works""" - cmap = cmap_dialog.cbar_preview.cbar.cmap.name - - # set invalid cmap - cmap_dialog.cmap_widget.editor.text = 'Blue' - - assert cmap_dialog.cbar_preview.cbar.cmap.name == cmap - - -def test_colorbar_preview_invalid_ticks(cmap_dialog): - """Test whether the update to a new color setting works""" - ticks = list(cmap_dialog.cbar_preview.cbar.get_ticks()) - - # set invalid ticks - cmap_dialog.cticks_widget.editor.text = '[1, 2, 3' - - assert list(cmap_dialog.cbar_preview.cbar.get_ticks()) == ticks - - -def test_cmap_dialog_fmts(cmap_dialog): - """Test the updating of formatoptions""" - assert not cmap_dialog.fmts - - cmap_dialog.bounds_widget.editor.set_obj('minmax') - - assert cmap_dialog.fmts == {'bounds': 'minmax'} \ No newline at end of file diff --git a/tests/test_ds_widget.py b/tests/test_ds_widget.py deleted file mode 100644 index 70b5d21..0000000 --- a/tests/test_ds_widget.py +++ /dev/null @@ -1,458 +0,0 @@ -"""Test the main functionality of the psy-view package, namely the widget""" -import os.path as osp -import sys -import shutil -from PyQt5.QtCore import Qt -from PyQt5 import QtWidgets -import pytest - - -def test_variables(ds_widget, test_ds): - """Test existence of variables in netCDF file""" - for v in test_ds: - assert v in ds_widget.variable_buttons - assert ds_widget.variable_buttons[v].text() == v - - -def test_mapplot(qtbot, ds_widget): - """Test plotting and closing with mapplot""" - ds_widget.plotmethod = 'mapplot' - qtbot.mouseClick(ds_widget.variable_buttons['t2m'], Qt.LeftButton) - assert ds_widget.sp - qtbot.mouseClick(ds_widget.variable_buttons['t2m'], Qt.LeftButton) - assert not ds_widget.sp - - -@pytest.mark.parametrize('plotmethod', ['mapplot', 'plot2d']) -@pytest.mark.parametrize('i', list(range(5))) -def test_change_plot_type(qtbot, ds_widget, plotmethod, i): - """Test plotting and closing with mapplot""" - ds_widget.plotmethod = plotmethod - qtbot.mouseClick(ds_widget.variable_buttons['t2m'], Qt.LeftButton) - assert ds_widget.sp - pm_widget = ds_widget.plotmethod_widget - pm_widget.combo_plot.setCurrentIndex(i) - plot_type = pm_widget.plot_types[i] - - assert ds_widget.sp.plotters[0].plot.value == plot_type - - -@pytest.mark.parametrize('plotmethod', ['mapplot', 'plot2d']) -def test_variable_switch(qtbot, ds_widget, plotmethod): - """Test switching of variables""" - ds_widget.plotmethod = plotmethod - qtbot.mouseClick(ds_widget.variable_buttons['t2m'], Qt.LeftButton) - assert len(ds_widget.sp) == 1 - assert ds_widget.data.name == 't2m' - qtbot.mouseClick(ds_widget.variable_buttons['v'], Qt.LeftButton) - assert len(ds_widget.sp) == 1 - assert ds_widget.data.name == 'v' - qtbot.mouseClick(ds_widget.variable_buttons['v_2d'], Qt.LeftButton) - assert len(ds_widget.sp) == 1 - assert ds_widget.data.name == 'v_2d' - qtbot.mouseClick(ds_widget.variable_buttons['v'], Qt.LeftButton) - assert len(ds_widget.sp) == 1 - assert ds_widget.data.name == 'v' - qtbot.mouseClick(ds_widget.variable_buttons['v'], Qt.LeftButton) - assert not ds_widget.sp - - -def test_plot2d(qtbot, ds_widget): - """Test plotting and closing with plot2d""" - ds_widget.plotmethod = 'plot2d' - qtbot.mouseClick(ds_widget.variable_buttons['t2m'], Qt.LeftButton) - assert ds_widget.sp - qtbot.mouseClick(ds_widget.variable_buttons['t2m'], Qt.LeftButton) - assert not ds_widget.sp - - -def test_plot2d_dim_switch(qtbot, ds_widget, test_ds, test_file): - arr = test_ds['t2m'] - - ds_widget.plotmethod = 'plot2d' - - pm_widget = ds_widget.plotmethod_widget - - pm_widget.combo_xdim.setCurrentText(arr.dims[0]) - pm_widget.combo_ydim.setCurrentText(arr.dims[1]) - - assert pm_widget.combo_xcoord.currentText() == arr.dims[0] - assert pm_widget.combo_ycoord.currentText() == arr.dims[1] - - fmts = pm_widget.init_dims(arr) - - assert fmts['transpose'] - - qtbot.mouseClick(ds_widget.variable_buttons['t2m'], Qt.LeftButton) - - assert not pm_widget.combo_xdim.isEnabled() - - assert ds_widget.sp - assert ds_widget.plotter.plot_data.dims == arr.dims[:2] - - -@pytest.mark.parametrize('plotmethod', ['mapplot', 'plot2d']) -def test_plot2d_coord(qtbot, ds_widget, test_ds, test_file, plotmethod): - arr = test_ds.psy['t2m'] - - if osp.basename(test_file) != "rotated-pole-test.nc": - return pytest.skip("Testing rotated coords only") - - ydim, xdim = arr.dims[-2:] - - test_ds[xdim].attrs.pop('axis', None) - test_ds[ydim].attrs.pop('axis', None) - - assert 'coordinates' in arr.encoding - - ds_widget.plotmethod = plotmethod - - pm_widget = ds_widget.plotmethod_widget - - assert pm_widget.combo_xcoord.isEnabled() - - # make the plot with default setting - qtbot.mouseClick(ds_widget.variable_buttons['t2m'], Qt.LeftButton) - - assert not pm_widget.combo_xcoord.isEnabled() - - assert pm_widget.data.psy.get_coord('x').name != xdim - assert pm_widget.data.psy.get_coord('y').name != ydim - - # remove the plot - qtbot.mouseClick(ds_widget.variable_buttons['t2m'], Qt.LeftButton) - - assert pm_widget.combo_xcoord.isEnabled() - - # tell to use the dimensions - pm_widget.combo_xcoord.setCurrentText(xdim) - pm_widget.combo_ycoord.setCurrentText(ydim) - - # make the plot with the changed settings - qtbot.mouseClick(ds_widget.variable_buttons['t2m'], Qt.LeftButton) - - assert not pm_widget.combo_xcoord.isEnabled() - - assert pm_widget.data.psy.get_coord('x').name == xdim - assert pm_widget.data.psy.get_coord('y').name == ydim - - -def test_lineplot(qtbot, ds_widget): - """Test plotting and closing with lineplot""" - ds_widget.plotmethod = 'lineplot' - qtbot.mouseClick(ds_widget.variable_buttons['t2m'], Qt.LeftButton) - assert ds_widget.sp - qtbot.mouseClick(ds_widget.variable_buttons['t2m'], Qt.LeftButton) - assert not ds_widget.sp - - -def test_lineplot_switch(qtbot, ds_widget): - """Test switching of variables""" - ds_widget.plotmethod = 'lineplot' - qtbot.mouseClick(ds_widget.variable_buttons['t2m'], Qt.LeftButton) - assert len(ds_widget.sp) == 1 - assert ds_widget.data.name == 't2m' - qtbot.mouseClick(ds_widget.variable_buttons['v'], Qt.LeftButton) - assert len(ds_widget.sp) == 1 - assert ds_widget.data.name == 'v' - qtbot.mouseClick(ds_widget.variable_buttons['v'], Qt.LeftButton) - assert not ds_widget.sp - - -@pytest.mark.parametrize('plotmethod', ['mapplot', 'plot2d']) -def test_cmap(qtbot, ds_widget, plotmethod): - ds_widget.plotmethod = plotmethod - qtbot.mouseClick(ds_widget.variable_buttons['t2m'], Qt.LeftButton) - cmap = ds_widget.plotter.cmap.value - assert ds_widget.plotter.plot.mappable.get_cmap().name == cmap - ds_widget.plotmethod_widget.btn_cmap.menu().actions()[5].trigger() - assert ds_widget.plotter.cmap.value != cmap - assert ds_widget.plotter.plot.mappable.get_cmap().name != cmap - qtbot.mouseClick(ds_widget.variable_buttons['t2m'], Qt.LeftButton) - - -def test_add_and_remove_line(qtbot, ds_widget, monkeypatch): - "Test adding and removing lines" - ds_widget.plotmethod = 'lineplot' - - monkeypatch.setattr( - QtWidgets.QInputDialog, "getItem", - lambda *args: ('t2m', True)) - - qtbot.mouseClick(ds_widget.variable_buttons['t2m'], Qt.LeftButton) - assert ds_widget.sp - assert len(ds_widget.sp[0]) == 1 - qtbot.mouseClick(ds_widget.plotmethod_widget.btn_add, Qt.LeftButton) - assert len(ds_widget.sp[0]) == 2 - qtbot.mouseClick(ds_widget.plotmethod_widget.btn_del, Qt.LeftButton) - assert len(ds_widget.sp[0]) == 1 - qtbot.mouseClick(ds_widget.variable_buttons['t2m'], Qt.LeftButton) - assert not ds_widget.sp - - -@pytest.mark.parametrize('plotmethod', ['mapplot', 'plot2d', 'lineplot']) -def test_btn_step(qtbot, ds_widget, plotmethod): - """Test clicking the next time button""" - ds_widget.plotmethod = plotmethod - qtbot.mouseClick(ds_widget.variable_buttons['t2m'], Qt.LeftButton) - dim = ds_widget.combo_dims.currentText() - assert dim - assert ds_widget.data.psy.idims[dim] == 0 - - # increase time - qtbot.mouseClick(ds_widget.btn_next, Qt.LeftButton) - assert ds_widget.data.psy.idims[dim] == 1 - - # decrease time - qtbot.mouseClick(ds_widget.btn_prev, Qt.LeftButton) - assert ds_widget.data.psy.idims[dim] == 0 - -@pytest.mark.parametrize('plotmethod', ['mapplot', 'plot2d', 'lineplot']) -def test_dimension_button(qtbot, ds_widget, plotmethod): - """Test clicking on a button in the dimension table""" - ds_widget.plotmethod = plotmethod - qtbot.mouseClick(ds_widget.variable_buttons['t2m'], Qt.LeftButton) - - btn = ds_widget.dimension_table.cellWidget(1, 2) - - dim = ds_widget.dimension_table.verticalHeaderItem(1).text() - - assert ds_widget.data.psy.idims[dim] == 0 - - qtbot.mouseClick(btn, Qt.LeftButton) - - assert ds_widget.data.psy.idims[dim] == 1 - - qtbot.mouseClick(btn, Qt.RightButton) - - assert ds_widget.data.psy.idims[dim] == 0 - - -@pytest.mark.parametrize('plotmethod', ['mapplot', 'plot2d', 'lineplot']) -@pytest.mark.parametrize('direction', ['forward', 'backward']) -def test_animate(qtbot, ds_widget, plotmethod, direction): - """Test clicking the next time button""" - - def animation_finished(): - current = ds_widget.data.psy.idims[dim] - if steps and current in steps: - steps.remove(current) - return False - elif steps: - return False - else: - return True - - - ds_widget.plotmethod = plotmethod - ds_widget.sl_interval.setValue(10) - qtbot.mouseClick(ds_widget.variable_buttons['t2m'], Qt.LeftButton) - dim = ds_widget.combo_dims.currentText() - - assert dim - - steps = set(range(ds_widget.ds.dims[dim])) - - btn = getattr(ds_widget, 'btn_animate_' + direction) - - assert not ds_widget._animating - - # start animation - qtbot.mouseClick(btn, Qt.LeftButton) - assert ds_widget._animating - qtbot.waitUntil(animation_finished, timeout=30000) - - # stop animation - qtbot.mouseClick(btn, Qt.LeftButton) - assert not ds_widget._animating - - # restart animation - steps = set(range(ds_widget.ds.dims[dim])) - qtbot.mouseClick(btn, Qt.LeftButton) - assert ds_widget._animating - qtbot.waitUntil(animation_finished, timeout=30000) - - # stop animation - qtbot.mouseClick(btn, Qt.LeftButton) - assert not ds_widget._animating - - -def test_enable_disable_variables(test_ds, qtbot): - from psy_view.ds_widget import DatasetWidget - import numpy as np - test_ds['line'] = ('xtest', np.zeros(7)) - test_ds['xtest'] = ('xtest', np.arange(7)) - - ds_widget = DatasetWidget(test_ds) - qtbot.addWidget(ds_widget) - - assert ds_widget.variable_buttons['t2m'].isEnabled() - assert not ds_widget.variable_buttons['line'].isEnabled() - - ds_widget.plotmethod = 'lineplot' - - assert ds_widget.variable_buttons['t2m'].isEnabled() - assert ds_widget.variable_buttons['line'].isEnabled() - - ds_widget.plotmethod = 'plot2d' - - assert ds_widget.variable_buttons['t2m'].isEnabled() - assert not ds_widget.variable_buttons['line'].isEnabled() - - -@pytest.mark.parametrize('plotmethod', ['mapplot', 'plot2d', 'lineplot']) -def test_open_and_close_plots( - ds_widget, qtbot, monkeypatch, plotmethod): - """Create multiple plots and export them all""" - ds_widget.plotmethod = plotmethod - - monkeypatch.setattr( - QtWidgets.QInputDialog, "getItem", - lambda *args: ('t2m', True)) - - qtbot.mouseClick(ds_widget.btn_add, Qt.LeftButton) - assert ds_widget.sp - assert len(ds_widget.sp) == 1 - assert ds_widget.variable_buttons['t2m'].isChecked() - - monkeypatch.setattr( - QtWidgets.QInputDialog, "getItem", - lambda *args: ('u', True)) - - # create a second plot - qtbot.mouseClick(ds_widget.btn_add, Qt.LeftButton) - - assert ds_widget.sp - assert len(ds_widget.sp) == 1 - assert len(ds_widget._sp) == 2 - assert ds_widget.combo_array.count() == 2 - assert ds_widget.combo_array.currentIndex() == 1 - assert ds_widget.variable_buttons['u'].isChecked() - - # switch to the first variable - ds_widget.combo_array.setCurrentIndex(0) - assert len(ds_widget.sp) == 1 - assert len(ds_widget._sp) == 2 - assert ds_widget.data.name == 't2m' - assert ds_widget.variable_buttons['t2m'].isChecked() - - # close the plot - qtbot.mouseClick(ds_widget.btn_del, Qt.LeftButton) - assert len(ds_widget.sp) == 1 - assert len(ds_widget._sp) == 1 - assert ds_widget.data.name == 'u' - assert ds_widget.variable_buttons['u'].isChecked() - - # close the second plot - qtbot.mouseClick(ds_widget.btn_del, Qt.LeftButton) - assert not bool(ds_widget.sp) - assert not bool(ds_widget._sp) - assert not any(btn.isChecked() for name, btn in - ds_widget.variable_buttons.items()) - - -@pytest.mark.parametrize('plotmethod', ['mapplot', 'plot2d', 'lineplot']) -def test_multi_export(ds_widget, qtbot, monkeypatch, tmpdir, plotmethod): - """Create multiple plots and export them all""" - ds_widget.plotmethod = plotmethod - - qtbot.mouseClick(ds_widget.variable_buttons['t2m'], Qt.LeftButton) - assert ds_widget.sp - assert len(ds_widget.sp) == 1 - - monkeypatch.setattr( - QtWidgets.QInputDialog, "getItem", - lambda *args: ('u', True)) - - # create a second plot - qtbot.mouseClick(ds_widget.btn_add, Qt.LeftButton) - - assert ds_widget.sp - assert len(ds_widget.sp) == 1 - assert len(ds_widget._sp) == 2 - assert ds_widget.combo_array.count() == 2 - assert ds_widget.combo_array.currentIndex() == 1 - - # export the plots - - monkeypatch.setattr( - QtWidgets.QFileDialog, "getSaveFileName", - lambda *args: (osp.join(tmpdir, "test.pdf"), True)) - - ds_widget.export_all_images() - - # Test if warning is triggered when exporting only one image - - monkeypatch.setattr( - QtWidgets.QFileDialog, "getSaveFileName", - lambda *args: (osp.join(tmpdir, "test.png"), True)) - - question_asked = [] - - def dont_save(*args): - question_asked.append(True) - return QtWidgets.QMessageBox.No - - monkeypatch.setattr( - QtWidgets.QMessageBox, "question", dont_save) - - - - ds_widget.export_all_images() - - assert question_asked == [True] - - assert not osp.exists(osp.join(tmpdir, "test.png")) - - -@pytest.mark.parametrize('plotmethod', ['mapplot', 'plot2d', 'lineplot']) -def test_export_animation(qtbot, ds_widget, plotmethod, tmpdir, monkeypatch): - """Test clicking the next time button""" - from psy_view.rcsetup import rcParams - - ds_widget.plotmethod = plotmethod - ds_widget.sl_interval.setValue(10) - qtbot.mouseClick(ds_widget.variable_buttons['t2m'], Qt.LeftButton) - dim = ds_widget.combo_dims.currentText() - - assert dim - - assert not ds_widget._animating - - monkeypatch.setattr( - QtWidgets.QFileDialog, "getSaveFileName", - lambda *args: (osp.join(tmpdir, "test.gif"), True)) - - with rcParams.catch(): - rcParams['animations.export_kws'] = {'writer': 'pillow'} - - ds_widget.export_animation() - - assert not ds_widget._animating - - assert osp.exists(osp.join(tmpdir, "test.gif")) - - -@pytest.mark.skipif(sys.platform == "win32", reason="Troubles with tmp_path") -def test_reload(qtbot, test_dir, tmp_path) -> None: - """Test the reload button.""" - import psyplot.project as psy - from psy_view.ds_widget import DatasetWidget - - f1, f2 = "regular-test.nc", "regional-icon-test.nc" - shutil.copy(osp.join(test_dir, f1), str(tmp_path / f1)) - - ds_widget = DatasetWidget(psy.open_dataset(str(tmp_path / f1))) - qtbot.addWidget(ds_widget) - qtbot.mouseClick(ds_widget.variable_buttons['t2m'], Qt.LeftButton) - - assert ds_widget.ds_tree.topLevelItemCount() == 1 - assert ds_widget.ds["t2m"].ndim == 4 - - # now copy the icon file to the same destination and reload everything - shutil.copy(osp.join(test_dir, f2), str(tmp_path / f1)) - ds_widget.reload() - - assert ds_widget.ds_tree.topLevelItemCount() == 1 - assert ds_widget.ds["t2m"].ndim == 3 - assert len(psy.gcp(True)) == 1 diff --git a/versioneer.py b/versioneer.py deleted file mode 100644 index 719036f..0000000 --- a/versioneer.py +++ /dev/null @@ -1,1822 +0,0 @@ - -# Version: 0.18 - -"""The Versioneer - like a rocketeer, but for versions. - -The Versioneer -============== - -* like a rocketeer, but for versions! -* https://github.com/warner/python-versioneer -* Brian Warner -* License: Public Domain -* Compatible With: python2.6, 2.7, 3.2, 3.3, 3.4, 3.5, 3.6, and pypy -* [![Latest Version] -(https://pypip.in/version/versioneer/badge.svg?style=flat) -](https://pypi.python.org/pypi/versioneer/) -* [![Build Status] -(https://travis-ci.org/warner/python-versioneer.png?branch=master) -](https://travis-ci.org/warner/python-versioneer) - -This is a tool for managing a recorded version number in distutils-based -python projects. The goal is to remove the tedious and error-prone "update -the embedded version string" step from your release process. Making a new -release should be as easy as recording a new tag in your version-control -system, and maybe making new tarballs. - - -## Quick Install - -* `pip install versioneer` to somewhere to your $PATH -* add a `[versioneer]` section to your setup.cfg (see below) -* run `versioneer install` in your source tree, commit the results - -## Version Identifiers - -Source trees come from a variety of places: - -* a version-control system checkout (mostly used by developers) -* a nightly tarball, produced by build automation -* a snapshot tarball, produced by a web-based VCS browser, like github's - "tarball from tag" feature -* a release tarball, produced by "setup.py sdist", distributed through PyPI - -Within each source tree, the version identifier (either a string or a number, -this tool is format-agnostic) can come from a variety of places: - -* ask the VCS tool itself, e.g. "git describe" (for checkouts), which knows - about recent "tags" and an absolute revision-id -* the name of the directory into which the tarball was unpacked -* an expanded VCS keyword ($Id$, etc) -* a `_version.py` created by some earlier build step - -For released software, the version identifier is closely related to a VCS -tag. Some projects use tag names that include more than just the version -string (e.g. "myproject-1.2" instead of just "1.2"), in which case the tool -needs to strip the tag prefix to extract the version identifier. For -unreleased software (between tags), the version identifier should provide -enough information to help developers recreate the same tree, while also -giving them an idea of roughly how old the tree is (after version 1.2, before -version 1.3). Many VCS systems can report a description that captures this, -for example `git describe --tags --dirty --always` reports things like -"0.7-1-g574ab98-dirty" to indicate that the checkout is one revision past the -0.7 tag, has a unique revision id of "574ab98", and is "dirty" (it has -uncommitted changes. - -The version identifier is used for multiple purposes: - -* to allow the module to self-identify its version: `myproject.__version__` -* to choose a name and prefix for a 'setup.py sdist' tarball - -## Theory of Operation - -Versioneer works by adding a special `_version.py` file into your source -tree, where your `__init__.py` can import it. This `_version.py` knows how to -dynamically ask the VCS tool for version information at import time. - -`_version.py` also contains `$Revision$` markers, and the installation -process marks `_version.py` to have this marker rewritten with a tag name -during the `git archive` command. As a result, generated tarballs will -contain enough information to get the proper version. - -To allow `setup.py` to compute a version too, a `versioneer.py` is added to -the top level of your source tree, next to `setup.py` and the `setup.cfg` -that configures it. This overrides several distutils/setuptools commands to -compute the version when invoked, and changes `setup.py build` and `setup.py -sdist` to replace `_version.py` with a small static file that contains just -the generated version data. - -## Installation - -See [INSTALL.md](./INSTALL.md) for detailed installation instructions. - -## Version-String Flavors - -Code which uses Versioneer can learn about its version string at runtime by -importing `_version` from your main `__init__.py` file and running the -`get_versions()` function. From the "outside" (e.g. in `setup.py`), you can -import the top-level `versioneer.py` and run `get_versions()`. - -Both functions return a dictionary with different flavors of version -information: - -* `['version']`: A condensed version string, rendered using the selected - style. This is the most commonly used value for the project's version - string. The default "pep440" style yields strings like `0.11`, - `0.11+2.g1076c97`, or `0.11+2.g1076c97.dirty`. See the "Styles" section - below for alternative styles. - -* `['full-revisionid']`: detailed revision identifier. For Git, this is the - full SHA1 commit id, e.g. "1076c978a8d3cfc70f408fe5974aa6c092c949ac". - -* `['date']`: Date and time of the latest `HEAD` commit. For Git, it is the - commit date in ISO 8601 format. This will be None if the date is not - available. - -* `['dirty']`: a boolean, True if the tree has uncommitted changes. Note that - this is only accurate if run in a VCS checkout, otherwise it is likely to - be False or None - -* `['error']`: if the version string could not be computed, this will be set - to a string describing the problem, otherwise it will be None. It may be - useful to throw an exception in setup.py if this is set, to avoid e.g. - creating tarballs with a version string of "unknown". - -Some variants are more useful than others. Including `full-revisionid` in a -bug report should allow developers to reconstruct the exact code being tested -(or indicate the presence of local changes that should be shared with the -developers). `version` is suitable for display in an "about" box or a CLI -`--version` output: it can be easily compared against release notes and lists -of bugs fixed in various releases. - -The installer adds the following text to your `__init__.py` to place a basic -version in `YOURPROJECT.__version__`: - - from ._version import get_versions - __version__ = get_versions()['version'] - del get_versions - -## Styles - -The setup.cfg `style=` configuration controls how the VCS information is -rendered into a version string. - -The default style, "pep440", produces a PEP440-compliant string, equal to the -un-prefixed tag name for actual releases, and containing an additional "local -version" section with more detail for in-between builds. For Git, this is -TAG[+DISTANCE.gHEX[.dirty]] , using information from `git describe --tags ---dirty --always`. For example "0.11+2.g1076c97.dirty" indicates that the -tree is like the "1076c97" commit but has uncommitted changes (".dirty"), and -that this commit is two revisions ("+2") beyond the "0.11" tag. For released -software (exactly equal to a known tag), the identifier will only contain the -stripped tag, e.g. "0.11". - -Other styles are available. See [details.md](details.md) in the Versioneer -source tree for descriptions. - -## Debugging - -Versioneer tries to avoid fatal errors: if something goes wrong, it will tend -to return a version of "0+unknown". To investigate the problem, run `setup.py -version`, which will run the version-lookup code in a verbose mode, and will -display the full contents of `get_versions()` (including the `error` string, -which may help identify what went wrong). - -## Known Limitations - -Some situations are known to cause problems for Versioneer. This details the -most significant ones. More can be found on Github -[issues page](https://github.com/warner/python-versioneer/issues). - -### Subprojects - -Versioneer has limited support for source trees in which `setup.py` is not in -the root directory (e.g. `setup.py` and `.git/` are *not* siblings). The are -two common reasons why `setup.py` might not be in the root: - -* Source trees which contain multiple subprojects, such as - [Buildbot](https://github.com/buildbot/buildbot), which contains both - "master" and "slave" subprojects, each with their own `setup.py`, - `setup.cfg`, and `tox.ini`. Projects like these produce multiple PyPI - distributions (and upload multiple independently-installable tarballs). -* Source trees whose main purpose is to contain a C library, but which also - provide bindings to Python (and perhaps other langauges) in subdirectories. - -Versioneer will look for `.git` in parent directories, and most operations -should get the right version string. However `pip` and `setuptools` have bugs -and implementation details which frequently cause `pip install .` from a -subproject directory to fail to find a correct version string (so it usually -defaults to `0+unknown`). - -`pip install --editable .` should work correctly. `setup.py install` might -work too. - -Pip-8.1.1 is known to have this problem, but hopefully it will get fixed in -some later version. - -[Bug #38](https://github.com/warner/python-versioneer/issues/38) is tracking -this issue. The discussion in -[PR #61](https://github.com/warner/python-versioneer/pull/61) describes the -issue from the Versioneer side in more detail. -[pip PR#3176](https://github.com/pypa/pip/pull/3176) and -[pip PR#3615](https://github.com/pypa/pip/pull/3615) contain work to improve -pip to let Versioneer work correctly. - -Versioneer-0.16 and earlier only looked for a `.git` directory next to the -`setup.cfg`, so subprojects were completely unsupported with those releases. - -### Editable installs with setuptools <= 18.5 - -`setup.py develop` and `pip install --editable .` allow you to install a -project into a virtualenv once, then continue editing the source code (and -test) without re-installing after every change. - -"Entry-point scripts" (`setup(entry_points={"console_scripts": ..})`) are a -convenient way to specify executable scripts that should be installed along -with the python package. - -These both work as expected when using modern setuptools. When using -setuptools-18.5 or earlier, however, certain operations will cause -`pkg_resources.DistributionNotFound` errors when running the entrypoint -script, which must be resolved by re-installing the package. This happens -when the install happens with one version, then the egg_info data is -regenerated while a different version is checked out. Many setup.py commands -cause egg_info to be rebuilt (including `sdist`, `wheel`, and installing into -a different virtualenv), so this can be surprising. - -[Bug #83](https://github.com/warner/python-versioneer/issues/83) describes -this one, but upgrading to a newer version of setuptools should probably -resolve it. - -### Unicode version strings - -While Versioneer works (and is continually tested) with both Python 2 and -Python 3, it is not entirely consistent with bytes-vs-unicode distinctions. -Newer releases probably generate unicode version strings on py2. It's not -clear that this is wrong, but it may be surprising for applications when then -write these strings to a network connection or include them in bytes-oriented -APIs like cryptographic checksums. - -[Bug #71](https://github.com/warner/python-versioneer/issues/71) investigates -this question. - - -## Updating Versioneer - -To upgrade your project to a new release of Versioneer, do the following: - -* install the new Versioneer (`pip install -U versioneer` or equivalent) -* edit `setup.cfg`, if necessary, to include any new configuration settings - indicated by the release notes. See [UPGRADING](./UPGRADING.md) for details. -* re-run `versioneer install` in your source tree, to replace - `SRC/_version.py` -* commit any changed files - -## Future Directions - -This tool is designed to make it easily extended to other version-control -systems: all VCS-specific components are in separate directories like -src/git/ . The top-level `versioneer.py` script is assembled from these -components by running make-versioneer.py . In the future, make-versioneer.py -will take a VCS name as an argument, and will construct a version of -`versioneer.py` that is specific to the given VCS. It might also take the -configuration arguments that are currently provided manually during -installation by editing setup.py . Alternatively, it might go the other -direction and include code from all supported VCS systems, reducing the -number of intermediate scripts. - - -## License - -To make Versioneer easier to embed, all its code is dedicated to the public -domain. The `_version.py` that it creates is also in the public domain. -Specifically, both are released under the Creative Commons "Public Domain -Dedication" license (CC0-1.0), as described in -https://creativecommons.org/publicdomain/zero/1.0/ . - -""" - -from __future__ import print_function -try: - import configparser -except ImportError: - import ConfigParser as configparser -import errno -import json -import os -import re -import subprocess -import sys - - -class VersioneerConfig: - """Container for Versioneer configuration parameters.""" - - -def get_root(): - """Get the project root directory. - - We require that all commands are run from the project root, i.e. the - directory that contains setup.py, setup.cfg, and versioneer.py . - """ - root = os.path.realpath(os.path.abspath(os.getcwd())) - setup_py = os.path.join(root, "setup.py") - versioneer_py = os.path.join(root, "versioneer.py") - if not (os.path.exists(setup_py) or os.path.exists(versioneer_py)): - # allow 'python path/to/setup.py COMMAND' - root = os.path.dirname(os.path.realpath(os.path.abspath(sys.argv[0]))) - setup_py = os.path.join(root, "setup.py") - versioneer_py = os.path.join(root, "versioneer.py") - if not (os.path.exists(setup_py) or os.path.exists(versioneer_py)): - err = ("Versioneer was unable to run the project root directory. " - "Versioneer requires setup.py to be executed from " - "its immediate directory (like 'python setup.py COMMAND'), " - "or in a way that lets it use sys.argv[0] to find the root " - "(like 'python path/to/setup.py COMMAND').") - raise VersioneerBadRootError(err) - try: - # Certain runtime workflows (setup.py install/develop in a setuptools - # tree) execute all dependencies in a single python process, so - # "versioneer" may be imported multiple times, and python's shared - # module-import table will cache the first one. So we can't use - # os.path.dirname(__file__), as that will find whichever - # versioneer.py was first imported, even in later projects. - me = os.path.realpath(os.path.abspath(__file__)) - me_dir = os.path.normcase(os.path.splitext(me)[0]) - vsr_dir = os.path.normcase(os.path.splitext(versioneer_py)[0]) - if me_dir != vsr_dir: - print("Warning: build in %s is using versioneer.py from %s" - % (os.path.dirname(me), versioneer_py)) - except NameError: - pass - return root - - -def get_config_from_root(root): - """Read the project setup.cfg file to determine Versioneer config.""" - # This might raise EnvironmentError (if setup.cfg is missing), or - # configparser.NoSectionError (if it lacks a [versioneer] section), or - # configparser.NoOptionError (if it lacks "VCS="). See the docstring at - # the top of versioneer.py for instructions on writing your setup.cfg . - setup_cfg = os.path.join(root, "setup.cfg") - parser = configparser.SafeConfigParser() - with open(setup_cfg, "r") as f: - parser.readfp(f) - VCS = parser.get("versioneer", "VCS") # mandatory - - def get(parser, name): - if parser.has_option("versioneer", name): - return parser.get("versioneer", name) - return None - cfg = VersioneerConfig() - cfg.VCS = VCS - cfg.style = get(parser, "style") or "" - cfg.versionfile_source = get(parser, "versionfile_source") - cfg.versionfile_build = get(parser, "versionfile_build") - cfg.tag_prefix = get(parser, "tag_prefix") - if cfg.tag_prefix in ("''", '""'): - cfg.tag_prefix = "" - cfg.parentdir_prefix = get(parser, "parentdir_prefix") - cfg.verbose = get(parser, "verbose") - return cfg - - -class NotThisMethod(Exception): - """Exception raised if a method is not valid for the current scenario.""" - - -# these dictionaries contain VCS-specific tools -LONG_VERSION_PY = {} -HANDLERS = {} - - -def register_vcs_handler(vcs, method): # decorator - """Decorator to mark a method as the handler for a particular VCS.""" - def decorate(f): - """Store f in HANDLERS[vcs][method].""" - if vcs not in HANDLERS: - HANDLERS[vcs] = {} - HANDLERS[vcs][method] = f - return f - return decorate - - -def run_command(commands, args, cwd=None, verbose=False, hide_stderr=False, - env=None): - """Call the given command(s).""" - assert isinstance(commands, list) - p = None - for c in commands: - try: - dispcmd = str([c] + args) - # remember shell=False, so use git.cmd on windows, not just git - p = subprocess.Popen([c] + args, cwd=cwd, env=env, - stdout=subprocess.PIPE, - stderr=(subprocess.PIPE if hide_stderr - else None)) - break - except EnvironmentError: - e = sys.exc_info()[1] - if e.errno == errno.ENOENT: - continue - if verbose: - print("unable to run %s" % dispcmd) - print(e) - return None, None - else: - if verbose: - print("unable to find command, tried %s" % (commands,)) - return None, None - stdout = p.communicate()[0].strip() - if sys.version_info[0] >= 3: - stdout = stdout.decode() - if p.returncode != 0: - if verbose: - print("unable to run %s (error)" % dispcmd) - print("stdout was %s" % stdout) - return None, p.returncode - return stdout, p.returncode - - -LONG_VERSION_PY['git'] = ''' -# This file helps to compute a version number in source trees obtained from -# git-archive tarball (such as those provided by githubs download-from-tag -# feature). Distribution tarballs (built by setup.py sdist) and build -# directories (produced by setup.py build) will contain a much shorter file -# that just contains the computed version number. - -# This file is released into the public domain. Generated by -# versioneer-0.18 (https://github.com/warner/python-versioneer) - -"""Git implementation of _version.py.""" - -import errno -import os -import re -import subprocess -import sys - - -def get_keywords(): - """Get the keywords needed to look up the version information.""" - # these strings will be replaced by git during git-archive. - # setup.py/versioneer.py will grep for the variable names, so they must - # each be defined on a line of their own. _version.py will just call - # get_keywords(). - git_refnames = "%(DOLLAR)sFormat:%%d%(DOLLAR)s" - git_full = "%(DOLLAR)sFormat:%%H%(DOLLAR)s" - git_date = "%(DOLLAR)sFormat:%%ci%(DOLLAR)s" - keywords = {"refnames": git_refnames, "full": git_full, "date": git_date} - return keywords - - -class VersioneerConfig: - """Container for Versioneer configuration parameters.""" - - -def get_config(): - """Create, populate and return the VersioneerConfig() object.""" - # these strings are filled in when 'setup.py versioneer' creates - # _version.py - cfg = VersioneerConfig() - cfg.VCS = "git" - cfg.style = "%(STYLE)s" - cfg.tag_prefix = "%(TAG_PREFIX)s" - cfg.parentdir_prefix = "%(PARENTDIR_PREFIX)s" - cfg.versionfile_source = "%(VERSIONFILE_SOURCE)s" - cfg.verbose = False - return cfg - - -class NotThisMethod(Exception): - """Exception raised if a method is not valid for the current scenario.""" - - -LONG_VERSION_PY = {} -HANDLERS = {} - - -def register_vcs_handler(vcs, method): # decorator - """Decorator to mark a method as the handler for a particular VCS.""" - def decorate(f): - """Store f in HANDLERS[vcs][method].""" - if vcs not in HANDLERS: - HANDLERS[vcs] = {} - HANDLERS[vcs][method] = f - return f - return decorate - - -def run_command(commands, args, cwd=None, verbose=False, hide_stderr=False, - env=None): - """Call the given command(s).""" - assert isinstance(commands, list) - p = None - for c in commands: - try: - dispcmd = str([c] + args) - # remember shell=False, so use git.cmd on windows, not just git - p = subprocess.Popen([c] + args, cwd=cwd, env=env, - stdout=subprocess.PIPE, - stderr=(subprocess.PIPE if hide_stderr - else None)) - break - except EnvironmentError: - e = sys.exc_info()[1] - if e.errno == errno.ENOENT: - continue - if verbose: - print("unable to run %%s" %% dispcmd) - print(e) - return None, None - else: - if verbose: - print("unable to find command, tried %%s" %% (commands,)) - return None, None - stdout = p.communicate()[0].strip() - if sys.version_info[0] >= 3: - stdout = stdout.decode() - if p.returncode != 0: - if verbose: - print("unable to run %%s (error)" %% dispcmd) - print("stdout was %%s" %% stdout) - return None, p.returncode - return stdout, p.returncode - - -def versions_from_parentdir(parentdir_prefix, root, verbose): - """Try to determine the version from the parent directory name. - - Source tarballs conventionally unpack into a directory that includes both - the project name and a version string. We will also support searching up - two directory levels for an appropriately named parent directory - """ - rootdirs = [] - - for i in range(3): - dirname = os.path.basename(root) - if dirname.startswith(parentdir_prefix): - return {"version": dirname[len(parentdir_prefix):], - "full-revisionid": None, - "dirty": False, "error": None, "date": None} - else: - rootdirs.append(root) - root = os.path.dirname(root) # up a level - - if verbose: - print("Tried directories %%s but none started with prefix %%s" %% - (str(rootdirs), parentdir_prefix)) - raise NotThisMethod("rootdir doesn't start with parentdir_prefix") - - -@register_vcs_handler("git", "get_keywords") -def git_get_keywords(versionfile_abs): - """Extract version information from the given file.""" - # the code embedded in _version.py can just fetch the value of these - # keywords. When used from setup.py, we don't want to import _version.py, - # so we do it with a regexp instead. This function is not used from - # _version.py. - keywords = {} - try: - f = open(versionfile_abs, "r") - for line in f.readlines(): - if line.strip().startswith("git_refnames ="): - mo = re.search(r'=\s*"(.*)"', line) - if mo: - keywords["refnames"] = mo.group(1) - if line.strip().startswith("git_full ="): - mo = re.search(r'=\s*"(.*)"', line) - if mo: - keywords["full"] = mo.group(1) - if line.strip().startswith("git_date ="): - mo = re.search(r'=\s*"(.*)"', line) - if mo: - keywords["date"] = mo.group(1) - f.close() - except EnvironmentError: - pass - return keywords - - -@register_vcs_handler("git", "keywords") -def git_versions_from_keywords(keywords, tag_prefix, verbose): - """Get version information from git keywords.""" - if not keywords: - raise NotThisMethod("no keywords at all, weird") - date = keywords.get("date") - if date is not None: - # git-2.2.0 added "%%cI", which expands to an ISO-8601 -compliant - # datestamp. However we prefer "%%ci" (which expands to an "ISO-8601 - # -like" string, which we must then edit to make compliant), because - # it's been around since git-1.5.3, and it's too difficult to - # discover which version we're using, or to work around using an - # older one. - date = date.strip().replace(" ", "T", 1).replace(" ", "", 1) - refnames = keywords["refnames"].strip() - if refnames.startswith("$Format"): - if verbose: - print("keywords are unexpanded, not using") - raise NotThisMethod("unexpanded keywords, not a git-archive tarball") - refs = set([r.strip() for r in refnames.strip("()").split(",")]) - # starting in git-1.8.3, tags are listed as "tag: foo-1.0" instead of - # just "foo-1.0". If we see a "tag: " prefix, prefer those. - TAG = "tag: " - tags = set([r[len(TAG):] for r in refs if r.startswith(TAG)]) - if not tags: - # Either we're using git < 1.8.3, or there really are no tags. We use - # a heuristic: assume all version tags have a digit. The old git %%d - # expansion behaves like git log --decorate=short and strips out the - # refs/heads/ and refs/tags/ prefixes that would let us distinguish - # between branches and tags. By ignoring refnames without digits, we - # filter out many common branch names like "release" and - # "stabilization", as well as "HEAD" and "master". - tags = set([r for r in refs if re.search(r'\d', r)]) - if verbose: - print("discarding '%%s', no digits" %% ",".join(refs - tags)) - if verbose: - print("likely tags: %%s" %% ",".join(sorted(tags))) - for ref in sorted(tags): - # sorting will prefer e.g. "2.0" over "2.0rc1" - if ref.startswith(tag_prefix): - r = ref[len(tag_prefix):] - if verbose: - print("picking %%s" %% r) - return {"version": r, - "full-revisionid": keywords["full"].strip(), - "dirty": False, "error": None, - "date": date} - # no suitable tags, so version is "0+unknown", but full hex is still there - if verbose: - print("no suitable tags, using unknown + full revision id") - return {"version": "0+unknown", - "full-revisionid": keywords["full"].strip(), - "dirty": False, "error": "no suitable tags", "date": None} - - -@register_vcs_handler("git", "pieces_from_vcs") -def git_pieces_from_vcs(tag_prefix, root, verbose, run_command=run_command): - """Get version from 'git describe' in the root of the source tree. - - This only gets called if the git-archive 'subst' keywords were *not* - expanded, and _version.py hasn't already been rewritten with a short - version string, meaning we're inside a checked out source tree. - """ - GITS = ["git"] - if sys.platform == "win32": - GITS = ["git.cmd", "git.exe"] - - out, rc = run_command(GITS, ["rev-parse", "--git-dir"], cwd=root, - hide_stderr=True) - if rc != 0: - if verbose: - print("Directory %%s not under git control" %% root) - raise NotThisMethod("'git rev-parse --git-dir' returned error") - - # if there is a tag matching tag_prefix, this yields TAG-NUM-gHEX[-dirty] - # if there isn't one, this yields HEX[-dirty] (no NUM) - describe_out, rc = run_command(GITS, ["describe", "--tags", "--dirty", - "--always", "--long", - "--match", "%%s*" %% tag_prefix], - cwd=root) - # --long was added in git-1.5.5 - if describe_out is None: - raise NotThisMethod("'git describe' failed") - describe_out = describe_out.strip() - full_out, rc = run_command(GITS, ["rev-parse", "HEAD"], cwd=root) - if full_out is None: - raise NotThisMethod("'git rev-parse' failed") - full_out = full_out.strip() - - pieces = {} - pieces["long"] = full_out - pieces["short"] = full_out[:7] # maybe improved later - pieces["error"] = None - - # parse describe_out. It will be like TAG-NUM-gHEX[-dirty] or HEX[-dirty] - # TAG might have hyphens. - git_describe = describe_out - - # look for -dirty suffix - dirty = git_describe.endswith("-dirty") - pieces["dirty"] = dirty - if dirty: - git_describe = git_describe[:git_describe.rindex("-dirty")] - - # now we have TAG-NUM-gHEX or HEX - - if "-" in git_describe: - # TAG-NUM-gHEX - mo = re.search(r'^(.+)-(\d+)-g([0-9a-f]+)$', git_describe) - if not mo: - # unparseable. Maybe git-describe is misbehaving? - pieces["error"] = ("unable to parse git-describe output: '%%s'" - %% describe_out) - return pieces - - # tag - full_tag = mo.group(1) - if not full_tag.startswith(tag_prefix): - if verbose: - fmt = "tag '%%s' doesn't start with prefix '%%s'" - print(fmt %% (full_tag, tag_prefix)) - pieces["error"] = ("tag '%%s' doesn't start with prefix '%%s'" - %% (full_tag, tag_prefix)) - return pieces - pieces["closest-tag"] = full_tag[len(tag_prefix):] - - # distance: number of commits since tag - pieces["distance"] = int(mo.group(2)) - - # commit: short hex revision ID - pieces["short"] = mo.group(3) - - else: - # HEX: no tags - pieces["closest-tag"] = None - count_out, rc = run_command(GITS, ["rev-list", "HEAD", "--count"], - cwd=root) - pieces["distance"] = int(count_out) # total number of commits - - # commit date: see ISO-8601 comment in git_versions_from_keywords() - date = run_command(GITS, ["show", "-s", "--format=%%ci", "HEAD"], - cwd=root)[0].strip() - pieces["date"] = date.strip().replace(" ", "T", 1).replace(" ", "", 1) - - return pieces - - -def plus_or_dot(pieces): - """Return a + if we don't already have one, else return a .""" - if "+" in pieces.get("closest-tag", ""): - return "." - return "+" - - -def render_pep440(pieces): - """Build up version string, with post-release "local version identifier". - - Our goal: TAG[+DISTANCE.gHEX[.dirty]] . Note that if you - get a tagged build and then dirty it, you'll get TAG+0.gHEX.dirty - - Exceptions: - 1: no tags. git_describe was just HEX. 0+untagged.DISTANCE.gHEX[.dirty] - """ - if pieces["closest-tag"]: - rendered = pieces["closest-tag"] - if pieces["distance"] or pieces["dirty"]: - rendered += plus_or_dot(pieces) - rendered += "%%d.g%%s" %% (pieces["distance"], pieces["short"]) - if pieces["dirty"]: - rendered += ".dirty" - else: - # exception #1 - rendered = "0+untagged.%%d.g%%s" %% (pieces["distance"], - pieces["short"]) - if pieces["dirty"]: - rendered += ".dirty" - return rendered - - -def render_pep440_pre(pieces): - """TAG[.post.devDISTANCE] -- No -dirty. - - Exceptions: - 1: no tags. 0.post.devDISTANCE - """ - if pieces["closest-tag"]: - rendered = pieces["closest-tag"] - if pieces["distance"]: - rendered += ".post.dev%%d" %% pieces["distance"] - else: - # exception #1 - rendered = "0.post.dev%%d" %% pieces["distance"] - return rendered - - -def render_pep440_post(pieces): - """TAG[.postDISTANCE[.dev0]+gHEX] . - - The ".dev0" means dirty. Note that .dev0 sorts backwards - (a dirty tree will appear "older" than the corresponding clean one), - but you shouldn't be releasing software with -dirty anyways. - - Exceptions: - 1: no tags. 0.postDISTANCE[.dev0] - """ - if pieces["closest-tag"]: - rendered = pieces["closest-tag"] - if pieces["distance"] or pieces["dirty"]: - rendered += ".post%%d" %% pieces["distance"] - if pieces["dirty"]: - rendered += ".dev0" - rendered += plus_or_dot(pieces) - rendered += "g%%s" %% pieces["short"] - else: - # exception #1 - rendered = "0.post%%d" %% pieces["distance"] - if pieces["dirty"]: - rendered += ".dev0" - rendered += "+g%%s" %% pieces["short"] - return rendered - - -def render_pep440_old(pieces): - """TAG[.postDISTANCE[.dev0]] . - - The ".dev0" means dirty. - - Eexceptions: - 1: no tags. 0.postDISTANCE[.dev0] - """ - if pieces["closest-tag"]: - rendered = pieces["closest-tag"] - if pieces["distance"] or pieces["dirty"]: - rendered += ".post%%d" %% pieces["distance"] - if pieces["dirty"]: - rendered += ".dev0" - else: - # exception #1 - rendered = "0.post%%d" %% pieces["distance"] - if pieces["dirty"]: - rendered += ".dev0" - return rendered - - -def render_git_describe(pieces): - """TAG[-DISTANCE-gHEX][-dirty]. - - Like 'git describe --tags --dirty --always'. - - Exceptions: - 1: no tags. HEX[-dirty] (note: no 'g' prefix) - """ - if pieces["closest-tag"]: - rendered = pieces["closest-tag"] - if pieces["distance"]: - rendered += "-%%d-g%%s" %% (pieces["distance"], pieces["short"]) - else: - # exception #1 - rendered = pieces["short"] - if pieces["dirty"]: - rendered += "-dirty" - return rendered - - -def render_git_describe_long(pieces): - """TAG-DISTANCE-gHEX[-dirty]. - - Like 'git describe --tags --dirty --always -long'. - The distance/hash is unconditional. - - Exceptions: - 1: no tags. HEX[-dirty] (note: no 'g' prefix) - """ - if pieces["closest-tag"]: - rendered = pieces["closest-tag"] - rendered += "-%%d-g%%s" %% (pieces["distance"], pieces["short"]) - else: - # exception #1 - rendered = pieces["short"] - if pieces["dirty"]: - rendered += "-dirty" - return rendered - - -def render(pieces, style): - """Render the given version pieces into the requested style.""" - if pieces["error"]: - return {"version": "unknown", - "full-revisionid": pieces.get("long"), - "dirty": None, - "error": pieces["error"], - "date": None} - - if not style or style == "default": - style = "pep440" # the default - - if style == "pep440": - rendered = render_pep440(pieces) - elif style == "pep440-pre": - rendered = render_pep440_pre(pieces) - elif style == "pep440-post": - rendered = render_pep440_post(pieces) - elif style == "pep440-old": - rendered = render_pep440_old(pieces) - elif style == "git-describe": - rendered = render_git_describe(pieces) - elif style == "git-describe-long": - rendered = render_git_describe_long(pieces) - else: - raise ValueError("unknown style '%%s'" %% style) - - return {"version": rendered, "full-revisionid": pieces["long"], - "dirty": pieces["dirty"], "error": None, - "date": pieces.get("date")} - - -def get_versions(): - """Get version information or return default if unable to do so.""" - # I am in _version.py, which lives at ROOT/VERSIONFILE_SOURCE. If we have - # __file__, we can work backwards from there to the root. Some - # py2exe/bbfreeze/non-CPython implementations don't do __file__, in which - # case we can only use expanded keywords. - - cfg = get_config() - verbose = cfg.verbose - - try: - return git_versions_from_keywords(get_keywords(), cfg.tag_prefix, - verbose) - except NotThisMethod: - pass - - try: - root = os.path.realpath(__file__) - # versionfile_source is the relative path from the top of the source - # tree (where the .git directory might live) to this file. Invert - # this to find the root from __file__. - for i in cfg.versionfile_source.split('/'): - root = os.path.dirname(root) - except NameError: - return {"version": "0+unknown", "full-revisionid": None, - "dirty": None, - "error": "unable to find root of source tree", - "date": None} - - try: - pieces = git_pieces_from_vcs(cfg.tag_prefix, root, verbose) - return render(pieces, cfg.style) - except NotThisMethod: - pass - - try: - if cfg.parentdir_prefix: - return versions_from_parentdir(cfg.parentdir_prefix, root, verbose) - except NotThisMethod: - pass - - return {"version": "0+unknown", "full-revisionid": None, - "dirty": None, - "error": "unable to compute version", "date": None} -''' - - -@register_vcs_handler("git", "get_keywords") -def git_get_keywords(versionfile_abs): - """Extract version information from the given file.""" - # the code embedded in _version.py can just fetch the value of these - # keywords. When used from setup.py, we don't want to import _version.py, - # so we do it with a regexp instead. This function is not used from - # _version.py. - keywords = {} - try: - f = open(versionfile_abs, "r") - for line in f.readlines(): - if line.strip().startswith("git_refnames ="): - mo = re.search(r'=\s*"(.*)"', line) - if mo: - keywords["refnames"] = mo.group(1) - if line.strip().startswith("git_full ="): - mo = re.search(r'=\s*"(.*)"', line) - if mo: - keywords["full"] = mo.group(1) - if line.strip().startswith("git_date ="): - mo = re.search(r'=\s*"(.*)"', line) - if mo: - keywords["date"] = mo.group(1) - f.close() - except EnvironmentError: - pass - return keywords - - -@register_vcs_handler("git", "keywords") -def git_versions_from_keywords(keywords, tag_prefix, verbose): - """Get version information from git keywords.""" - if not keywords: - raise NotThisMethod("no keywords at all, weird") - date = keywords.get("date") - if date is not None: - # git-2.2.0 added "%cI", which expands to an ISO-8601 -compliant - # datestamp. However we prefer "%ci" (which expands to an "ISO-8601 - # -like" string, which we must then edit to make compliant), because - # it's been around since git-1.5.3, and it's too difficult to - # discover which version we're using, or to work around using an - # older one. - date = date.strip().replace(" ", "T", 1).replace(" ", "", 1) - refnames = keywords["refnames"].strip() - if refnames.startswith("$Format"): - if verbose: - print("keywords are unexpanded, not using") - raise NotThisMethod("unexpanded keywords, not a git-archive tarball") - refs = set([r.strip() for r in refnames.strip("()").split(",")]) - # starting in git-1.8.3, tags are listed as "tag: foo-1.0" instead of - # just "foo-1.0". If we see a "tag: " prefix, prefer those. - TAG = "tag: " - tags = set([r[len(TAG):] for r in refs if r.startswith(TAG)]) - if not tags: - # Either we're using git < 1.8.3, or there really are no tags. We use - # a heuristic: assume all version tags have a digit. The old git %d - # expansion behaves like git log --decorate=short and strips out the - # refs/heads/ and refs/tags/ prefixes that would let us distinguish - # between branches and tags. By ignoring refnames without digits, we - # filter out many common branch names like "release" and - # "stabilization", as well as "HEAD" and "master". - tags = set([r for r in refs if re.search(r'\d', r)]) - if verbose: - print("discarding '%s', no digits" % ",".join(refs - tags)) - if verbose: - print("likely tags: %s" % ",".join(sorted(tags))) - for ref in sorted(tags): - # sorting will prefer e.g. "2.0" over "2.0rc1" - if ref.startswith(tag_prefix): - r = ref[len(tag_prefix):] - if verbose: - print("picking %s" % r) - return {"version": r, - "full-revisionid": keywords["full"].strip(), - "dirty": False, "error": None, - "date": date} - # no suitable tags, so version is "0+unknown", but full hex is still there - if verbose: - print("no suitable tags, using unknown + full revision id") - return {"version": "0+unknown", - "full-revisionid": keywords["full"].strip(), - "dirty": False, "error": "no suitable tags", "date": None} - - -@register_vcs_handler("git", "pieces_from_vcs") -def git_pieces_from_vcs(tag_prefix, root, verbose, run_command=run_command): - """Get version from 'git describe' in the root of the source tree. - - This only gets called if the git-archive 'subst' keywords were *not* - expanded, and _version.py hasn't already been rewritten with a short - version string, meaning we're inside a checked out source tree. - """ - GITS = ["git"] - if sys.platform == "win32": - GITS = ["git.cmd", "git.exe"] - - out, rc = run_command(GITS, ["rev-parse", "--git-dir"], cwd=root, - hide_stderr=True) - if rc != 0: - if verbose: - print("Directory %s not under git control" % root) - raise NotThisMethod("'git rev-parse --git-dir' returned error") - - # if there is a tag matching tag_prefix, this yields TAG-NUM-gHEX[-dirty] - # if there isn't one, this yields HEX[-dirty] (no NUM) - describe_out, rc = run_command(GITS, ["describe", "--tags", "--dirty", - "--always", "--long", - "--match", "%s*" % tag_prefix], - cwd=root) - # --long was added in git-1.5.5 - if describe_out is None: - raise NotThisMethod("'git describe' failed") - describe_out = describe_out.strip() - full_out, rc = run_command(GITS, ["rev-parse", "HEAD"], cwd=root) - if full_out is None: - raise NotThisMethod("'git rev-parse' failed") - full_out = full_out.strip() - - pieces = {} - pieces["long"] = full_out - pieces["short"] = full_out[:7] # maybe improved later - pieces["error"] = None - - # parse describe_out. It will be like TAG-NUM-gHEX[-dirty] or HEX[-dirty] - # TAG might have hyphens. - git_describe = describe_out - - # look for -dirty suffix - dirty = git_describe.endswith("-dirty") - pieces["dirty"] = dirty - if dirty: - git_describe = git_describe[:git_describe.rindex("-dirty")] - - # now we have TAG-NUM-gHEX or HEX - - if "-" in git_describe: - # TAG-NUM-gHEX - mo = re.search(r'^(.+)-(\d+)-g([0-9a-f]+)$', git_describe) - if not mo: - # unparseable. Maybe git-describe is misbehaving? - pieces["error"] = ("unable to parse git-describe output: '%s'" - % describe_out) - return pieces - - # tag - full_tag = mo.group(1) - if not full_tag.startswith(tag_prefix): - if verbose: - fmt = "tag '%s' doesn't start with prefix '%s'" - print(fmt % (full_tag, tag_prefix)) - pieces["error"] = ("tag '%s' doesn't start with prefix '%s'" - % (full_tag, tag_prefix)) - return pieces - pieces["closest-tag"] = full_tag[len(tag_prefix):] - - # distance: number of commits since tag - pieces["distance"] = int(mo.group(2)) - - # commit: short hex revision ID - pieces["short"] = mo.group(3) - - else: - # HEX: no tags - pieces["closest-tag"] = None - count_out, rc = run_command(GITS, ["rev-list", "HEAD", "--count"], - cwd=root) - pieces["distance"] = int(count_out) # total number of commits - - # commit date: see ISO-8601 comment in git_versions_from_keywords() - date = run_command(GITS, ["show", "-s", "--format=%ci", "HEAD"], - cwd=root)[0].strip() - pieces["date"] = date.strip().replace(" ", "T", 1).replace(" ", "", 1) - - return pieces - - -def do_vcs_install(manifest_in, versionfile_source, ipy): - """Git-specific installation logic for Versioneer. - - For Git, this means creating/changing .gitattributes to mark _version.py - for export-subst keyword substitution. - """ - GITS = ["git"] - if sys.platform == "win32": - GITS = ["git.cmd", "git.exe"] - files = [manifest_in, versionfile_source] - if ipy: - files.append(ipy) - try: - me = __file__ - if me.endswith(".pyc") or me.endswith(".pyo"): - me = os.path.splitext(me)[0] + ".py" - versioneer_file = os.path.relpath(me) - except NameError: - versioneer_file = "versioneer.py" - files.append(versioneer_file) - present = False - try: - f = open(".gitattributes", "r") - for line in f.readlines(): - if line.strip().startswith(versionfile_source): - if "export-subst" in line.strip().split()[1:]: - present = True - f.close() - except EnvironmentError: - pass - if not present: - f = open(".gitattributes", "a+") - f.write("%s export-subst\n" % versionfile_source) - f.close() - files.append(".gitattributes") - run_command(GITS, ["add", "--"] + files) - - -def versions_from_parentdir(parentdir_prefix, root, verbose): - """Try to determine the version from the parent directory name. - - Source tarballs conventionally unpack into a directory that includes both - the project name and a version string. We will also support searching up - two directory levels for an appropriately named parent directory - """ - rootdirs = [] - - for i in range(3): - dirname = os.path.basename(root) - if dirname.startswith(parentdir_prefix): - return {"version": dirname[len(parentdir_prefix):], - "full-revisionid": None, - "dirty": False, "error": None, "date": None} - else: - rootdirs.append(root) - root = os.path.dirname(root) # up a level - - if verbose: - print("Tried directories %s but none started with prefix %s" % - (str(rootdirs), parentdir_prefix)) - raise NotThisMethod("rootdir doesn't start with parentdir_prefix") - - -SHORT_VERSION_PY = """ -# This file was generated by 'versioneer.py' (0.18) from -# revision-control system data, or from the parent directory name of an -# unpacked source archive. Distribution tarballs contain a pre-generated copy -# of this file. - -import json - -version_json = ''' -%s -''' # END VERSION_JSON - - -def get_versions(): - return json.loads(version_json) -""" - - -def versions_from_file(filename): - """Try to determine the version from _version.py if present.""" - try: - with open(filename) as f: - contents = f.read() - except EnvironmentError: - raise NotThisMethod("unable to read _version.py") - mo = re.search(r"version_json = '''\n(.*)''' # END VERSION_JSON", - contents, re.M | re.S) - if not mo: - mo = re.search(r"version_json = '''\r\n(.*)''' # END VERSION_JSON", - contents, re.M | re.S) - if not mo: - raise NotThisMethod("no version_json in _version.py") - return json.loads(mo.group(1)) - - -def write_to_version_file(filename, versions): - """Write the given version number to the given _version.py file.""" - os.unlink(filename) - contents = json.dumps(versions, sort_keys=True, - indent=1, separators=(",", ": ")) - with open(filename, "w") as f: - f.write(SHORT_VERSION_PY % contents) - - print("set %s to '%s'" % (filename, versions["version"])) - - -def plus_or_dot(pieces): - """Return a + if we don't already have one, else return a .""" - if "+" in pieces.get("closest-tag", ""): - return "." - return "+" - - -def render_pep440(pieces): - """Build up version string, with post-release "local version identifier". - - Our goal: TAG[+DISTANCE.gHEX[.dirty]] . Note that if you - get a tagged build and then dirty it, you'll get TAG+0.gHEX.dirty - - Exceptions: - 1: no tags. git_describe was just HEX. 0+untagged.DISTANCE.gHEX[.dirty] - """ - if pieces["closest-tag"]: - rendered = pieces["closest-tag"] - if pieces["distance"] or pieces["dirty"]: - rendered += plus_or_dot(pieces) - rendered += "%d.g%s" % (pieces["distance"], pieces["short"]) - if pieces["dirty"]: - rendered += ".dirty" - else: - # exception #1 - rendered = "0+untagged.%d.g%s" % (pieces["distance"], - pieces["short"]) - if pieces["dirty"]: - rendered += ".dirty" - return rendered - - -def render_pep440_pre(pieces): - """TAG[.post.devDISTANCE] -- No -dirty. - - Exceptions: - 1: no tags. 0.post.devDISTANCE - """ - if pieces["closest-tag"]: - rendered = pieces["closest-tag"] - if pieces["distance"]: - rendered += ".post.dev%d" % pieces["distance"] - else: - # exception #1 - rendered = "0.post.dev%d" % pieces["distance"] - return rendered - - -def render_pep440_post(pieces): - """TAG[.postDISTANCE[.dev0]+gHEX] . - - The ".dev0" means dirty. Note that .dev0 sorts backwards - (a dirty tree will appear "older" than the corresponding clean one), - but you shouldn't be releasing software with -dirty anyways. - - Exceptions: - 1: no tags. 0.postDISTANCE[.dev0] - """ - if pieces["closest-tag"]: - rendered = pieces["closest-tag"] - if pieces["distance"] or pieces["dirty"]: - rendered += ".post%d" % pieces["distance"] - if pieces["dirty"]: - rendered += ".dev0" - rendered += plus_or_dot(pieces) - rendered += "g%s" % pieces["short"] - else: - # exception #1 - rendered = "0.post%d" % pieces["distance"] - if pieces["dirty"]: - rendered += ".dev0" - rendered += "+g%s" % pieces["short"] - return rendered - - -def render_pep440_old(pieces): - """TAG[.postDISTANCE[.dev0]] . - - The ".dev0" means dirty. - - Eexceptions: - 1: no tags. 0.postDISTANCE[.dev0] - """ - if pieces["closest-tag"]: - rendered = pieces["closest-tag"] - if pieces["distance"] or pieces["dirty"]: - rendered += ".post%d" % pieces["distance"] - if pieces["dirty"]: - rendered += ".dev0" - else: - # exception #1 - rendered = "0.post%d" % pieces["distance"] - if pieces["dirty"]: - rendered += ".dev0" - return rendered - - -def render_git_describe(pieces): - """TAG[-DISTANCE-gHEX][-dirty]. - - Like 'git describe --tags --dirty --always'. - - Exceptions: - 1: no tags. HEX[-dirty] (note: no 'g' prefix) - """ - if pieces["closest-tag"]: - rendered = pieces["closest-tag"] - if pieces["distance"]: - rendered += "-%d-g%s" % (pieces["distance"], pieces["short"]) - else: - # exception #1 - rendered = pieces["short"] - if pieces["dirty"]: - rendered += "-dirty" - return rendered - - -def render_git_describe_long(pieces): - """TAG-DISTANCE-gHEX[-dirty]. - - Like 'git describe --tags --dirty --always -long'. - The distance/hash is unconditional. - - Exceptions: - 1: no tags. HEX[-dirty] (note: no 'g' prefix) - """ - if pieces["closest-tag"]: - rendered = pieces["closest-tag"] - rendered += "-%d-g%s" % (pieces["distance"], pieces["short"]) - else: - # exception #1 - rendered = pieces["short"] - if pieces["dirty"]: - rendered += "-dirty" - return rendered - - -def render(pieces, style): - """Render the given version pieces into the requested style.""" - if pieces["error"]: - return {"version": "unknown", - "full-revisionid": pieces.get("long"), - "dirty": None, - "error": pieces["error"], - "date": None} - - if not style or style == "default": - style = "pep440" # the default - - if style == "pep440": - rendered = render_pep440(pieces) - elif style == "pep440-pre": - rendered = render_pep440_pre(pieces) - elif style == "pep440-post": - rendered = render_pep440_post(pieces) - elif style == "pep440-old": - rendered = render_pep440_old(pieces) - elif style == "git-describe": - rendered = render_git_describe(pieces) - elif style == "git-describe-long": - rendered = render_git_describe_long(pieces) - else: - raise ValueError("unknown style '%s'" % style) - - return {"version": rendered, "full-revisionid": pieces["long"], - "dirty": pieces["dirty"], "error": None, - "date": pieces.get("date")} - - -class VersioneerBadRootError(Exception): - """The project root directory is unknown or missing key files.""" - - -def get_versions(verbose=False): - """Get the project version from whatever source is available. - - Returns dict with two keys: 'version' and 'full'. - """ - if "versioneer" in sys.modules: - # see the discussion in cmdclass.py:get_cmdclass() - del sys.modules["versioneer"] - - root = get_root() - cfg = get_config_from_root(root) - - assert cfg.VCS is not None, "please set [versioneer]VCS= in setup.cfg" - handlers = HANDLERS.get(cfg.VCS) - assert handlers, "unrecognized VCS '%s'" % cfg.VCS - verbose = verbose or cfg.verbose - assert cfg.versionfile_source is not None, \ - "please set versioneer.versionfile_source" - assert cfg.tag_prefix is not None, "please set versioneer.tag_prefix" - - versionfile_abs = os.path.join(root, cfg.versionfile_source) - - # extract version from first of: _version.py, VCS command (e.g. 'git - # describe'), parentdir. This is meant to work for developers using a - # source checkout, for users of a tarball created by 'setup.py sdist', - # and for users of a tarball/zipball created by 'git archive' or github's - # download-from-tag feature or the equivalent in other VCSes. - - get_keywords_f = handlers.get("get_keywords") - from_keywords_f = handlers.get("keywords") - if get_keywords_f and from_keywords_f: - try: - keywords = get_keywords_f(versionfile_abs) - ver = from_keywords_f(keywords, cfg.tag_prefix, verbose) - if verbose: - print("got version from expanded keyword %s" % ver) - return ver - except NotThisMethod: - pass - - try: - ver = versions_from_file(versionfile_abs) - if verbose: - print("got version from file %s %s" % (versionfile_abs, ver)) - return ver - except NotThisMethod: - pass - - from_vcs_f = handlers.get("pieces_from_vcs") - if from_vcs_f: - try: - pieces = from_vcs_f(cfg.tag_prefix, root, verbose) - ver = render(pieces, cfg.style) - if verbose: - print("got version from VCS %s" % ver) - return ver - except NotThisMethod: - pass - - try: - if cfg.parentdir_prefix: - ver = versions_from_parentdir(cfg.parentdir_prefix, root, verbose) - if verbose: - print("got version from parentdir %s" % ver) - return ver - except NotThisMethod: - pass - - if verbose: - print("unable to compute version") - - return {"version": "0+unknown", "full-revisionid": None, - "dirty": None, "error": "unable to compute version", - "date": None} - - -def get_version(): - """Get the short version string for this project.""" - return get_versions()["version"] - - -def get_cmdclass(cmdclass=None): - """Get the custom setuptools/distutils subclasses used by Versioneer.""" - if "versioneer" in sys.modules: - del sys.modules["versioneer"] - # this fixes the "python setup.py develop" case (also 'install' and - # 'easy_install .'), in which subdependencies of the main project are - # built (using setup.py bdist_egg) in the same python process. Assume - # a main project A and a dependency B, which use different versions - # of Versioneer. A's setup.py imports A's Versioneer, leaving it in - # sys.modules by the time B's setup.py is executed, causing B to run - # with the wrong versioneer. Setuptools wraps the sub-dep builds in a - # sandbox that restores sys.modules to it's pre-build state, so the - # parent is protected against the child's "import versioneer". By - # removing ourselves from sys.modules here, before the child build - # happens, we protect the child from the parent's versioneer too. - # Also see https://github.com/warner/python-versioneer/issues/52 - - cmds = {} if cmdclass is None else cmdclass.copy() - - # we add "version" to both distutils and setuptools - from distutils.core import Command - - class cmd_version(Command): - description = "report generated version string" - user_options = [] - boolean_options = [] - - def initialize_options(self): - pass - - def finalize_options(self): - pass - - def run(self): - vers = get_versions(verbose=True) - print("Version: %s" % vers["version"]) - print(" full-revisionid: %s" % vers.get("full-revisionid")) - print(" dirty: %s" % vers.get("dirty")) - print(" date: %s" % vers.get("date")) - if vers["error"]: - print(" error: %s" % vers["error"]) - cmds["version"] = cmd_version - - # we override "build_py" in both distutils and setuptools - # - # most invocation pathways end up running build_py: - # distutils/build -> build_py - # distutils/install -> distutils/build ->.. - # setuptools/bdist_wheel -> distutils/install ->.. - # setuptools/bdist_egg -> distutils/install_lib -> build_py - # setuptools/install -> bdist_egg ->.. - # setuptools/develop -> ? - # pip install: - # copies source tree to a tempdir before running egg_info/etc - # if .git isn't copied too, 'git describe' will fail - # then does setup.py bdist_wheel, or sometimes setup.py install - # setup.py egg_info -> ? - - # we override different "build_py" commands for both environments - if "setuptools" in sys.modules: - from setuptools.command.build_py import build_py as _build_py - else: - from distutils.command.build_py import build_py as _build_py - - class cmd_build_py(_build_py): - def run(self): - root = get_root() - cfg = get_config_from_root(root) - versions = get_versions() - _build_py.run(self) - # now locate _version.py in the new build/ directory and replace - # it with an updated value - if cfg.versionfile_build: - target_versionfile = os.path.join(self.build_lib, - cfg.versionfile_build) - print("UPDATING %s" % target_versionfile) - write_to_version_file(target_versionfile, versions) - cmds["build_py"] = cmd_build_py - - if "cx_Freeze" in sys.modules: # cx_freeze enabled? - from cx_Freeze.dist import build_exe as _build_exe - # nczeczulin reports that py2exe won't like the pep440-style string - # as FILEVERSION, but it can be used for PRODUCTVERSION, e.g. - # setup(console=[{ - # "version": versioneer.get_version().split("+", 1)[0], # FILEVERSION - # "product_version": versioneer.get_version(), - # ... - - class cmd_build_exe(_build_exe): - def run(self): - root = get_root() - cfg = get_config_from_root(root) - versions = get_versions() - target_versionfile = cfg.versionfile_source - print("UPDATING %s" % target_versionfile) - write_to_version_file(target_versionfile, versions) - - _build_exe.run(self) - os.unlink(target_versionfile) - with open(cfg.versionfile_source, "w") as f: - LONG = LONG_VERSION_PY[cfg.VCS] - f.write(LONG % - {"DOLLAR": "$", - "STYLE": cfg.style, - "TAG_PREFIX": cfg.tag_prefix, - "PARENTDIR_PREFIX": cfg.parentdir_prefix, - "VERSIONFILE_SOURCE": cfg.versionfile_source, - }) - cmds["build_exe"] = cmd_build_exe - del cmds["build_py"] - - if 'py2exe' in sys.modules: # py2exe enabled? - try: - from py2exe.distutils_buildexe import py2exe as _py2exe # py3 - except ImportError: - from py2exe.build_exe import py2exe as _py2exe # py2 - - class cmd_py2exe(_py2exe): - def run(self): - root = get_root() - cfg = get_config_from_root(root) - versions = get_versions() - target_versionfile = cfg.versionfile_source - print("UPDATING %s" % target_versionfile) - write_to_version_file(target_versionfile, versions) - - _py2exe.run(self) - os.unlink(target_versionfile) - with open(cfg.versionfile_source, "w") as f: - LONG = LONG_VERSION_PY[cfg.VCS] - f.write(LONG % - {"DOLLAR": "$", - "STYLE": cfg.style, - "TAG_PREFIX": cfg.tag_prefix, - "PARENTDIR_PREFIX": cfg.parentdir_prefix, - "VERSIONFILE_SOURCE": cfg.versionfile_source, - }) - cmds["py2exe"] = cmd_py2exe - - # we override different "sdist" commands for both environments - if "setuptools" in sys.modules: - from setuptools.command.sdist import sdist as _sdist - else: - from distutils.command.sdist import sdist as _sdist - - class cmd_sdist(_sdist): - def run(self): - versions = get_versions() - self._versioneer_generated_versions = versions - # unless we update this, the command will keep using the old - # version - self.distribution.metadata.version = versions["version"] - return _sdist.run(self) - - def make_release_tree(self, base_dir, files): - root = get_root() - cfg = get_config_from_root(root) - _sdist.make_release_tree(self, base_dir, files) - # now locate _version.py in the new base_dir directory - # (remembering that it may be a hardlink) and replace it with an - # updated value - target_versionfile = os.path.join(base_dir, cfg.versionfile_source) - print("UPDATING %s" % target_versionfile) - write_to_version_file(target_versionfile, - self._versioneer_generated_versions) - cmds["sdist"] = cmd_sdist - - return cmds - - -CONFIG_ERROR = """ -setup.cfg is missing the necessary Versioneer configuration. You need -a section like: - - [versioneer] - VCS = git - style = pep440 - versionfile_source = src/myproject/_version.py - versionfile_build = myproject/_version.py - tag_prefix = - parentdir_prefix = myproject- - -You will also need to edit your setup.py to use the results: - - import versioneer - setup(version=versioneer.get_version(), - cmdclass=versioneer.get_cmdclass(), ...) - -Please read the docstring in ./versioneer.py for configuration instructions, -edit setup.cfg, and re-run the installer or 'python versioneer.py setup'. -""" - -SAMPLE_CONFIG = """ -# See the docstring in versioneer.py for instructions. Note that you must -# re-run 'versioneer.py setup' after changing this section, and commit the -# resulting files. - -[versioneer] -#VCS = git -#style = pep440 -#versionfile_source = -#versionfile_build = -#tag_prefix = -#parentdir_prefix = - -""" - -INIT_PY_SNIPPET = """ -from ._version import get_versions -__version__ = get_versions()['version'] -del get_versions -""" - - -def do_setup(): - """Main VCS-independent setup function for installing Versioneer.""" - root = get_root() - try: - cfg = get_config_from_root(root) - except (EnvironmentError, configparser.NoSectionError, - configparser.NoOptionError) as e: - if isinstance(e, (EnvironmentError, configparser.NoSectionError)): - print("Adding sample versioneer config to setup.cfg", - file=sys.stderr) - with open(os.path.join(root, "setup.cfg"), "a") as f: - f.write(SAMPLE_CONFIG) - print(CONFIG_ERROR, file=sys.stderr) - return 1 - - print(" creating %s" % cfg.versionfile_source) - with open(cfg.versionfile_source, "w") as f: - LONG = LONG_VERSION_PY[cfg.VCS] - f.write(LONG % {"DOLLAR": "$", - "STYLE": cfg.style, - "TAG_PREFIX": cfg.tag_prefix, - "PARENTDIR_PREFIX": cfg.parentdir_prefix, - "VERSIONFILE_SOURCE": cfg.versionfile_source, - }) - - ipy = os.path.join(os.path.dirname(cfg.versionfile_source), - "__init__.py") - if os.path.exists(ipy): - try: - with open(ipy, "r") as f: - old = f.read() - except EnvironmentError: - old = "" - if INIT_PY_SNIPPET not in old: - print(" appending to %s" % ipy) - with open(ipy, "a") as f: - f.write(INIT_PY_SNIPPET) - else: - print(" %s unmodified" % ipy) - else: - print(" %s doesn't exist, ok" % ipy) - ipy = None - - # Make sure both the top-level "versioneer.py" and versionfile_source - # (PKG/_version.py, used by runtime code) are in MANIFEST.in, so - # they'll be copied into source distributions. Pip won't be able to - # install the package without this. - manifest_in = os.path.join(root, "MANIFEST.in") - simple_includes = set() - try: - with open(manifest_in, "r") as f: - for line in f: - if line.startswith("include "): - for include in line.split()[1:]: - simple_includes.add(include) - except EnvironmentError: - pass - # That doesn't cover everything MANIFEST.in can do - # (http://docs.python.org/2/distutils/sourcedist.html#commands), so - # it might give some false negatives. Appending redundant 'include' - # lines is safe, though. - if "versioneer.py" not in simple_includes: - print(" appending 'versioneer.py' to MANIFEST.in") - with open(manifest_in, "a") as f: - f.write("include versioneer.py\n") - else: - print(" 'versioneer.py' already in MANIFEST.in") - if cfg.versionfile_source not in simple_includes: - print(" appending versionfile_source ('%s') to MANIFEST.in" % - cfg.versionfile_source) - with open(manifest_in, "a") as f: - f.write("include %s\n" % cfg.versionfile_source) - else: - print(" versionfile_source already in MANIFEST.in") - - # Make VCS-specific changes. For git, this means creating/changing - # .gitattributes to mark _version.py for export-subst keyword - # substitution. - do_vcs_install(manifest_in, cfg.versionfile_source, ipy) - return 0 - - -def scan_setup_py(): - """Validate the contents of setup.py against Versioneer's expectations.""" - found = set() - setters = False - errors = 0 - with open("setup.py", "r") as f: - for line in f.readlines(): - if "import versioneer" in line: - found.add("import") - if "versioneer.get_cmdclass()" in line: - found.add("cmdclass") - if "versioneer.get_version()" in line: - found.add("get_version") - if "versioneer.VCS" in line: - setters = True - if "versioneer.versionfile_source" in line: - setters = True - if len(found) != 3: - print("") - print("Your setup.py appears to be missing some important items") - print("(but I might be wrong). Please make sure it has something") - print("roughly like the following:") - print("") - print(" import versioneer") - print(" setup( version=versioneer.get_version(),") - print(" cmdclass=versioneer.get_cmdclass(), ...)") - print("") - errors += 1 - if setters: - print("You should remove lines like 'versioneer.VCS = ' and") - print("'versioneer.versionfile_source = ' . This configuration") - print("now lives in setup.cfg, and should be removed from setup.py") - print("") - errors += 1 - return errors - - -if __name__ == "__main__": - cmd = sys.argv[1] - if cmd == "setup": - errors = do_setup() - errors += scan_setup_py() - if errors: - sys.exit(1)