diff --git a/.appveyor.yml b/.appveyor.yml deleted file mode 100644 index 3c825cc4..00000000 --- a/.appveyor.yml +++ /dev/null @@ -1,55 +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:/=-%)" - - cmd: "set PSYPLOT_REFERENCES=%APPVEYOR_BUILD_FOLDER%/tests/reference_figures" - - cmd: "set PSYPLOT_TESTFIGURES=%APPVEYOR_BUILD_FOLDER%/tests/test_figures" - -build: off - -test_script: - - cmd: setlocal - - cmd: set ANACONDA_API_TOKEN= - - cmd: conda build ci/conda-recipe --python %PYTHON_VERSION% - - cmd: endlocal - -after_test: - - cmd: 7z a reference_figures.zip %APPVEYOR_BUILD_FOLDER%\tests\reference_figures\*.png - - cmd: 7z a test_figures.zip %APPVEYOR_BUILD_FOLDER%\tests\test_figures\*.png - -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 - )" - -artifacts: - - path: reference_figures.zip - name: Reference figures - - path: test_figures.zip - name: Test figures diff --git a/.circleci/config.yml b/.circleci/config.yml deleted file mode 100644 index ce00e6e4..00000000 --- a/.circleci/config.yml +++ /dev/null @@ -1,125 +0,0 @@ -version: 2.1 - -orbs: - psyplot: psyplot/psyplot-ci-orb@1.5.19 - 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 - test-matplotlib-3_3: - description: Run the test suite for matplotlib 3.3 - type: boolean - default: true - test-matplotlib-latest: - description: Run the test suite for the latest version of matplotlib - type: boolean - default: true - parallelism: - description: How many parallel jobs to execute - type: integer - default: 2 - 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 psyplot-gui statsmodels netcdf4 seaborn - - psyplot/test-parallel: - name: test-matplotlib-latest - parallelism: << pipeline.parameters.parallelism >> - run-job: << pipeline.parameters.test-matplotlib-latest >> - build_refs: true - requires: - - install - - psyplot/test-parallel: - name: test-matplotlib-3.3 - parallelism: << pipeline.parameters.parallelism >> - run-job: << pipeline.parameters.test-matplotlib-3_3 >> - build_refs: true - packages: matplotlib=3.3 - 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-simple is awaiting your approval. - Please check the uploaded docs and builds prior to approval. - requires: - - test-matplotlib-latest - - test-matplotlib-3.3 - - 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: "b8:d6:d7:30:0a:74:2c:39:7b:45:0b:cd:bc:46:69:94" - 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: "b8:d6:d7:30:0a:74:2c:39:7b:45:0b:cd:bc:46:69:94" - 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-simple/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 eac068b4..00000000 --- a/.gitattributes +++ /dev/null @@ -1 +0,0 @@ -psy_simple/_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 436208c2..00000000 --- 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 cdb2e796..00000000 --- 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 fdf9bcc8..00000000 --- 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-simple/issues/new?template=new_feature.md&title=NEW+FEATURE:). - -For changing existing features, use [this template](https://github.com/psyplot/psy-simple/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 4eb59a1c..00000000 --- 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 cbc6bebe..00000000 --- a/.gitignore +++ /dev/null @@ -1,82 +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/generated -docs/examples/ -docs/index.doctree -docs/ - -# test results -*psyplot_testresults -tests/envs/cov_psyplot_py* -tests/envs/psyplot_py*.html -tests/reference_figures -tests/test_figures - -# PyBuilder -target/ - -# Spyder project -.spyderproject - -# Example ipython notebook checkpoints -*.ipynb_checkpoints/ - -# conda build files -ci/conda-recipe/recipe_append.yaml diff --git a/.gitmodules b/.gitmodules deleted file mode 100644 index e69de29b..00000000 diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 00000000..3e09a4a5 --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,5 @@ +version: 2 + +python: + version: "3.8" + system_packages: true diff --git a/CHANGELOG.rst b/CHANGELOG.rst deleted file mode 100644 index 6cdccb29..00000000 --- a/CHANGELOG.rst +++ /dev/null @@ -1,108 +0,0 @@ -v1.4.0 -====== -Compatibility fixes and LGPL license - -As with psyplot 1.4.0, psy-simple is now continuously tested and deployed with -CircleCI. - -Fixed ------ -- Compatibility fixes for matplotlib>=3.3 - -Changed -------- -- psy-simple is now officially licensed under LGPL-3.0-only, - see `#28 `__ -- We use CicleCI now for a standardized CI/CD pipeline to build and test - the code and docs all at one place, see `#27 `__ - - -v1.3.1 -====== -Patch for plotting the polygons with 3D bounds - -Changed -------- -* the values ``'tri'``, ``'tricontour'`` and ``'tricontourf'`` for the ``plot`` - formatoptions have been depreceated and should be replaced by ``'poly'``, - ``'contour'`` and ``'contourf'`` respectively, see - `#23 `__ - -Fixed ------ -* A bug was fixed with the ``extend`` formatoption if ``plot=None``, see - `#20 `__ -* variables with 3D bounds are now interpreted correctly, see - `#24 `__ - -v1.3.0 -====== -New background and mask formatoptions and more options for colorbar bounds - -Added ------ -* a new ``background`` formatoption has been implemented that allows to set the - facecolor of the axes (i.e. the background color for the plot) -* a new ``mask`` formatoption has been implemented that allows to mask the - data based on a mask that can either be in the dataset or in a separate - file (see `#15 `__) -* the ``bounds`` and other ``ticks`` (e.g. ``xticks, yticks, cticks``) - formatoptions have gained multiple new values (all backwards-compatible, see - `#13 `__): - - * they now support discrete logarithmic and symmetric bounds/ticks via - ``bounds='log'`` and ``bounds='symlog'``. - * The bounds and other tick formatoptions (`xticks, cticks, yticks, etc.`) now - support a dictionary as a value, e.g.:: - - plotter.update(bounds={'method': 'rounded', 'percmin': 5}) - * You can specify ``vmin`` and ``vmax`` for color bounds and ticks which - prevents their automatic estimation, e.g. via:: - - plotter.update(bounds={'method': 'rounded', 'vmin': 50, 'vmax': 75}) - # or - plotter.update(bounds=['rounded', None, None, None, 50, 75]) - -Changed -------- -* values in the statusbar are only shown, if the drawn artist contains the - cursor position, see `#18 `__ -* psy-simple now requires matplotlib greater or equal than 2.0 -* psy-simple has been moved from https://github.com/Chilipp/psy-simple to https://github.com/psyplot/psy-simple, - see `#7 `__ -* The color handling of the `color` formatoption has been changed to allow - appending of new data. The `colors` attribute can be extended by the - `color_cycle` using the `extended_colors` attribute (see - `#10 `__) - -Fixed ------ -* Fixed a bug to calculate color bounds for uniform data, - see `#9 `__ -* An issue has been fixed with the setting of colorbar ticks after updating - the colorbar bounds (see `#13 `__) - - -v1.2.0 -====== -Added ------ -* The ``plot2d`` plotmethod now also supports unstructured data of any shape - (see `issue#6 `__) -* Added a ``categorical`` formatoption to the ``barplot`` plot method to allow - a switch between categorical and non-categorical plots -* The lineplot method now also support ``'stacked'`` plots - -v1.1.0 -====== -Added ------ -* Changelog -* ``interp_bounds`` formatoption for the ``plot2d`` plot method (see the - `docs `__) -* Added the ``fldmean`` plot method that can be used to directly calculate and - plot the mean over the x- and y-dimensions - -Changed -------- -* The xlim and ylim formatoptions now consider inverted x- and y-axes diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md deleted file mode 100644 index f115e9c5..00000000 --- a/CONTRIBUTING.md +++ /dev/null @@ -1,5 +0,0 @@ -# Contributing to psy-simple - -:+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/COPYING b/COPYING deleted file mode 100644 index f288702d..00000000 --- a/COPYING +++ /dev/null @@ -1,674 +0,0 @@ - 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 -. diff --git a/COPYING.LESSER b/COPYING.LESSER deleted file mode 100644 index 0a041280..00000000 --- a/COPYING.LESSER +++ /dev/null @@ -1,165 +0,0 @@ - GNU LESSER 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. - - - This version of the GNU Lesser General Public License incorporates -the terms and conditions of version 3 of the GNU General Public -License, supplemented by the additional permissions listed below. - - 0. Additional Definitions. - - As used herein, "this License" refers to version 3 of the GNU Lesser -General Public License, and the "GNU GPL" refers to version 3 of the GNU -General Public License. - - "The Library" refers to a covered work governed by this License, -other than an Application or a Combined Work as defined below. - - An "Application" is any work that makes use of an interface provided -by the Library, but which is not otherwise based on the Library. -Defining a subclass of a class defined by the Library is deemed a mode -of using an interface provided by the Library. - - A "Combined Work" is a work produced by combining or linking an -Application with the Library. The particular version of the Library -with which the Combined Work was made is also called the "Linked -Version". - - The "Minimal Corresponding Source" for a Combined Work means the -Corresponding Source for the Combined Work, excluding any source code -for portions of the Combined Work that, considered in isolation, are -based on the Application, and not on the Linked Version. - - The "Corresponding Application Code" for a Combined Work means the -object code and/or source code for the Application, including any data -and utility programs needed for reproducing the Combined Work from the -Application, but excluding the System Libraries of the Combined Work. - - 1. Exception to Section 3 of the GNU GPL. - - You may convey a covered work under sections 3 and 4 of this License -without being bound by section 3 of the GNU GPL. - - 2. Conveying Modified Versions. - - If you modify a copy of the Library, and, in your modifications, a -facility refers to a function or data to be supplied by an Application -that uses the facility (other than as an argument passed when the -facility is invoked), then you may convey a copy of the modified -version: - - a) under this License, provided that you make a good faith effort to - ensure that, in the event an Application does not supply the - function or data, the facility still operates, and performs - whatever part of its purpose remains meaningful, or - - b) under the GNU GPL, with none of the additional permissions of - this License applicable to that copy. - - 3. Object Code Incorporating Material from Library Header Files. - - The object code form of an Application may incorporate material from -a header file that is part of the Library. You may convey such object -code under terms of your choice, provided that, if the incorporated -material is not limited to numerical parameters, data structure -layouts and accessors, or small macros, inline functions and templates -(ten or fewer lines in length), you do both of the following: - - a) Give prominent notice with each copy of the object code that the - Library is used in it and that the Library and its use are - covered by this License. - - b) Accompany the object code with a copy of the GNU GPL and this license - document. - - 4. Combined Works. - - You may convey a Combined Work under terms of your choice that, -taken together, effectively do not restrict modification of the -portions of the Library contained in the Combined Work and reverse -engineering for debugging such modifications, if you also do each of -the following: - - a) Give prominent notice with each copy of the Combined Work that - the Library is used in it and that the Library and its use are - covered by this License. - - b) Accompany the Combined Work with a copy of the GNU GPL and this license - document. - - c) For a Combined Work that displays copyright notices during - execution, include the copyright notice for the Library among - these notices, as well as a reference directing the user to the - copies of the GNU GPL and this license document. - - d) Do one of the following: - - 0) Convey the Minimal Corresponding Source under the terms of this - License, and the Corresponding Application Code in a form - suitable for, and under terms that permit, the user to - recombine or relink the Application with a modified version of - the Linked Version to produce a modified Combined Work, in the - manner specified by section 6 of the GNU GPL for conveying - Corresponding Source. - - 1) Use a suitable shared library mechanism for linking with the - Library. A suitable mechanism is one that (a) uses at run time - a copy of the Library already present on the user's computer - system, and (b) will operate properly with a modified version - of the Library that is interface-compatible with the Linked - Version. - - e) Provide Installation Information, but only if you would otherwise - be required to provide such information under section 6 of the - GNU GPL, and only to the extent that such information is - necessary to install and execute a modified version of the - Combined Work produced by recombining or relinking the - Application with a modified version of the Linked Version. (If - you use option 4d0, the Installation Information must accompany - the Minimal Corresponding Source and Corresponding Application - Code. If you use option 4d1, you must provide the Installation - Information in the manner specified by section 6 of the GNU GPL - for conveying Corresponding Source.) - - 5. Combined Libraries. - - You may place library facilities that are a work based on the -Library side by side in a single library together with other library -facilities that are not Applications and are not covered by this -License, and convey such a combined library under terms of your -choice, if you do both of the following: - - a) Accompany the combined library with a copy of the same work based - on the Library, uncombined with any other library facilities, - conveyed under the terms of this License. - - b) Give prominent notice with the combined library that part of it - is a work based on the Library, and explaining where to find the - accompanying uncombined form of the same work. - - 6. Revised Versions of the GNU Lesser General Public License. - - The Free Software Foundation may publish revised and/or new versions -of the GNU Lesser 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 -Library as you received it specifies that a certain numbered version -of the GNU Lesser General Public License "or any later version" -applies to it, you have the option of following the terms and -conditions either of that published version or of any later version -published by the Free Software Foundation. If the Library as you -received it does not specify a version number of the GNU Lesser -General Public License, you may choose any version of the GNU Lesser -General Public License ever published by the Free Software Foundation. - - If the Library as you received it specifies that a proxy can decide -whether future versions of the GNU Lesser General Public License shall -apply, that proxy's public statement of acceptance of any version is -permanent authorization for you to choose that version for the -Library. diff --git a/LICENSE b/LICENSE new file mode 100644 index 00000000..1d7ff429 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +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 cda9dc52..00000000 --- a/MANIFEST.in +++ /dev/null @@ -1,7 +0,0 @@ -include README.rst -include COPYING -include COPYING.LESSER -include psy_simple/widgets/icons/*.png -include psy_simple/widgets/icons/cmaps/*.png -include versioneer.py -include psy_simple/_version.py diff --git a/README.md b/README.md new file mode 100644 index 00000000..36026d33 --- /dev/null +++ b/README.md @@ -0,0 +1,3 @@ +# psy-reg redirect branch + +Dummy branch for redirecting to from RTD to github diff --git a/README.rst b/README.rst deleted file mode 100644 index 4c353a7d..00000000 --- a/README.rst +++ /dev/null @@ -1,103 +0,0 @@ -======================================================== -psy-simple: The psyplot plugin for simple visualizations -======================================================== - -.. start-badges - -.. list-table:: - :stub-columns: 1 - :widths: 10 90 - - * - docs - - |docs| - * - tests - - |circleci| |appveyor| |requires| |codecov| - * - package - - |version| |conda| |github| |zenodo| - * - implementations - - |supported-versions| |supported-implementations| - -.. |docs| image:: http://readthedocs.org/projects/psy-simple/badge/?version=latest - :alt: Documentation Status - :target: http://psy-simple.readthedocs.io/en/latest/?badge=latest - -.. |circleci| image:: https://circleci.com/gh/psyplot/psy-simple/tree/master.svg?style=svg - :alt: CircleCI - :target: https://circleci.com/gh/psyplot/psy-simple/tree/master - -.. |appveyor| image:: https://ci.appveyor.com/api/projects/status/49u41l2f9k0r4xc0/branch/master?svg=true - :alt: AppVeyor - :target: https://ci.appveyor.com/project/psyplot/psy-simple - -.. |codecov| image:: https://codecov.io/gh/psyplot/psy-simple/branch/master/graph/badge.svg - :alt: Coverage - :target: https://codecov.io/gh/psyplot/psy-simple - -.. |requires| image:: https://requires.io/github/psyplot/psy-simple/requirements.svg?branch=master - :alt: Requirements Status - :target: https://requires.io/github/psyplot/psy-simple/requirements/?branch=master - -.. |version| image:: https://img.shields.io/pypi/v/psy-simple.svg?style=flat - :alt: PyPI Package latest release - :target: https://pypi.python.org/pypi/psy-simple - -.. |conda| image:: https://anaconda.org/conda-forge/psy-simple/badges/version.svg - :alt: conda - :target: https://anaconda.org/conda-forge/psy-simple - -.. |supported-versions| image:: https://img.shields.io/pypi/pyversions/psy-simple.svg?style=flat - :alt: Supported versions - :target: https://pypi.python.org/pypi/psy-simple - -.. |supported-implementations| image:: https://img.shields.io/pypi/implementation/psy-simple.svg?style=flat - :alt: Supported implementations - :target: https://pypi.python.org/pypi/psy-simple - -.. |zenodo| image:: https://zenodo.org/badge/81938204.svg - :alt: Zenodo - :target: https://zenodo.org/badge/latestdoi/81938204 - -.. |github| image:: https://img.shields.io/github/release/psyplot/psy-simple.svg - :target: https://github.com/psyplot/psy-simple/releases/latest - :alt: Latest github release - - -.. end-badges - -Welcome to the psyplot plugin for simple visualization. This package targets -simple visualization like line plots, 2D plots, bar plots, density plots, etc. -It provides the basics for all the more advanced and specialized plugins like -the psy-maps_ or psy-reg_ plugin. - -See the full documentation on -`readthedocs.org `__ for all -`plot methods`_ and examples_. - -.. _psy-maps: http://psyplot.readthedocs.io/projects/psy-maps/ -.. _psy-reg: http://psyplot.readthedocs.io/projects/psy-reg/ -.. _plot methods: http://psyplot.readthedocs.io/projects/psy-simple/en/latest/plot_methods -.. _examples: http://psyplot.readthedocs.io/projects/psy-simple/en/latest/examples - -Copyright ---------- -Copyright (C) 2021 Helmholtz-Zentrum Hereon - -Copyright (C) 2020-2021 Helmholtz-Zentrum Geesthacht - -Copyright (C) 2016-2021 University of Lausanne - -This file is part of psy-simple and is released under the GNU LGPL-3.O license. -See COPYING and COPYING.LESSER in the root of the repository for full -licensing details. - -This program is free software: you can redistribute it and/or modify -it under the terms of the GNU Lesser General Public License version 3.0 as -published by the Free Software Foundation. - -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 LGPL-3.0 license for more details. - -You should have received a copy of the GNU LGPL-3.0 license -along with this program. If not, see . diff --git a/ci/conda-recipe/meta.yaml b/ci/conda-recipe/meta.yaml deleted file mode 100644 index 6fffdd49..00000000 --- a/ci/conda-recipe/meta.yaml +++ /dev/null @@ -1,61 +0,0 @@ -{% set name = "psy-simple" %} -{% set data = load_setup_py_data() %} - -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 %} - script: python -m pip install . --no-deps --ignore-installed -vvv - -requirements: - host: - - python - - pip - run: - - python - - psyplot >=1.3.0 - - matplotlib >=2.0 - -test: - imports: - - psy_simple - - psy_simple.plotters - - requires: - - pytest - - pytest-cov - - codecov - - dask - - pyqt - - xarray - - netCDF4 - - seaborn - - statsmodels - source_files: - - tests - - commands: - - pytest -sv --cov=psy_simple --ref --ignore=tests/widgets - - py.test -sv --cov-append --cov=psy_simple --ignore=tests/widgets - - codecov - -about: - home: https://github.com/psyplot/psy-simple - license: LGPL-3.0-only - license_family: GPL - license_file: - - COPYING - - COPYING.LESSER - summary: Psyplot plugin for simple visualization tasks - - description: | - This psyplot plugin provides plot methods for simple visualization tasks - like 2D plots, line plots, bar plots, etc. - doc_url: http://psyplot.github.io/psy-simple - dev_url: https://github.com/psyplot/psy-simple 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 00000000..0655a0e2 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 00000000..5909ea84 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 00000000..71da7207 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 00000000..7639864c 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 00000000..39bbdaf7 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 00000000..760dac54 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 00000000..f18ecaf3 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 00000000..8fe055ad 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 00000000..a100bb96 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 00000000..7d68e54b 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 00000000..2cd53f80 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 00000000..3b21745a 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 00000000..cd67953b 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 00000000..d0f6cd78 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 00000000..73631705 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 00000000..52a38628 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 00000000..5840f7dd 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 00000000..6a64c11f 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 00000000..35daa109 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 00000000..76c50088 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 00000000..d268ebf0 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 00000000..4b6a178d --- /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 00000000..2f81f55a --- /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 00000000..ca5e961b --- /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 00000000..049df787 --- /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 00000000..6a24f89b --- /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 00000000..fbba686d --- /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 00000000..2b143ac7 --- /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 00000000..44c58066 --- /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 00000000..17cdc29f --- /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 00000000..933074d1 --- /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 00000000..15d41ef3 --- /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 00000000..4451c622 --- /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 00000000..ad87abfd --- /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 00000000..14706e96 --- /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 00000000..78f60bb0 --- /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 00000000..ba8f43ee --- /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 00000000..cf85af47 --- /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 00000000..38b80d9a --- /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 00000000..0d9b16f9 --- /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 00000000..ba568522 --- /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 00000000..20a661ea --- /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 00000000..0eddaeb0 --- /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 00000000..912859b5 --- /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 00000000..2a924f1d --- /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 00000000..8cbf1b16 --- /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 00000000..018c2771 --- /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 00000000..a858a410 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 00000000..50937333 --- /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 00000000..04dc483b --- /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 00000000..57313111 --- /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 00000000..3dcbd0fa --- /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 00000000..517b4396 --- /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 00000000..9a8667b1 --- /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 00000000..a50344a2 --- /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 00000000..918201f7 --- /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 00000000..79810b02 --- /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 00000000..fcca7f54 --- /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 00000000..9ba57e59 --- /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 00000000..61d45e2f --- /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 00000000..128a971f --- /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 00000000..c3c19729 --- /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 00000000..02e75911 --- /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 00000000..72e8da14 --- /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 00000000..562ba5da --- /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 00000000..bcce6784 --- /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 00000000..812dbb53 --- /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 00000000..14e2a169 --- /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 00000000..f297de63 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 00000000..4be586d5 --- /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 00000000..aef1648a --- /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 00000000..6caac053 --- /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/_templates/layout.html b/docs/_templates/layout.html new file mode 100644 index 00000000..0ea8e2c2 --- /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_simple.colors.rst b/docs/api/psy_simple.colors.rst new file mode 100644 index 00000000..2f81f55a --- /dev/null +++ b/docs/api/psy_simple.colors.rst @@ -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/api/psy_simple.plotters.rst b/docs/api/psy_simple.plotters.rst new file mode 100644 index 00000000..ca5e961b --- /dev/null +++ b/docs/api/psy_simple.plotters.rst @@ -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/api/psy_simple.plugin.rst b/docs/api/psy_simple.plugin.rst new file mode 100644 index 00000000..049df787 --- /dev/null +++ b/docs/api/psy_simple.plugin.rst @@ -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/api/psy_simple.rst b/docs/api/psy_simple.rst new file mode 100644 index 00000000..6a24f89b --- /dev/null +++ b/docs/api/psy_simple.rst @@ -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/api/psy_simple.widgets.colors.rst b/docs/api/psy_simple.widgets.colors.rst new file mode 100644 index 00000000..fbba686d --- /dev/null +++ b/docs/api/psy_simple.widgets.colors.rst @@ -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/api/psy_simple.widgets.rst b/docs/api/psy_simple.widgets.rst new file mode 100644 index 00000000..2b143ac7 --- /dev/null +++ b/docs/api/psy_simple.widgets.rst @@ -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/api/psy_simple.widgets.texts.rst b/docs/api/psy_simple.widgets.texts.rst new file mode 100644 index 00000000..44c58066 --- /dev/null +++ b/docs/api/psy_simple.widgets.texts.rst @@ -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/apigen.bash b/docs/apigen.bash deleted file mode 100755 index 43cc4520..00000000 --- a/docs/apigen.bash +++ /dev/null @@ -1,8 +0,0 @@ -#!/bin/bash -# script to automatically generate the psyplot api documentation using -# sphinx-apidoc and sed -sphinx-apidoc -f -M -e -T -o api ../psy_simple/ -# replace chapter title in psyplot.rst -sed -i -e 1,1s/.*/'API Reference'/ api/psy_simple.rst - -sphinx-autogen -o generated *.rst diff --git a/docs/changelog.rst b/docs/changelog.rst index c393d07b..17cdc29f 100644 --- a/docs/changelog.rst +++ b/docs/changelog.rst @@ -3,4 +3,9 @@ Changelog ********* -.. include:: ../CHANGELOG.rst +.. 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/conf.py b/docs/conf.py index 5c3b8ba7..18af4e2a 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,290 +1,57 @@ -# -*- coding: utf-8 -*- +# Configuration file for the Sphinx documentation builder. # -# psy-simple documentation build configuration file +# This file only contains a selection of the most common options. For a full +# list see the documentation: +# https://www.sphinx-doc.org/en/master/usage/configuration.html -# Disclaimer -# ---------- -# -# Copyright (C) 2021 Helmholtz-Zentrum Hereon -# Copyright (C) 2020-2021 Helmholtz-Zentrum Geesthacht -# Copyright (C) 2016-2021 University of Lausanne -# -# This file is part of psy-simple and is released under the GNU LGPL-3.O license. -# See COPYING and COPYING.LESSER in the root of the repository for full -# licensing details. -# -# This program is free software: you can redistribute it and/or modify -# it under the terms of the GNU Lesser General Public License version 3.0 as -# published by the Free Software Foundation. -# -# 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 LGPL-3.0 license for more details. +# -- Path setup -------------------------------------------------------------- + +# If extensions (or modules to document with autodoc) are in another directory, +# 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. # -# You should have received a copy of the GNU LGPL-3.0 license -# along with this program. If not, see . +# import os +# import sys +# sys.path.insert(0, os.path.abspath('.')) + -import sphinx -import inspect -import os -import os.path as osp -import sys -import re -import six -import subprocess as spr -from itertools import chain -from collections import defaultdict -import warnings -import psyplot -from psyplot.plotter import Formatoption, Plotter -import psy_simple -from autodocsumm import AutoSummClassDocumenter +# -- Project information ----------------------------------------------------- + +project = 'psy-simple' +copyright = '2021, Philipp S. Sommer' +author = 'Philipp S. Sommer' -# automatically import all plotter classes -psyplot.rcParams['project.auto_import'] = True -# include links to the formatoptions in the documentation of the -# :attr:`psyplot.project.ProjectPlotter` methods -Plotter.include_links(True) +# The full version, including alpha/beta/rc tags +release = '1.3.1' -warnings.filterwarnings('ignore', message="axes.color_cycle is deprecated") -warnings.filterwarnings( - 'ignore', message=("This has been deprecated in mpl 1.5,")) -warnings.filterwarnings('ignore', message="invalid value encountered in ") -warnings.filterwarnings('ignore', message=r"\s*examples.directory") -warnings.filterwarnings('ignore', message='numpy.dtype size changed') -# -- General configuration ------------------------------------------------ +# -- General configuration --------------------------------------------------- # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = [ - 'sphinx.ext.doctest', - 'sphinx.ext.intersphinx', - 'sphinx.ext.autosummary', - 'sphinx.ext.todo', - 'sphinx.ext.viewcode', - 'matplotlib.sphinxext.plot_directive', - 'IPython.sphinxext.ipython_console_highlighting', - 'IPython.sphinxext.ipython_directive', - 'psyplot.sphinxext.extended_napoleon', - 'autodocsumm', - 'sphinx_nbexamples', ] # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] -# on_rtd is whether we are on readthedocs.org, this line of code grabbed from -# docs.readthedocs.org -on_rtd = os.environ.get('READTHEDOCS', None) == 'True' - -# process the examples if they don't exist already -process_examples = ( - not osp.exists(osp.join(osp.dirname(__file__), 'examples'))) - -if on_rtd: - spr.call([sys.executable] + - ('-m ipykernel install --user --name python3 ' - '--display-name python3').split()) - -if not osp.exists(osp.join(osp.dirname(__file__), 'api')): - spr.check_call(['bash', 'apigen.bash']) - -# HACK: Create an empty file called '' to prevent -# https://github.com/sphinx-doc/sphinx/issues/5614 -if not osp.exists(''): - with open('', 'w') as f: - pass - -# The cdo example would require the installation of climate data operators -# which is a bit of an overkill -example_gallery_config = dict( - urls='https://github.com/psyplot/psy-simple/blob/master/examples', - ) - -napoleon_use_admonition_for_examples = True - -# The suffix(es) of source filenames. -# You can specify multiple suffix as a list of string: -source_suffix = '.rst' - -# The master toctree document. -master_doc = 'index' - -autodoc_default_options = { - 'show_inheritance': True, - 'autosummary': True, -} - -autoclass_content = 'both' - -not_document_data = ['psy_simple.plugin.defaultParams', - 'psy_simple.plugin.rcParams'] - -ipython_savefig_dir = os.path.join(os.path.dirname(__file__), '_static') - -# General information about the project. -project = 'psy-simple' -copyright = ", ".join( - psy_simple.__copyright__.strip().replace("Copyright (C) ", "").splitlines() -) -author = psy_simple.__author__ - -# The version info for the project you're documenting, acts as replacement for -# |version| and |release|, also used in various other places throughout the -# built documents. -# -# The short X.Y version. -version = re.match(r'\d+\.\d+\.\d+', psy_simple.__version__).group() -# The full version, including alpha/beta/rc tags. -release = psy_simple.__version__ - -# The language for content autogenerated by Sphinx. Refer to documentation -# for a list of supported languages. -# -# This is also used if you do content translation via gettext catalogs. -# Usually you set "language" from the command line for these cases. -language = None - # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. -exclude_patterns = ['_build'] - -# The name of the Pygments (syntax highlighting) style to use. -pygments_style = 'sphinx' - -# If true, `todo` and `todoList` produce output, else they produce nothing. -todo_include_todos = True +# This pattern also affects html_static_path and html_extra_path. +exclude_patterns = [] +# The master toctree document. +master_doc = 'index' -# -- Options for HTML output ---------------------------------------------- +# -- 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 = 'alabaster' -if not on_rtd: # only import and set the theme if we're building docs locally - import sphinx_rtd_theme - html_theme = 'sphinx_rtd_theme' - html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] - - # 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'] - -# otherwise, readthedocs.org uses their theme by default, so no need to specify - -# Output file base name for HTML help builder. -htmlhelp_basename = 'psy-simpledoc' - -# -- Options for LaTeX output --------------------------------------------- - -latex_elements = { - # Additional stuff for the LaTeX preamble. - 'preamble': r'\setcounter{tocdepth}{10}' -} - -# 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-simple.tex', u'psy-simple Documentation', - author, 'manual'), -] - - -# -- Options for manual page output --------------------------------------- - -# One entry per manual page. List of tuples -# (source start file, name, description, authors, manual section). -man_pages = [ - (master_doc, 'psy-simple', u'psy-simple Documentation', - [author], 1) -] - - -# -- Options for Texinfo output ------------------------------------------- - -# Grouping the document tree into Texinfo files. List of tuples -# (source start file, target name, title, author, -# dir menu entry, description, category) -texinfo_documents = [ - (master_doc, 'psy-simple', u'psy-simple Documentation', - author, 'psy-simple', 'The psyplot plugin for simple visualizations', - 'Miscellaneous'), -] - - -# -- 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': ('http://pandas.pydata.org/pandas-docs/stable/', None), - 'numpy': ('https://docs.scipy.org/doc/numpy/', None), - 'matplotlib': ('http://matplotlib.org/', None), - 'sphinx': ('http://www.sphinx-doc.org/en/stable/', None), - 'xarray': ('http://xarray.pydata.org/en/stable/', None), - 'cartopy': ('http://scitools.org.uk/cartopy/docs/latest/', None), - 'mpl_toolkits': ('http://matplotlib.org/basemap/', None), - 'psyplot': ('https://psyplot.readthedocs.io/en/dev', None), - 'psy_maps': ( - 'https://psyplot.readthedocs.io/projects/psy-maps/en/latest/', None), - 'psy_reg': ('https://psyplot.readthedocs.io/projects/psy-reg/en/latest/', - None), -} -if six.PY3: - intersphinx_mapping['python'] = ('https://docs.python.org/3.7/', None) -else: - intersphinx_mapping['python'] = ('https://docs.python.org/2.7/', None) - - -def group_formatoptions(app, what, name, obj, section, parent): - if inspect.isclass(obj) and issubclass(obj, Formatoption): - return 'Formatoption classes' - elif inspect.isclass(obj) and issubclass(obj, Plotter): - return 'Plotter classes' - elif (inspect.isclass(parent) and issubclass(parent, Plotter) and - isinstance(obj, Formatoption)): - return obj.groupname - - -class PlotterAutoClassDocumenter(AutoSummClassDocumenter): - """A ClassDocumenter that includes all the formatoption of a plotter""" - - priority = AutoSummClassDocumenter.priority + 0.1 - - def filter_members(self, *args, **kwargs): - ret = super(AutoSummClassDocumenter, self).filter_members( - *args, **kwargs) - if issubclass(self.object, Plotter): - fmt_members = defaultdict(set) - all_fmt = set(self.object._get_formatoptions()) - for i, (mname, member, isattr) in enumerate(ret): - if isinstance(member, Formatoption): - fmt_members[member.group].add((mname, member, isattr)) - all_fmt.remove(mname) - for fmt in all_fmt: - fmto = getattr(self.object, fmt) - fmt_members[fmto.group].add((fmt, fmto, True)) - ret.extend( - (tup for tup in chain(*map(sorted, fmt_members.values())) - if tup not in ret)) - return ret - - -def setup(app): - app.add_autodocumenter(PlotterAutoClassDocumenter) - app.connect('autodocsumm-grouper', group_formatoptions) - return {'version': sphinx.__display_version__, 'parallel_read_safe': True} +# 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'] diff --git a/docs/contribute.rst b/docs/contribute.rst index 02bf25c8..933074d1 100644 --- a/docs/contribute.rst +++ b/docs/contribute.rst @@ -3,6 +3,9 @@ Contributing to psy-simple ========================== -First off, thanks for taking the time to contribute! +.. raw:: html -Please see the section about :ref:`contributing to psyplot ` for details. +

+ 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/tests/test-t2m-u-v.nc b/docs/demo.nc similarity index 95% rename from tests/test-t2m-u-v.nc rename to docs/demo.nc index 7594fafc..e6b9dbf8 100644 Binary files a/tests/test-t2m-u-v.nc and b/docs/demo.nc differ diff --git a/docs/environment.yml b/docs/environment.yml deleted file mode 100644 index be2365b8..00000000 --- a/docs/environment.yml +++ /dev/null @@ -1,17 +0,0 @@ -name: psyplot_docs -channels: - - local - - psyplot/label/master - - conda-forge -dependencies: - - python=3.8 - - dask - - netCDF4 - - seaborn - - sphinx - - sphinx_rtd_theme - - psy-simple - - psyplot-gui - - autodocsumm - - sphinx-nbexamples - - pip diff --git a/docs/generated/psyplot.project.plot.barplot.rst b/docs/generated/psyplot.project.plot.barplot.rst new file mode 100644 index 00000000..15d41ef3 --- /dev/null +++ b/docs/generated/psyplot.project.plot.barplot.rst @@ -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/generated/psyplot.project.plot.combined.rst b/docs/generated/psyplot.project.plot.combined.rst new file mode 100644 index 00000000..4451c622 --- /dev/null +++ b/docs/generated/psyplot.project.plot.combined.rst @@ -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/generated/psyplot.project.plot.density.rst b/docs/generated/psyplot.project.plot.density.rst new file mode 100644 index 00000000..ad87abfd --- /dev/null +++ b/docs/generated/psyplot.project.plot.density.rst @@ -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/generated/psyplot.project.plot.fldmean.rst b/docs/generated/psyplot.project.plot.fldmean.rst new file mode 100644 index 00000000..14706e96 --- /dev/null +++ b/docs/generated/psyplot.project.plot.fldmean.rst @@ -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/generated/psyplot.project.plot.lineplot.rst b/docs/generated/psyplot.project.plot.lineplot.rst new file mode 100644 index 00000000..78f60bb0 --- /dev/null +++ b/docs/generated/psyplot.project.plot.lineplot.rst @@ -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/generated/psyplot.project.plot.plot2d.rst b/docs/generated/psyplot.project.plot.plot2d.rst new file mode 100644 index 00000000..ba8f43ee --- /dev/null +++ b/docs/generated/psyplot.project.plot.plot2d.rst @@ -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/generated/psyplot.project.plot.vector.rst b/docs/generated/psyplot.project.plot.vector.rst new file mode 100644 index 00000000..cf85af47 --- /dev/null +++ b/docs/generated/psyplot.project.plot.vector.rst @@ -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/generated/psyplot.project.plot.violinplot.rst b/docs/generated/psyplot.project.plot.violinplot.rst new file mode 100644 index 00000000..38b80d9a --- /dev/null +++ b/docs/generated/psyplot.project.plot.violinplot.rst @@ -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/index.rst b/docs/index.rst index 0bb88f20..0643348c 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,5 +1,5 @@ -.. psy-simple documentation master file, created by - sphinx-quickstart on Mon Jul 20 18:01:33 2015. +.. 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. @@ -8,99 +8,20 @@ psy-simple: The psyplot plugin for simple visualizations ======================================================== -Welcome to the psyplot plugin for simple visualization. This package targets -simple visualization like line plots, 2D plots, bar plots, density plots, etc. -It provides the basics for all the more advanced and specialized plugins like -the psy-maps_ or psy-reg_ plugin. +.. raw:: html -See the :ref:`plot_methods` and :ref:`gallery_examples` for more information. +

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

-.. _psy-maps: http://psyplot.readthedocs.io/projects/psy-maps/ -.. _psy-reg: http://psyplot.readthedocs.io/projects/psy-reg/ - -.. start-badges - -.. only:: html and not epub - - .. list-table:: - :stub-columns: 1 - :widths: 10 90 - - * - docs - - |docs| - * - tests - - |circleci| |appveyor| |requires| |codecov| - * - package - - |version| |conda| |github| |zenodo| - * - implementations - - |supported-versions| |supported-implementations| - - .. |docs| image:: http://readthedocs.org/projects/psy-simple/badge/?version=latest - :alt: Documentation Status - :target: http://psy-simple.readthedocs.io/en/latest/?badge=latest - - .. |circleci| image:: https://circleci.com/gh/psyplot/psy-simple/tree/master.svg?style=svg - :alt: CircleCI - :target: https://circleci.com/gh/psyplot/psy-simple/tree/master - - .. |appveyor| image:: https://ci.appveyor.com/api/projects/status/49u41l2f9k0r4xc0/branch/master?svg=true - :alt: AppVeyor - :target: https://ci.appveyor.com/project/psyplot/psy-simple - - .. |codecov| image:: https://codecov.io/gh/psyplot/psy-simple/branch/master/graph/badge.svg - :alt: Coverage - :target: https://codecov.io/gh/psyplot/psy-simple - - .. |requires| image:: https://requires.io/github/psyplot/psy-simple/requirements.svg?branch=master - :alt: Requirements Status - :target: https://requires.io/github/psyplot/psy-simple/requirements/?branch=master - - .. |version| image:: https://img.shields.io/pypi/v/psy-simple.svg?style=flat - :alt: PyPI Package latest release - :target: https://pypi.python.org/pypi/psy-simple - - .. |conda| image:: https://anaconda.org/conda-forge/psy-simple/badges/version.svg - :alt: conda - :target: https://anaconda.org/conda-forge/psy-simple - - .. |supported-versions| image:: https://img.shields.io/pypi/pyversions/psy-simple.svg?style=flat - :alt: Supported versions - :target: https://pypi.python.org/pypi/psy-simple - - .. |supported-implementations| image:: https://img.shields.io/pypi/implementation/psy-simple.svg?style=flat - :alt: Supported implementations - :target: https://pypi.python.org/pypi/psy-simple - - .. |zenodo| image:: https://zenodo.org/badge/81938204.svg - :alt: Zenodo - :target: https://zenodo.org/badge/latestdoi/81938204 - - .. |github| image:: https://img.shields.io/github/release/psyplot/psy-simple.svg - :target: https://github.com/psyplot/psy-simple/releases/latest - :alt: Latest github release - -.. end-badges - - -Documentation -------------- - .. toctree:: :maxdepth: 1 + :hidden: installing plot_methods - examples/index contribute api/psy_simple changelog - - - -Indices and tables -================== - -* :ref:`genindex` -* :ref:`modindex` -* :ref:`search` diff --git a/docs/installing.rst b/docs/installing.rst index 62d36358..ba568522 100644 --- a/docs/installing.rst +++ b/docs/installing.rst @@ -5,37 +5,9 @@ Installation ============ -How to install --------------- +.. raw:: html -Installation using conda -^^^^^^^^^^^^^^^^^^^^^^^^ -We highly recommend to use conda_ for installing psy-simple. After downloading -the installer from anaconda_, you can install psy-simple simply via:: - - $ conda install -c conda-forge psy-simple - -.. _anaconda: https://www.continuum.io/downloads -.. _conda: http://conda.io/ - -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-simple - -Running the tests ------------------ -First, clone the github_ repository, and install psy-simple and pytest_. Then - -- create the reference figures via:: - - $ pytest --ref - -- run the unittests via:: - - $ pytest - -.. _pytest: https://pytest.org/latest/contents.html -.. _github: https://github.com/psyplot/psy-simple +

+ 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/plot_methods.rst b/docs/plot_methods.rst index 02fec5a9..20a661ea 100644 --- a/docs/plot_methods.rst +++ b/docs/plot_methods.rst @@ -3,24 +3,23 @@ psyplot plot methods ==================== -This plugin defines the following new plot methods for the -:class:`psyplot.project.ProjectPlotter` class. They can, for example, be -accessed through +.. raw:: html -.. ipython:: +

+ 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. +

- In [1]: import psyplot.project as psy - In [2]: psy.plot.lineplot -.. autosummary:: - :toctree: generated +.. toctree:: + :hidden: - ~psyplot.project.plot.lineplot - ~psyplot.project.plot.vector - ~psyplot.project.plot.violinplot - ~psyplot.project.plot.plot2d - ~psyplot.project.plot.combined - ~psyplot.project.plot.density - ~psyplot.project.plot.barplot - ~psyplot.project.plot.fldmean + 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/psy_simple/__init__.py b/psy_simple/__init__.py deleted file mode 100644 index c9329292..00000000 --- a/psy_simple/__init__.py +++ /dev/null @@ -1,46 +0,0 @@ -"""psy-simple: The psyplot plugin for simple visualizations - -This package contains the basic plotters for simple interactive visualization -tasks with the psyplot visualization framework. -""" - -# Disclaimer -# ---------- -# -# Copyright (C) 2021 Helmholtz-Zentrum Hereon -# Copyright (C) 2020-2021 Helmholtz-Zentrum Geesthacht -# Copyright (C) 2016-2021 University of Lausanne -# -# This file is part of psy-simple and is released under the GNU LGPL-3.O license. -# See COPYING and COPYING.LESSER in the root of the repository for full -# licensing details. -# -# This program is free software: you can redistribute it and/or modify -# it under the terms of the GNU Lesser General Public License version 3.0 as -# published by the Free Software Foundation. -# -# 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 LGPL-3.0 license for more details. -# -# You should have received a copy of the GNU LGPL-3.0 license -# along with this program. If not, see . - -__author__ = "Philipp S. Sommer" -__copyright__ = """ -Copyright (C) 2021 Helmholtz-Zentrum Hereon -Copyright (C) 2020-2021 Helmholtz-Zentrum Geesthacht -Copyright (C) 2016-2021 University of Lausanne -""" -__credits__ = ["Philipp S. Sommer"] -__license__ = "LGPL-3.0-only" - -__maintainer__ = "Philipp S. Sommer" -__email__ = "philipp.sommer@hereon.de" - -__status__ = "Production" - -from ._version import get_versions -__version__ = get_versions()['version'] -del get_versions diff --git a/psy_simple/_version.py b/psy_simple/_version.py deleted file mode 100644 index 71f79ed4..00000000 --- a/psy_simple/_version.py +++ /dev/null @@ -1,546 +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.""" - -# Disclaimer -# ---------- -# -# Copyright (C) 2021 Helmholtz-Zentrum Hereon -# Copyright (C) 2020-2021 Helmholtz-Zentrum Geesthacht -# Copyright (C) 2016-2021 University of Lausanne -# -# This file is part of psy-simple and is released under the GNU LGPL-3.O license. -# See COPYING and COPYING.LESSER in the root of the repository for full -# licensing details. -# -# This program is free software: you can redistribute it and/or modify -# it under the terms of the GNU Lesser General Public License version 3.0 as -# published by the Free Software Foundation. -# -# 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 LGPL-3.0 license for more details. -# -# You should have received a copy of the GNU LGPL-3.0 license -# along with this program. If not, see . -# -# This file is originally released into the public domain. Generated by -# versioneer-0.18 (https://github.com/warner/python-versioneer) - -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-simple-" - cfg.versionfile_source = "psy_simple/_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 = {} -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_simple/base.py b/psy_simple/base.py deleted file mode 100644 index fde08da8..00000000 --- a/psy_simple/base.py +++ /dev/null @@ -1,1047 +0,0 @@ -"""Base formatoptions for psy-simple. - -This module defines several formatoptions that are the basis for many -matplotlib figures, such as axes title, figure title, etc. -""" - -# Disclaimer -# ---------- -# -# Copyright (C) 2021 Helmholtz-Zentrum Hereon -# Copyright (C) 2020-2021 Helmholtz-Zentrum Geesthacht -# Copyright (C) 2016-2021 University of Lausanne -# -# This file is part of psy-simple and is released under the GNU LGPL-3.O license. -# See COPYING and COPYING.LESSER in the root of the repository for full -# licensing details. -# -# This program is free software: you can redistribute it and/or modify -# it under the terms of the GNU Lesser General Public License version 3.0 as -# published by the Free Software Foundation. -# -# 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 LGPL-3.0 license for more details. -# -# You should have received a copy of the GNU LGPL-3.0 license -# along with this program. If not, see . - -import six -from abc import abstractmethod -from collections import defaultdict -from itertools import chain -import numpy as np -import inspect -import pandas as pd -import matplotlib.pyplot as plt -from psyplot.docstring import docstrings, safe_modulo, dedent -from psyplot.data import InteractiveList, open_dataset -from psyplot.compat.pycompat import filter -from psyplot.plotter import ( - Plotter, Formatoption, rcParams, START) - -docstrings.params['replace_note'] = inspect.cleandoc(""" - You can insert any meta key from the :attr:`xarray.DataArray.attrs` via a - string like ``'%%(key)s'``. Furthermore there are some special cases: - - - Strings like ``'%%Y'``, ``'%%b'``, etc. will be replaced using the - :meth:`datetime.datetime.strftime` method as long as the data has a time - coordinate and this can be converted to a :class:`~datetime.datetime` - object. - - ``'%%(x)s'``, ``'%%(y)s'``, ``'%%(z)s'``, ``'%%(t)s'`` will be replaced - by the value of the x-, y-, z- or time coordinate (as long as this - coordinate is one-dimensional in the data) - - any attribute of one of the above coordinates is inserted via - ``axis + key`` (e.g. the name of the x-coordinate can be inserted via - ``'%%(xname)s'``). - - Labels defined in the :class:`psyplot.rcParams` ``'texts.labels'`` key - are also replaced when enclosed by '{}'. The standard labels are - - - %s""" % '\n - '.join( - '%s: ``%s``' % tuple(item) for item in six.iteritems( - rcParams['texts.labels']))) - -docstrings.params['colors'] = inspect.cleandoc(""" - The following color abbreviations are supported: - - ========== ======== - character color - ========== ======== - 'b' blue - 'g' green - 'r' red - 'c' cyan - 'm' magenta - 'y' yellow - 'k' black - 'w' white - ========== ======== - - In addition, you can specify colors in many weird and wonderful ways, - including full names (``'green'``), hex strings (``'#008000'``), RGB or - RGBA tuples (``(0,1,0,1)``) or grayscale intensities as a string - (``'0.8'``).""") - -docstrings.params['fontsizes'] = inspect.cleandoc(""" - float - The absolute font size in points (e.g., 12) - string - Strings might be 'xx-small', 'x-small', 'small', 'medium', 'large', - 'x-large', 'xx-large'.""") - - -class TextBase(object): - """Abstract base class for formatoptions that provides a replace method""" - - delimiter = None - - group = 'labels' - - @property - def enhanced_attrs(self): - """The enhanced attributes of the array""" - arr = self.data - return self.get_enhanced_attrs(arr) - - @property - def rc(self): - """:class:`~psyplot.config.rcsetup.SubDict` of rcParams 'texts' key""" - try: - return self._rc - except AttributeError: - return rcParams.find_and_replace(base_str=['texts.']) - - data_dependent = True - - @docstrings.dedent - def replace(self, s, data, attrs=None): - """ - Replace the attributes of the plotter data in a string - - %(replace_note)s - - Parameters - ---------- - s: str - String where the replacements shall be made - data: InteractiveBase - Data object from which to use the coordinates and insert the - coordinate and attribute informations - attrs: dict - Meta attributes that shall be used for replacements. If None, it - will be gained from `data.attrs` - - Returns - ------- - str - `s` with inserted informations""" - # insert labels - s = s.format(**self.rc['labels']) - # replace attributes - attrs = attrs or data.attrs - if hasattr(getattr(data, 'psy', None), 'arr_name'): - attrs = attrs.copy() - attrs['arr_name'] = data.psy.arr_name - s = safe_modulo(s, attrs) - # replace datetime.datetime like time informations - if isinstance(data, InteractiveList): - data = data[0] - tname = self.any_decoder.get_tname( - next(self.plotter.iter_base_variables), data.coords) - if tname is not None and tname in data.coords: - time = data.coords[tname] - if not time.values.ndim: - try: # assume a valid datetime.datetime instance - s = pd.to_datetime(str(time.values[()])).strftime(s) - except ValueError: - pass - if six.PY2: - return s.decode('utf-8') - return s - - def get_fig_data_attrs(self, delimiter=None): - """Join the data attributes with other plotters in the project - - This method joins the attributes of the - :class:`~psyplot.InteractiveBase` instances in the project that - draw on the same figure as this instance does. - - Parameters - ---------- - delimiter: str - Specifies the delimiter with what the attributes are joined. If - None, the :attr:`delimiter` attribute of this instance or (if the - latter is also None), the rcParams['texts.delimiter'] item is used. - - Returns - ------- - dict - A dictionary with all the meta attributes joined by the specified - `delimiter`""" - if self.project is not None: - delimiter = next(filter(lambda d: d is not None, [ - delimiter, self.delimiter, self.rc['delimiter']])) - figs = self.project.figs - fig = self.ax.get_figure() - if self.plotter._initialized and fig in figs: - ret = figs[fig].joined_attrs(delimiter=delimiter, - plot_data=True) - else: - ret = self.get_enhanced_attrs(self.plotter.plot_data) - self.logger.debug( - 'Can not get the figure attributes because plot has not ' - 'yet been initialized!') - return ret - else: - return self.get_enhanced_attrs(self.plotter.plot_data) - - def get_enhanced_attrs(self, *args, **kwargs): - replot = kwargs.pop('replot', False) - if hasattr(self, '_enhanced_attrs') and not ( - self.plotter.replot or replot): - return self._enhanced_attrs - self._enhanced_attrs = self.plotter.get_enhanced_attrs(*args, **kwargs) - return self._enhanced_attrs - - def get_fmt_widget(self, parent, project): - """Create a combobox with the attributes""" - from psy_simple.widgets.texts import LabelWidget - return LabelWidget(parent, self, project) - - -docstrings.params['fontweights'] = inspect.cleandoc(""" - float - a float between 0 and 1000 - string - Possible strings are one of 'ultralight', 'light', 'normal', - 'regular', 'book', 'medium', 'roman', 'semibold', 'demibold', - 'demi', 'bold', 'heavy', 'extra bold', 'black'.""") - - -@docstrings.get_sections(base='label_weight') -@dedent -def label_weight(base, label_name=None, children=[], parents=[], - dependencies=[]): - """ - Function that returns a Formatoption class for modifying the fontweight - - This function returns a :class:`~psyplot.plotter.Formatoption` instance - that modifies the weight of the given `base` formatoption - - Parameters - ---------- - base: Formatoption - The base formatoption instance that is used in the - :class:`psyplot.Plotter` subclass to create the label. The instance - must have a ``texts`` attribute which stores all the - :class:`matplotlib.text.Text` instances. - label_name: str - The name of the label to use in the documentation. If None, - it will be ``key``, where ``key`` is the - :attr:`psyplot.plotter.Formatoption.key`` attribute of `base` - children: list of str - The childrens of the resulting formatoption class (besides the `base` - formatoption which is included anyway) - parents: list of str - The parents of the resulting formatoption class (besides the `base` - the properties formatoption from `base` (see :func:`label_props`)) - dependencies: list of str - The dependencies of the formatoption - - Returns - ------- - Formatoption - The formatoption instance that modifies the fontweight of `base` - - See Also - -------- - label_size, label_props, Figtitle, Title""" - label_name = label_name or base.key - cl_children = children - cl_parents = parents - cl_dependencies = dependencies - - class LabelWeight(Formatoption): - __doc__ = """ - Set the fontweight of the %s - - Possible types - -------------- - %%(fontweights)s - - See Also - -------- - %s, %s, %s""" % (label_name, base.key, base.key + 'size', - base.key + 'props') - children = [base.key] + \ - cl_children - parent = [base.key + 'props'] + cl_parents - dependencies = cl_dependencies - - group = 'labels' - - name = 'Font weight of ' + (base.name or base.key) - - def update(self, value): - for text in getattr(self, base.key).texts: - text.set_weight(value) - - def get_fmt_widget(self, parent, project): - """Get a widget with the different font weights""" - from psy_simple.widgets.texts import FontWeightWidget - return FontWeightWidget( - parent, self, next(iter(getattr(self, base.key).texts), None), - base) - - return LabelWeight(base.key + 'weight') - - -@docstrings.dedent -def label_size(base, label_name=None, children=[], parents=[], - dependencies=[]): - """ - Function that returns a Formatoption class for modifying the fontsite - - This function returns a :class:`~psyplot.plotter.Formatoption` instance - that modifies the size of the given `base` formatoption - - Parameters - ---------- - %(label_weight.parameters)s - - Returns - ------- - Formatoption - The formatoption instance that modifies the fontsize of `base` - - See Also - -------- - label_weight, label_props, Figtitle, Title""" - label_name = label_name or base.key - cl_children = children - cl_parents = parents - cl_dependencies = dependencies - - class LabelSize(Formatoption): - __doc__ = """ - Set the size of the %s - - Possible types - -------------- - %%(fontsizes)s - - See Also - -------- - %s, %s, %s""" % (label_name, base.key, base.key + 'weight', - base.key + 'props') - children = [base.key] + cl_children - parent = [base.key + 'props'] + cl_parents - dependencies = cl_dependencies - - group = 'labels' - - name = 'Font size of ' + (base.name or base.key) - - def update(self, value): - for text in getattr(self, base.key).texts: - text.set_size(value) - - def get_fmt_widget(self, parent, project): - """Get a widget with the different font weights""" - from psy_simple.widgets.texts import FontSizeWidget - return FontSizeWidget( - parent, self, next(iter(getattr(self, base.key).texts), None), - base) - - return LabelSize(base.key + 'size') - - -docstrings.keep_params('label_weight.parameters', 'base', 'label_name') - - -@docstrings.dedent -def label_props(base, label_name=None, children=[], parents=[], - dependencies=[]): - """ - Function that returns a Formatoption class for modifying the fontsite - - This function returns a :class:`~psyplot.plotter.Formatoption` instance - that modifies the size of the given `base` formatoption - - Parameters - ---------- - %(label_weight.parameters)s - children: list of str - The childrens of the resulting formatoption class (besides the `base` - formatoption, the ``base.key + 'size'`` and ``base.key + 'weight'`` - keys, which are included anyway (see :func:`label_size`, - :func:`label_weight`)) - parents: list of str - The parents of the resulting formatoption class - - Returns - ------- - Formatoption - The formatoption instance that modifies the fontsize of `base` - - See Also - -------- - label_weight, label_props, Figtitle, Title""" - label_name = label_name or base.key - cl_children = children - cl_parents = parents - cl_dependencies = dependencies - - class LabelProps(Formatoption): - __doc__ = """ - Properties of the %s - - Specify the font properties of the figure title manually. - - Possible types - -------------- - dict - Items may be any valid text property - - See Also - -------- - %s, %s, %s""" % (label_name, base.key, base.key + 'size', - base.key + 'weight') - children = cl_children - parents = cl_parents - dependencies = [base.key, base.key + 'size', base.key + 'weight'] + \ - cl_dependencies - - group = 'labels' - - name = 'Font properties of ' + (base.name or base.key) - - def __init__(self, *args, **kwargs): - super(LabelProps, self).__init__(*args, **kwargs) - self.default_props = {} - self._todefault = False - - def set_value(self, value, validate=True, todefault=False): - self._todefault = todefault - super(LabelProps, self).set_value(value, validate, todefault) - - def update(self, fontprops): - fontprops = fontprops.copy() - # store default font properties - try: - text = next(iter(getattr(self, base.key).texts)) - except StopIteration: - return - # TODO: This handling of the default management is not really - # satisfying because you run into troubles when using alternate - # property names (e.g. if you use 'ha' and 'horizontalalignment' - # at the same time) - if not self._todefault: - for key in fontprops: - if key == 'bbox': - default = dict(facecolor='none', edgecolor='none') - else: - default = getattr(text, 'get_' + key)() - self.default_props.setdefault(key, default) - else: - fontprops = self.default_props.copy() - self.default_props.clear() - if 'size' not in fontprops and 'fontsize' not in fontprops: - fontprops['size'] = getattr(self, base.key + 'size').value - if 'weight' not in fontprops and 'fontweight' not in fontprops: - fontprops['weight'] = getattr(self, base.key + 'weight').value - for text in getattr(self, base.key).texts: - text.update(fontprops) - self._todefault = False - - def get_fmt_widget(self, parent, project): - """Get a widget with the different font weights""" - from psy_simple.widgets.texts import FontPropertiesWidget - return FontPropertiesWidget( - parent, self, next(iter(getattr(self, base.key).texts), None), - base) - - return LabelProps(base.key + 'props') - - -class Title(TextBase, Formatoption): - """ - Show the title - - Set the title of the plot. - %(replace_note)s - - Possible types - -------------- - str - The title for the :func:`~matplotlib.pyplot.title` function. - - Notes - ----- - This is the title of this specific subplot! For the title of the whole - figure, see the :attr:`figtitle` formatoption. - - See Also - -------- - figtitle, titlesize, titleweight, titleprops""" - - name = 'Axes title' - - def initialize_plot(self, value): - arr = self.data - self.texts = [self.ax.set_title( - self.replace(value, arr, attrs=self.enhanced_attrs))] - - def update(self, value): - arr = self.data - self.texts[0].set_text(self.replace( - value, arr, attrs=self.enhanced_attrs)) - - -class Figtitle(TextBase, Formatoption): - """ - Plot a figure title - - Set the title of the figure. - %(replace_note)s - - Possible types - -------------- - str - The title for the :func:`~matplotlib.pyplot.suptitle` function - - Notes - ----- - - If the plotter is part of a :class:`psyplot.project.Project` and multiple - plotters of this project are on the same figure, the replacement - attributes (see above) are joined by a delimiter. If the - :attr:`delimiter` attribute of this :class:`Figtitle` instance is not - None, it will be used. Otherwise the rcParams['texts.delimiter'] item is - used. - - This is the title of the whole figure! For the title of this specific - subplot, see the :attr:`title` formatoption. - - See Also - -------- - title, figtitlesize, figtitleweight, figtitleprops""" - - name = 'Figure title' - - @property - def enhanced_attrs(self): - return self.get_fig_data_attrs() - - def initialize_plot(self, s): - if s: - self.texts = [self.ax.get_figure().suptitle( - self.replace(s, self.plotter.data, self.enhanced_attrs))] - self.clear_other_texts() - else: - self.texts = [self.ax.get_figure().suptitle('')] - - def update(self, s): - if s: - self.texts[0].set_text(self.replace(s, self.plotter.data, - self.enhanced_attrs)) - self.clear_other_texts() - else: - self.texts[0].set_text('') - - def clear_other_texts(self, remove=False): - """Make sure that no other text is a the same position as this one - - This method clears all text instances in the figure that are at the - same position as the :attr:`_text` attribute - - Parameters - ---------- - remove: bool - If True, the Text instances are permanently deleted from the - figure, otherwise there text is simply set to ''""" - fig = self.ax.get_figure() - # don't do anything if our figtitle is the only Text instance - if len(fig.texts) == 1: - return - for i, text in enumerate(fig.texts): - if text == self._text: - continue - if text.get_position() == self._text.get_position(): - if not remove: - text.set_text('') - else: - del fig[i] - - -class Text(TextBase, Formatoption): - """ - Add text anywhere on the plot - - This formatoption draws a text on the specified position on the figure. - %(replace_note)s - - Possible types - -------------- - str - If string s: this will be used as (1., 1., s, {'ha': 'right'}) (i.e. a - string in the upper right corner of the axes). - tuple or list of tuples (x,y,s[,coord.-system][,options]]) - Each tuple defines a text instance on the plot. 0<=x, y<=1 are the - coordinates. The coord.-system can be either the data coordinates - (default, ``'data'``) or the axes coordinates (``'axes'``) or the - figure coordinates ('fig'). The string s finally is the text. options - may be a dictionary to specify format the appearence (e.g. ``'color'``, - ``'fontweight'``, ``'fontsize'``, etc., see - :class:`matplotlib.text.Text` for possible keys). - To remove one single text from the plot, set (x,y,''[, coord.-system]) - for the text at position (x,y) - empty list - remove all texts from the plot - - See Also - -------- - title, figtitle""" - - name = 'Arbitrary text on the plot' - - @property - def transform(self): - """Dictionary containing the relevant transformations""" - ax = self.ax - return {'axes': ax.transAxes, - 'fig': ax.get_figure().transFigure, - 'data': ax.transData} - - def __init__(self, *args, **kwargs): - Formatoption.__init__(self, *args, **kwargs) - #: texts that shall be removed when updating - self._texts_to_remove = set() - #: :class:`matplotlib.texts.Text` instances on the figure - self._texts = defaultdict(set) - - def _remove_texttuple(self, pos): - """Remove a texttuple from the value in the plotter - - Parameters - ---------- - pos: tuple (x, y, cs) - x and y are the x- and y-positions and cs the coordinate system""" - for i, (old_x, old_y, s, old_cs, d) in enumerate(self.value): - if (old_x, old_y, old_cs) == pos: - self.value.pop(i) - return - raise ValueError("{0} not found!".format(pos)) - - def _update_texttuple(self, x, y, s, cs, d): - """Update the text tuple at `x` and `y` with the given `s` and `d`""" - pos = (x, y, cs) - for i, (old_x, old_y, old_s, old_cs, old_d) in enumerate(self.value): - if (old_x, old_y, old_cs) == pos: - self.value[i] = (old_x, old_y, s, old_cs, d) - return - raise ValueError("No text tuple found at {0}!".format(pos)) - - def set_value(self, value, validate=True, todefault=False): - value = self.validate(value) if validate else value - # mark all texts for removing if value is empty - if not value or todefault: - with self.plotter.no_validation: - self.plotter[self.key] = [] - for cs, texts in self._texts.items(): - for t in texts: - pos = t.get_position() - self._texts_to_remove.add((pos[0], pos[1], cs)) - - # loop through texttuples to see whether one changed or has to be - # removed. x: x-coord, y: y-coord, s: string, cs: coord.-system, - # d: text params dictionary - for x, y, s, cs, d in value: - if not s: - try: - self._remove_texttuple((x, y, cs)) - self._texts_to_remove.add((x, y, cs)) - except ValueError: - pass - else: - try: - self._update_texttuple(x, y, s, cs, d) - except ValueError: - self.value.append((x, y, s, cs, d)) - - def update(self, value, texts_to_remove=None): - # remove texts - for (x, y, cs) in texts_to_remove or self._texts_to_remove: - for t in self._texts[cs]: - if (x, y) == t.get_position(): - self._texts[cs].remove(t) - t.remove() - break - if self.plotter.replot: - value = self.value + value - # now update the old texts or create new ones - for x, y, s, cs, d in value: - if cs == 'fig': - s = self.replace( - s, self.plotter.data, self.get_fig_data_attrs( - d.pop('delimiter', None))) - else: - s = self.replace(s, self.plotter.data, self.enhanced_attrs) - found = False - for t in self._texts[cs]: - if (x, y) == t.get_position(): - t.set_text(s) - t.update(d.copy()) - found = True - break - if not found: - self._texts[cs].add(self.ax.text( - x, y, s, d.copy(), transform=self.transform[cs])) - - def share(self, fmto, **kwargs): - """Share the settings of this formatoption with other data objects - - Parameters - ---------- - fmto: Formatoption - The :class:`Formatoption` instance to share the attributes with - ``**kwargs`` - Any other keyword argument that shall be passed to the update - method of `fmto` - - Notes - ----- - The Text formatoption sets the 'texts_to_remove' keyword to the - :attr:`_texts_to_remove` attribute of this instance (if not already - specified in ``**kwargs``""" - kwargs.setdefault('texts_to_remove', self._texts_to_remove) - super(Text, self).share(fmto, **kwargs) - - def diff(self, value): - my_value = self.value - return (not len(value) and len(my_value)) or any( - val not in my_value for val in value) - - def finish_update(self): - """Clears the :attr:`_texts_to_remove` set""" - self._texts_to_remove.clear() - - def remove(self): - for t in chain.from_iterable(six.itervalues(self._texts)): - t.remove() - self._texts.clear() - - -class Tight(Formatoption): - """ - Automatically adjust the plots. - - If set to True, the plots are automatically adjusted to fit to the figure - limitations via the :func:`matplotlib.pyplot.tight_layout()` function. - - Possible types - -------------- - bool - True for automatic adjustment - - Warnings - -------- - There is no update method to undo what happend after this formatoption is - set to True!""" - - group = 'axes' - - name = 'Tight layout' - - def update(self, value): - if value: - plt.sca(self.ax) - plt.tight_layout() - - -class BackgroundColor(Formatoption): - """The background color for the matplotlib axes. - - Possible types - -------------- - 'rc' - to use matplotlibs rc params - None - to use a transparent color - color - Any possible matplotlib color - """ - - group = 'axes' - - name = 'Background color of the plot' - - def update(self, value): - if value == 'rc': - self.ax.patch.set_facecolor(plt.rcParams['axes.facecolor']) - self.ax.set_facecolor(plt.rcParams['axes.facecolor']) - elif value is None: - self.ax.patch.set_facecolor('none') - self.ax.set_facecolor('none') - else: - self.ax.patch.set_facecolor(value) - self.ax.set_facecolor(value) - - def get_fmt_widget(self, parent, project): - from psy_simple.widgets.colors import BackGroundColorWidget - return BackGroundColorWidget(parent, self, project) - - -class ValueMaskBase(Formatoption): - """Base class for masking formatoptions""" - priority = START - - group = 'masking' - - data_dependent = True - - @abstractmethod - def mask_func(self): - """The masking function that is called""" - return - - def update(self, value): - if value is None: - pass - else: - for i, data in enumerate(self.iter_data): - self.set_data(self._mask_data(data, value), i) - - def _mask_data(self, data, value): - data = data.copy(data=np.copy(data.values)) - data.values[~np.isnan(data.values)] = self.mask_func( - data.values[~np.isnan(data.values)], value) - return data - - -class MaskLess(ValueMaskBase): - """ - Mask data points smaller than a number - - Possible types - -------------- - float - The floating number to mask below - - See Also - -------- - maskleq, maskgreater, maskgeq, maskbetween - """ - - name = 'Mask less' - - def mask_func(self, data, value): - data[data < value] = np.nan - return data - - -class MaskLeq(ValueMaskBase): - """ - Mask data points smaller than or equal to a number - - Possible types - -------------- - float - The floating number to mask below - - See Also - -------- - maskless, maskgreater, maskgeq, maskbetween - """ - - name = 'Mask lesser than or equal' - - def mask_func(self, data, value): - data[data <= value] = np.nan - return data - - -class MaskGreater(ValueMaskBase): - """ - Mask data points greater than a number - - Possible types - -------------- - float - The floating number to mask above - - See Also - -------- - maskless, maskleq, maskgeq, maskbetween - """ - - name = 'Mask greater' - - def mask_func(self, data, value): - data[data > value] = np.nan - return data - - -class MaskGeq(ValueMaskBase): - """ - Mask data points greater than or equal to a number - - Possible types - -------------- - float - The floating number to mask above - - See Also - -------- - maskless, maskleq, maskgreater, maskbetween - """ - - name = 'Mask greater than or equal' - - def mask_func(self, data, value): - data[data >= value] = np.nan - return data - - -class MaskBetween(ValueMaskBase): - """ - Mask data points between two numbers - - Possible types - -------------- - float - The floating number to mask above - - See Also - -------- - maskless, maskleq, maskgreater, maskgeq - """ - - name = 'Mask between two values' - - def mask_func(self, data, value): - data[np.all([data >= value[0], data <= value[1]], axis=0)] = np.nan - return data - - -class Mask(Formatoption): - """Mask the data where a certain condition is True - - This formatoption can be used to mask the plotting data based on another - array. This array can be the name of a variable in the base dataset, - or it can be a numeric array. Note that the data needs to be on exactly - the same coordinates as the data shown here - - Possible types - -------------- - None - Apply no mask - str - The name of a variable in the base dataset to use. - - - dimensions that are in the given `mask` but not in the visualized - base variable will be aggregated using :func:`numpy.any` - - if the given `mask` misses dimensions that are in the visualized - data (i.e. the data of this plotter), we broadcast the `mask` to - match the shape of the data - - dimensions that are in `mask` and the base variable, but not in the - visualized data will be matched against each other - str - The path to a netCDF file that shall be loaded - xr.DataArray or np.ndarray - An array that can be broadcasted to the shape of the data - """ - - priority = START - - group = 'masking' - - name = "Apply a mask" - - def update(self, value): - if value is None: - return - for i, data in enumerate(self.iter_data): - mask = self.load_mask(data, value) - new_data = data.where(mask.astype(bool)) - new_data.psy.base = data.psy.base - new_data.psy.idims = data.psy.idims - self.set_data(new_data, i) - - def diff(self, value): - try: - return bool(self.value != value) - except ValueError: - if hasattr(value, 'shape') and hasattr(self.value, 'shape'): - return ((value.shape != self.value.shape) | - (value != self.value).any()) - else: - return True - - def load_mask(self, data, value): - if isinstance(value, str) and value in data.psy.base: - mask = data.psy.base[value] - if not set(mask.dims).intersection(data.dims): - raise ValueError("No intersection between dimensions of mask " - f"{value}: {mask.dims}, and the data: " - f"{data.dims}") - elif isinstance(value, str): - try: - mask = open_dataset(value) - except Exception: - raise ValueError( - f"{value} is not in the base dataset of " - f"{data.psy.arr_name} and could not be loaded with " - f"psy.open_dataset({repr(value)})") - else: - available_vars = [ - v for v in mask - if set(mask[v].dims).intersection(data.dims)] - if not available_vars: - raise ValueError(f"No variable in {value} has an overlap " - f"with the data dimensions {data.dims}") - else: - mask = mask[available_vars[0]] - else: - mask = value - base_var = next(data.psy.iter_base_variables) - - # aggregate mask over dimensions that are not in the base variable - dims2agg = set(mask.dims).difference(set(base_var.dims)) - if dims2agg: - mask = mask.any(list(dims2agg)) - - # select idims of mask - idims = {d: sl for d, sl in data.psy.idims.items() - if d in mask.dims and d not in data.dims} - if idims: - mask = mask.isel(**idims) - - return mask - - -class TitlesPlotter(Plotter): - """Plotter class for labels""" - _rcparams_string = ['plotter.baseplotter.'] - title = Title('title') - titlesize = label_size(title) - titleweight = label_weight(title) - titleprops = label_props(title) - figtitle = Figtitle('figtitle') - figtitlesize = label_size(figtitle, 'figure title') - figtitleweight = label_weight(figtitle, 'figure title') - figtitleprops = label_props(figtitle, 'figure title') - text = Text('text') - - -class BasePlotter(TitlesPlotter): - """Base class with formatoptions for plotting on an matplotlib axes""" - _rcparams_string = ['plotter.baseplotter.'] - - tight = Tight('tight') - background = BackgroundColor('background') - maskless = MaskLess('maskless') - maskleq = MaskLeq('maskleq') - maskgreater = MaskGreater('maskgreater') - maskgeq = MaskGeq('maskgeq') - maskbetween = MaskBetween('maskbetween') - mask = Mask('mask') diff --git a/psy_simple/colors.py b/psy_simple/colors.py deleted file mode 100644 index ab86c385..00000000 --- a/psy_simple/colors.py +++ /dev/null @@ -1,309 +0,0 @@ -# -*- coding: utf-8 -*- -"""colors module of the psyplot package. - -This module contains some additional color maps and the show_colormaps -function to visualize available colormaps. -""" - -# Disclaimer -# ---------- -# -# Copyright (C) 2021 Helmholtz-Zentrum Hereon -# Copyright (C) 2020-2021 Helmholtz-Zentrum Geesthacht -# Copyright (C) 2016-2021 University of Lausanne -# -# This file is part of psy-simple and is released under the GNU LGPL-3.O license. -# See COPYING and COPYING.LESSER in the root of the repository for full -# licensing details. -# -# This program is free software: you can redistribute it and/or modify -# it under the terms of the GNU Lesser General Public License version 3.0 as -# published by the Free Software Foundation. -# -# 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 LGPL-3.0 license for more details. -# -# You should have received a copy of the GNU LGPL-3.0 license -# along with this program. If not, see . - -import six -import matplotlib as mpl -from matplotlib.colors import Colormap, LinearSegmentedColormap, BoundaryNorm -from matplotlib.cm import get_cmap as mpl_get_cmap -import numpy as np -from difflib import get_close_matches -from itertools import chain -from warnings import warn -from psyplot.docstring import docstrings -from psyplot import rcParams -from psyplot.data import safe_list -import psyplot - - -_cmapnames = { # names of self defined colormaps (see get_cmap function below) - 'red_white_blue': [ # symmetric water fluxes - (1, 0, 0), (1, 0.5, 0), (1, 1, 0), (1, 1., 1), - (0, 1, 1), (0, 0.5, 1), (0, 0, 1)], - 'blue_white_red': [ # symmetric temperature - (0, 0, 1), (0, 0.5, 1), (0, 1, 1), (1, 1., 1), - (1, 1, 0), (1, 0.5, 0), (1, 0, 0)], - 'white_blue_red': [ # temperature - (1, 1., 1), (0, 0, 1), (0, 1, 1), (1, 1, 0), (1, 0, 0)], - 'white_red_blue': [ # water fluxes - (1, 1., 1), (1, 0, 0), (1, 1, 0), (0, 1, 1), (0, 0, 1)], - 'rwb': [ - (1, 0, 0), (1, 1., 1), (0, 0, 1)], - 'wrb': [ - (1, 1., 1), (1, 0, 0), (0, 0, 1)], - 'wbr': [ - (1, 1., 1), (0, 0, 1), (1, 0, 0)] - } -for key, val in list(_cmapnames.items()): - _cmapnames[key + '_r'] = val[::-1] - -_color_array = np.linspace(0, 1, 256, endpoint=True) - -_cmapnames['w_RdBu'] = np.append( - [[1., 1., 1., 1.]], mpl_get_cmap('RdBu')(_color_array), axis=0) -_cmapnames['w_RdBu_r'] = np.append( - [[1., 1., 1., 1.]], mpl_get_cmap('RdBu_r')(_color_array), axis=0) - -_cmapnames['w_Reds'] = np.append( - [[1., 1., 1., 1.]], mpl_get_cmap('Reds')(_color_array), axis=0) - -_cmapnames['w_Blues'] = np.append( - [[1., 1., 1., 1.]], mpl_get_cmap('Blues')(_color_array), axis=0) - -_cmapnames['w_Greens'] = np.append( - [[1., 1., 1., 1.]], mpl_get_cmap('Greens')(_color_array), axis=0) - - -docstrings.params['cmap_note'] = """ - Strings may be any valid colormap name suitable for the - :func:`matplotlib.cm.get_cmap` function or one of the color lists - defined in the 'colors.cmaps' key of the :attr:`psyplot.rcParams` - dictionary (including their reversed color maps given via the '_r' - extension).""" - - -class FixedColorMap(LinearSegmentedColormap): - """Bug fixing colormap with same functionality as matplotlibs colormap - - This class fixes a bug in the - :meth:`cartopy.mpl.geoaxes.GeoAxes.streamplot` method in python 3.4 - - Notes - ----- - To reproduce the error type in python 3.4:: - - >>> import cartopy.crs as ccrs - >>> import matplotlib.pyplot as plt - >>> import psyplot.project as psy - >>> maps = psy.plot.mapvector( - ... 'test-t2m-u-v.nc', name=[['u', 'v']], plot='stream', - ... lonlatbox='Europe', color='absolute') - >>> plotter = maps[0].plotter - >>> x, y, u, v = plotter.plot._get_data() - >>> maps.close(True, True) - >>> ax = plt.axes(projection=ccrs.PlateCarree()) - >>> ax.set_extent(plotter.lonlatbox.lonlatbox, crs=ccrs.PlateCarree()) - >>> m = ax.streamplot(x, y, u, v, density=[1.0, 1.0], - ... color=plotter.plot._kwargs['color'], - ... norm=plotter.plot._kwargs['norm']) - - This raises in matplotlib.colors, line 557, in - :meth:`matplotlib.colors.Colormap.__call__`:: - - ``xa = np.array([X])`` - ValueError: setting an array element with a sequence. - """ - - if six.PY3: - def __call__(self, X, *args, **kwargs): - if isinstance(X, np.ma.core.MaskedArray) and X.ndim == 0: - X = np.array(np.nan) - return super(FixedColorMap, self).__call__(X, *args, **kwargs) - - @staticmethod - def from_list(*args, **kwargs): - cmap = LinearSegmentedColormap.from_list(*args, **kwargs) - return FixedColorMap(cmap.name, cmap._segmentdata, cmap.N, - cmap._gamma) - - -class FixedBoundaryNorm(BoundaryNorm): - """Bug fixing Norm with same functionality as matplotlibs BoundaryNorm - - This class fixes a bug in the - :meth:`cartopy.mpl.geoaxes.GeoAxes.streamplot` for matplotlib version 1.5 - - Notes - ----- - To reproduce the error type:: - - >>> import cartopy.crs as ccrs - >>> import matplotlib.pyplot as plt - >>> import psyplot.project as psy - >>> import matplotlib.colors as mcol - >>> maps = psy.plot.mapvector( - ... 'test-t2m-u-v.nc', name=[['u', 'v']], plot='stream', - ... lonlatbox='Europe', color='absolute') - >>> plotter = maps[0].plotter - >>> x, y, u, v = plotter.plot._get_data() - >>> maps.close(True, True) - >>> ax = plt.axes(projection=ccrs.PlateCarree()) - >>> ax.set_extent(plotter.lonlatbox.lonlatbox, crs=ccrs.PlateCarree()) - >>> m = ax.streamplot( - ... x, y, u, v, color=plotter.plot._kwargs['color'], - ... norm=mcol.BoundaryNorm(plotter.bounds.norm.boundaries, - ... plotter.bounds.norm.Ncmap, - ... plotter.bounds.norm.clip), - ... density=[1.0, 1.0]) - - This raises in matplotlib.colors, line 1316, in - :meth:`matplotlib.colors.BoundaryNorm.__call__`:: - - ``ret = int(ret[0]) # assume python scalar`` - MaskError: Cannot convert masked element to a Python int. - """ - - if mpl.__version__ > '1.4': - def __call__(self, value, clip=None): - if isinstance(value, np.ma.core.MaskedConstant): - return value - return super(FixedBoundaryNorm, self).__call__(value, clip=clip) - - -@docstrings.dedent -def get_cmap(name, lut=None): - """ - Returns the specified colormap. - - Parameters - ---------- - name: str or :class:`matplotlib.colors.Colormap` - If a colormap, it returned unchanged. - %(cmap_note)s - lut: int - An integer giving the number of entries desired in the lookup table - - Returns - ------- - matplotlib.colors.Colormap - The colormap specified by `name` - - See Also - -------- - show_colormaps: A function to display all available colormaps - - Notes - ----- - Different from the :func::`matpltolib.pyplot.get_cmap` function, this - function changes the number of colors if `name` is a - :class:`matplotlib.colors.Colormap` instance to match the given `lut`.""" - if name in rcParams['colors.cmaps']: - colors = rcParams['colors.cmaps'][name] - lut = lut or len(colors) - return FixedColorMap.from_list(name=name, colors=colors, N=lut) - elif name in _cmapnames: - colors = _cmapnames[name] - lut = lut or len(colors) - return FixedColorMap.from_list(name=name, colors=colors, N=lut) - else: - cmap = mpl_get_cmap(name) - # Note: we could include the `lut` in the call of mpl_get_cmap, but - # this raises a ValueError for colormaps like 'viridis' in mpl version - # 1.5. Besides the mpl_get_cmap function does not modify the lut if - # it does not match - if lut is not None and cmap.N != lut: - cmap = FixedColorMap.from_list( - name=cmap.name, colors=cmap(np.linspace(0, 1, lut)), N=lut) - return cmap - - -def _get_cmaps(names): - """Filter the given `names` for colormaps""" - import matplotlib.pyplot as plt - available_cmaps = list( - chain(plt.cm.cmap_d, _cmapnames, rcParams['colors.cmaps'])) - names = safe_list(names) - wrongs = [] - for arg in (arg for arg in names if (not isinstance(arg, Colormap) and - arg not in available_cmaps)): - if isinstance(arg, str): - similarkeys = get_close_matches(arg, available_cmaps) - if similarkeys != []: - warn("Colormap %s not found in standard colormaps.\n" - "Similar colormaps are %s." % (arg, ', '.join(similarkeys))) - else: - warn("Colormap %s not found in standard colormaps.\n" - "Run function without arguments to see all colormaps" % arg) - names.remove(arg) - wrongs.append(arg) - if not names and not wrongs: - names = sorted(m for m in available_cmaps if not m.endswith("_r")) - return names - - -@docstrings.get_sections(base='show_colormaps') -@docstrings.dedent -def show_colormaps(names=[], N=10, show=True, use_qt=None): - """Function to show standard colormaps from pyplot - - Parameters - ---------- - ``*args``: str or :class:`matplotlib.colors.Colormap` - If a colormap, it returned unchanged. - %(cmap_note)s - N: int, optional - Default: 11. The number of increments in the colormap. - show: bool, optional - Default: True. If True, show the created figure at the end with - pyplot.show(block=False) - use_qt: bool - If True, use the - :class:`psy_simple.widgets.color.ColormapDialog.show_colormaps`, if - False use a matplotlib implementation based on [1]_. If None, use - the Qt implementation if it is running in the psyplot GUI. - - Returns - ------- - psy_simple.widgets.color.ColormapDialog or matplitlib.figure.Figure - Depending on `use_qt`, either an instance of the - :class:`psy_simple.widgets.color.ColormapDialog` or the - :class:`matplotlib.figure.Figure` - - References - ---------- - .. [1] http://matplotlib.org/1.2.1/examples/pylab_examples/show_colormaps.html - """ - names = safe_list(names) - if use_qt or (use_qt is None and psyplot.with_gui): - from psy_simple.widgets.colors import ColormapDialog - from psyplot_gui.main import mainwindow - return ColormapDialog.show_colormap(names, N, show, parent=mainwindow) - import matplotlib.pyplot as plt - # This example comes from the Cookbook on www.scipy.org. According to the - # history, Andrew Straw did the conversion from an old page, but it is - # unclear who the original author is. - a = np.vstack((np.linspace(0, 1, 256).reshape(1, -1))) - # Get a list of the colormaps in matplotlib. Ignore the ones that end with - # '_r' because these are simply reversed versions of ones that don't end - # with '_r' - cmaps = _get_cmaps(names) - nargs = len(cmaps) + 1 - fig = plt.figure(figsize=(5, 10)) - fig.subplots_adjust(top=0.99, bottom=0.01, left=0.2, right=0.99) - for i, m in enumerate(cmaps): - ax = plt.subplot(nargs, 1, i+1) - plt.axis("off") - plt.pcolormesh(a, cmap=get_cmap(m, N + 1)) - pos = list(ax.get_position().bounds) - fig.text(pos[0] - 0.01, pos[1], m, fontsize=10, - horizontalalignment='right') - fig.canvas.set_window_title("Figure %i: Predefined colormaps" % fig.number) - if show: - plt.show(block=False) - return fig diff --git a/psy_simple/plotters.py b/psy_simple/plotters.py deleted file mode 100644 index fd65883a..00000000 --- a/psy_simple/plotters.py +++ /dev/null @@ -1,6162 +0,0 @@ -"""Plotters and formatoptions for the psy-simple plugin.""" - -# Disclaimer -# ---------- -# -# Copyright (C) 2021 Helmholtz-Zentrum Hereon -# Copyright (C) 2020-2021 Helmholtz-Zentrum Geesthacht -# Copyright (C) 2016-2021 University of Lausanne -# -# This file is part of psy-simple and is released under the GNU LGPL-3.O license. -# See COPYING and COPYING.LESSER in the root of the repository for full -# licensing details. -# -# This program is free software: you can redistribute it and/or modify -# it under the terms of the GNU Lesser General Public License version 3.0 as -# published by the Free Software Foundation. -# -# 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 LGPL-3.0 license for more details. -# -# You should have received a copy of the GNU LGPL-3.0 license -# along with this program. If not, see . - -import six -import re -from warnings import warn -from psyplot.warning import PsyPlotRuntimeWarning -from abc import abstractproperty, abstractmethod -from functools import partial -from itertools import chain, starmap, cycle, islice, repeat -from pandas import ( - date_range, to_datetime, DatetimeIndex, to_timedelta, MultiIndex) -import weakref -from pandas.tseries import offsets -import xarray as xr -import matplotlib as mpl -import matplotlib.axes -from matplotlib.ticker import FormatStrFormatter, FixedLocator, FixedFormatter -from matplotlib.dates import DateFormatter, AutoDateFormatter -import matplotlib.colors as mcol -import numpy as np -from psyplot.docstring import docstrings, dedent -from psyplot.plotter import ( - Plotter, Formatoption, BEFOREPLOTTING, DictFormatoption, END, rcParams, - START) -from psy_simple.base import ( - BasePlotter, TextBase, label_size, label_weight, label_props, MaskLess, - MaskGreater, MaskBetween, MaskLeq, MaskGeq, Mask) -from psy_simple.colors import get_cmap -from psyplot.data import ( - InteractiveList, isstring, CFDecoder, _infer_interval_breaks) -from psyplot.compat.pycompat import map, zip, range -from psy_simple.plugin import ( - validate_color, validate_float, safe_list as slist) -from psyplot.utils import is_iterable - - -def _get_index_vals(index): - if (isinstance(index, MultiIndex) and - len(index.names) == 1): - return index.get_level_values(0).values - else: - return index.values - - -mpl_version = float('.'.join(mpl.__version__.split('.')[:2])) - - -def round_to_05(n, exp=None, mode='s'): - """ - Round to the next 0.5-value. - - This function applies the round function `func` to round `n` to the - next 0.5-value with respect to its exponent with base 10 (i.e. - 1.3e-4 will be rounded to 1.5e-4) if `exp` is None or with respect - to the given exponent in `exp`. - - Parameters - ---------- - n: numpy.ndarray - number to round - exp: int or numpy.ndarray - Exponent for rounding. If None, it will be computed from `n` to be the - exponents for base 10. - mode: {'s', 'l'} - rounding mode. If 's', it will be rounded to value whose absolute - value is below `n`, if 'l' it will rounded to the value whose absolute - value is above `n`. - - Returns - ------- - numpy.ndarray - rounded `n` - - Examples - -------- - The effects of the different parameters are show in the example below:: - - >>> from psyplot.plotter.simple import round_to_05 - >>> a = [-100.3, 40.6, 8.7, -0.00023] - >>>round_to_05(a, mode='s') - array([ -1.00000000e+02, 4.00000000e+01, 8.50000000e+00, - -2.00000000e-04]) - - >>> round_to_05(a, mode='l') - array([ -1.50000000e+02, 4.50000000e+01, 9.00000000e+00, - -2.50000000e-04])""" - n = np.asarray(n) - if exp is None: - exp = np.floor(np.log10(np.abs(n))) # exponent for base 10 - ntmp = np.abs(n)/10.**exp # mantissa for base 10 - if mode == 's': - n1 = ntmp - s = 1. - n2 = nret = np.floor(ntmp) - else: - n1 = nret = np.ceil(ntmp) - s = -1. - n2 = ntmp - return np.where(n1 - n2 > 0.5, np.sign(n)*(nret + s*0.5)*10.**exp, - np.sign(n)*nret*10.**exp) - - -def convert_radian(coord, *variables): - """Convert the given coordinate from radian to degree - - Parameters - ---------- - coord: xr.Variable - The variable to transform - ``*variables`` - The variables that are on the same unit. - - Returns - ------- - xr.Variable - The transformed variable if one of the given `variables` has units in - radian""" - if any(v.attrs.get('units', '').startswith('radian') for v in variables): - return coord * 180. / np.pi - return coord - - -class AlternativeXCoord(Formatoption): - """ - Use an alternative variable as x-coordinate - - This formatoption let's you specify another variable in the base dataset - of the data array in case you want to use this as the x-coordinate instead - of the raw data - - Possible types - -------------- - None - Use the default - str - The name of the variable to use in the base dataset - xarray.DataArray - An alternative variable with the same shape as the displayed array - - Examples - -------- - To see the difference, we create a simple test dataset:: - - >>> import xarray as xr - - >>> import numpy as np - - >>> import psyplot.project as psy - - >>> ds = xr.Dataset({ - ... 'temp': xr.Variable(('time', ), np.arange(5)), - ... 'std': xr.Variable(('time', ), np.arange(5, 10))}) - >>> ds - - Dimensions: (time: 5) - Coordinates: - * time (time) int64 0 1 2 3 4 - Data variables: - temp (time) int64 0 1 2 3 4 - std (time) int64 5 6 7 8 9 - - If we create a plot with it, we get the ``'time'`` dimension on the - x-axis:: - - >>> plotter = psy.plot.lineplot(ds, name=['temp']).plotters[0] - - >>> plotter.plot_data[0].dims - ('time',) - - If we however set the ``'coord'`` keyword, we get:: - - >>> plotter = psy.plot.lineplot( - ... ds, name=['temp'], coord='std').plotters[0] - - >>> plotter.plot_data[0].dims - ('std',) - - and ``'std'`` is plotted on the x-axis.""" - - name = 'Alternative X-Variable' - - group = 'data' - - priority = START - - data_dependent = True - - #: Bool. If True, this Formatoption directly uses the raw_data, otherwise - #: use the normal data - use_raw_data = True - - @property - def data_iterator(self): - return self.iter_raw_data if self.use_raw_data else self.iter_data - - def update(self, value): - if value is not None: - for i, da in enumerate(self.data_iterator): - self.set_data(self.replace_coord(i), i) - - def diff(self, value): - try: - return ~((np.shape(value) == np.shape(self.value)) & - np.all(value == self.value)) - except TypeError: - return True - - def replace_coord(self, i): - """Replace the coordinate for the data array at the given position - - Parameters - ---------- - i: int - The number of the data array in the raw data (if the raw data is - not an interactive list, use 0) - - Returns - xarray.DataArray - The data array with the replaced coordinate""" - da = next(islice(self.data_iterator, i, i+1)) - name, coord = self.get_alternative_coord(da, i) - other_coords = {key: da.coords[key] - for key in set(da.coords).difference(da.dims)} - ret = da.rename({da.dims[-1]: name}).assign_coords( - **{name: coord}).assign_coords(**other_coords) - return ret - - def get_alternative_coord(self, da, i): - if isinstance(self.value, xr.DataArray): - return self.value.name, self.value.variable - alternative_name = next(islice(cycle(slist(self.value)), i, i+1)) - coord_da = InteractiveList.from_dataset( - da.psy.base, name=alternative_name, dims=da.psy.idims)[0] - coord = xr.Variable((coord_da.name, ), coord_da, coord_da.attrs) - return coord_da.name, coord - - -class AlternativeXCoordPost(AlternativeXCoord): - # The same as the :class:`AlternativeXCoord, but it uses the - # :attr:`psyplot.plotter.Formatoption.data` attribute as a src, not the - # :attr:`psyplot.plotter.Formatoption.raw_data` - - __doc__ = AlternativeXCoord.__doc__ - - use_raw_data = False - - -class Grid(Formatoption): - """ - Display the grid - - Show the grid on the plot with the specified color. - - - Possible types - -------------- - None - If the grid is currently shown, it will not be displayed any longer. If - the grid is not shown, it will be drawn - bool - If True, the grid is displayed with the automatic settings (usually - black) - string, tuple. - Defines the color of the grid. - - Notes - ----- - %(colors)s""" - - group = 'axes' - - name = 'Grid lines' - - def update(self, value): - if self.plotter._initialized and mpl_version == 3.3: - warn("Updating grids is known to malfunction for matplotlib 3.3!") - try: - value = validate_color(value) - self.ax.grid(color=value) - except (ValueError, TypeError, AttributeError): - self.ax.grid(value) - - -class AxisColor(DictFormatoption): - """ - Color the x- and y-axes - - This formatoption colors the left, right, bottom and top axis bar. - - Possible types - -------------- - dict - Keys may be one of {'right', 'left', 'bottom', 'top'}, the values can - be any valid color or None. - - Notes - ----- - %(colors)s""" - - group = 'axes' - - name = 'Color of x- and y-axes' - - @property - def value2pickle(self): - """Return the current axis colors""" - return {key: s.get_edgecolor() for key, s in self.ax.spines.items()} - - def initialize_plot(self, value): - positions = ['right', 'left', 'bottom', 'top'] - #: :class:`dict` storing the default linewidths - self.default_lw = dict(zip(positions, map( - lambda pos: self.ax.spines[pos].get_linewidth(), positions))) - self.update(value) - - def update(self, value): - for pos, color in six.iteritems(value): - spine = self.ax.spines[pos] - spine.set_color(color) - if color is not None and spine.get_linewidth() == 0.0: - spine.set_linewidth(1.0) - elif color is None: - spine.set_color(mpl.rcParams['axes.edgecolor']) - spine.set_linewidth(self.default_lw[pos]) - - -class TicksManagerBase(Formatoption): - """ - Abstract base class for formatoptions handling ticks""" - - @abstractmethod - def update_axis(self, val): - pass - - -@docstrings.get_sections(base='TicksManager') -class TicksManager(TicksManagerBase, DictFormatoption): - """ - Abstract base class for ticks formatoptions controlling major and minor - ticks - - This formatoption simply serves as a base that allows the simultaneous - managment of major and minor ticks - - Possible types - -------------- - dict - A dictionary with the keys ``'minor'`` and (or) ``'major'`` to specify - which ticks are managed. If the given value is not a dictionary with - those keys, it is put into a dictionary with the key determined by the - rcParams ``'ticks.which'`` key (usually ``'major'``). - The values in the dictionary can be one types below.""" - - group = 'ticks' - - def update(self, value): - for which, val in six.iteritems(value): - self.which = which - self.update_axis(val) - - -@docstrings.get_sections(base='DataTicksCalculator') -class DataTicksCalculator(Formatoption): - """ - Abstract base formatoption to calculate ticks and bounds from the data - - Possible types - -------------- - numeric array - specifies the ticks manually - str or list [str, ...] - A list of the below mentioned values of the mapping like - ``[method, N, percmin, percmax, vmin, vmax]``, where only the first - one is absolutely necessary - dict - Automatically determine the ticks corresponding to the data. The - mapping can have the following keys, but only `method` is not optional. - - N - An integer describing the number of boundaries (or ticks per - power of ten, see `log` and `symlog` above) - percmin - The percentile to use for the minimum (by default, 0, i.e. the - minimum of the array) - percmax - The percentile to use for the maximum (by default, 100, i.e. the - maximum of the array) - vmin - The minimum to use (in which case it is not calculated from the - specified `method`) - vmax - The maximum to use (in which case it is not calculated from the - specified `method`) - method - A string that defines how minimum and maximum shall be set. This - argument is **not optional** and can be one of the following: - - data - plot the ticks exactly where the data is. - mid - plot the ticks in the middle of the data. - rounded - Sets the minimum and maximum of the ticks to the rounded data - minimum or maximum. Ticks are rounded to the next 0.5 value - with to the difference between data max- and minimum. The - minimal tick will always be lower or equal than the data - minimum, the maximal tick will always be higher or equal than - the data maximum. - roundedsym - Same as `rounded` above but the ticks are chose such that they - are symmetric around zero - minmax - Uses the minimum as minimal tick and maximum as maximal tick - sym - Same as minmax but symmetric around zero - log - Use logarithmic bounds. In this case, the given number `N` - determines the number of bounds per power of tenth (i.e. - ``N == 2`` results in something like ``1.0, 5.0, 10.0, 50.0``, - etc., If this second number is None, then it will be chosen - such that we have around 11 boundaries but at least one per - power of ten. - symlog - The same as ``log`` but symmetric around 0. If the number `N` - is None, then we have around 12 boundaries but at least one - per power of ten""" - - data_dependent = True - - @property - def full_array(self): - """The full array of this and the shared data""" - return np.concatenate( - [self.array] + [fmto.array for fmto in self.shared]) - - @property - def array(self): - """The numpy array of the data""" - data = self.data - if not hasattr(data, 'notnull'): - data = data.to_series() - mask = np.asarray(data.notnull()) - return data.values[mask] - - def _data_ticks(self, step=None, *args, **kwargs): - step = step or 1 - """Array of ticks that match exactly the data""" - return np.unique(self.array)[::step] - - def _mid_data_ticks(self, step=None, *args, **kwargs): - step = step or 1 - """Array of ticks in the middle between the data points""" - arr = np.unique(self.array) - return ((arr[:-1] + arr[1:])/2.)[::step] - - def _collect_array(self, percmin=None, percmax=None): - """Collect the data from the shared formatoptions (if necessary).""" - - def nanmin(arr): - try: - return np.nanmin(arr) - except TypeError: - return arr.min() - - def nanmax(arr): - try: - return np.nanmax(arr) - except TypeError: - return arr.max() - - def minmax(arr): - return [nanmin(arr), nanmax(arr)] - - def shared_arrays(): - for fmto in self.shared: - fmto._lock_children() - # do not lock the fmto itself, because this breaks the plotter - # update procedure. But make sure, that the dependencies are - # locked - arr = fmto.array - yield arr - # release the locks - fmto._release_children() - - if not self.shared: - arr = self.array - else: - # np.concatenate all arrays if any of the percentiles are required - if percmin is not None or percmax is not None: - arr = np.concatenate(tuple(chain( - [self.array], shared_arrays()))) - # np.concatenate only min and max-values instead of the full arrays - else: - arr = np.concatenate(tuple(map(minmax, chain( - [self.array], shared_arrays())))) - return arr - - def _calc_vmin_vmax(self, percmin=None, percmax=None, - vmin=None, vmax=None): - - def nanmin(arr): - try: - return np.nanmin(arr) - except TypeError: - return arr.min() - - def nanmax(arr): - try: - return np.nanmax(arr) - except TypeError: - return arr.max() - - if vmin is not None and vmax is not None: - return vmin, vmax - - percentiles = [] - arr = self._collect_array(percmin, percmax) - try: - if vmin is not None: - pass - elif not percmin: - vmin = nanmin(arr) - else: - percentiles.append(percmin) - if vmax is not None: - pass - elif percmax is None or percmax == 100: - vmax = nanmax(arr) - else: - percentiles.append(percmax) - except ValueError: - self.logger.warn( - 'Cannot calculate minimum and maximum of the data!', - exc_info=True) - return 0, 1 - if percentiles: - percentiles = iter(np.percentile(arr, percentiles)) - if percmin: - vmin = next(percentiles) - if percmax and percmax < 100: - vmax = next(percentiles) - return vmin, vmax - - @staticmethod - def _round_min_max(vmin, vmax): - if vmin == vmax: - return vmin, vmax - exp = np.floor(np.log10(abs(vmax - vmin))) - larger = round_to_05([vmin, vmax], exp, mode='l') - smaller = round_to_05([vmin, vmax], exp, mode='s') - return min([larger[0], smaller[0]]), max([larger[1], smaller[1]]) - - def _rounded_ticks(self, N=None, *args, **kwargs): - N = N or 11 - vmin, vmax = self._round_min_max( - *self._calc_vmin_vmax(*args, **kwargs)) - return np.linspace(vmin, vmax, N, endpoint=True) - - def _log_bounds(self, expmin, expmax, N): - bounds = [] - for i in range(int(expmax - expmin)): - new_vals = np.linspace(1 * 10 ** (expmin + i), - 9 * 10 ** (expmin + i), N + 1)[:-1] - bounds.extend(new_vals) - return bounds - - def _log_ticks(self, symmetric=False, N=None, *args, **kwargs): - vmin, vmax = self._calc_vmin_vmax(*args, **kwargs) - larger = round_to_05([vmin, vmax], mode='l') - smaller = round_to_05([vmin, vmax], mode='s') - vmin, vmax = min([larger[0], smaller[0]]), max([larger[1], smaller[1]]) - - if symmetric and np.sign(vmin) == np.sign(vmax): - if vmin < 0: # make vmax positive - vmax = -vmax - else: # make vmin negative - vmin = -vmin - elif symmetric: - vmax = np.max([-vmin, vmax]) - vmin = -vmax - - if vmin == vmax: - return vmin, vmax - - signs = np.sign([vmin, vmax]) - crossing0 = vmin != 0 and vmax != 0 and signs[0] != signs[1] - if not crossing0: - vmin, vmax = np.sort(np.abs([vmin, vmax])) - vmin0 = vmax - vmax0 = vmin - - expmin, expmax = np.floor(np.log10(np.abs([vmin, vmax]))) - - dexp = int(expmax - expmin) - expmax0 = np.inf - else: # vmin < 0, vmax > 0 - arr = self._collect_array() - less0 = arr < 0 - greater0 = arr > 0 - if not less0.size: - vmin0 = round_to_05(arr[arr > 0].min(), mode='s') - vmax0 = -vmin0 - elif not greater0.size: - vmax0 = round_to_05(arr[arr < 0].max(), mode='l') - vmin0 = -vmax0 - else: - vmin0 = round_to_05(arr[arr > 0].min(), mode='s') - vmax0 = round_to_05(arr[arr < 0].max(), mode='l') - if symmetric: - vmin0 = min(-vmax0, vmin0) - vmax0 = -vmin0 - - expmin, expmax0 = np.floor(np.log10(np.abs([vmax0, vmin]))) - expmin0, expmax = np.floor(np.log10(np.abs([vmin0, vmax]))) - - dexp_neg = int(expmax0 - expmin) - dexp_pos = int(expmax - expmin0) - - dexp = int(dexp_neg + dexp_pos) - - if dexp == 0 or (dexp == 1 and vmax == 1 * 10**expmax): - # effectively only one factor of 10 (e.g. vmin = 1, vmax = 10) - N = N or (11 if not symmetric else 12) - return np.linspace(vmin, vmax, N, endpoint=True) - else: - if N is None: - # we go close to 11 bounds in total - N = int(max(np.floor((11 if not symmetric else 12) / dexp), 1)) - if not crossing0: - bounds = self._log_bounds(expmin, expmax, N) - bounds += [1*10**expmax] - if signs[0] == -1 and signs[1] == -1: - bounds = -np.array(bounds) - else: - bounds_neg = -np.array(self._log_bounds(expmin, expmax0, N)) - bounds_pos = self._log_bounds(expmin0, expmax, N) - bounds = np.unique( - np.r_[bounds_neg, bounds_pos, - -1 * 10 ** expmin, -1 * 10 ** expmax0, - 1 * 10 ** expmin0, 1 * 10 ** expmax]) - bounds = bounds[(bounds <= vmax0) | (bounds >= vmin0)] - - return np.unique(bounds) - - def _roundedsym_ticks(self, N=None, *args, **kwargs): - N = N or 10 - vmax = max(map(abs, self._round_min_max( - *self._calc_vmin_vmax(*args, **kwargs)))) - vmin = -vmax - return np.linspace(vmin, vmax, N, endpoint=True) - - def _data_minmax_ticks(self, N=None, *args, **kwargs): - N = N or 11 - vmin, vmax = self._calc_vmin_vmax(*args, **kwargs) - return np.linspace(vmin, vmax, N, endpoint=True) - - def _data_symminmax_ticks(self, N=None, *args, **kwargs): - N = N or 10 - vmax = max(map(abs, self._calc_vmin_vmax(*args, **kwargs))) - vmin = -vmax - return np.linspace(vmin, vmax, N, endpoint=True) - - def __init__(self, *args, **kwargs): - super(DataTicksCalculator, self).__init__(*args, **kwargs) - self.calc_funcs = { - 'data': self._data_ticks, - 'mid': self._mid_data_ticks, - 'rounded': self._rounded_ticks, - 'roundedsym': self._roundedsym_ticks, - 'minmax': self._data_minmax_ticks, - 'sym': self._data_symminmax_ticks, - 'log': partial(self._log_ticks, False), - 'symlog': partial(self._log_ticks, True), - } - - -@docstrings.get_sections(base='TicksBase') -class TicksBase(TicksManagerBase, DataTicksCalculator): - """ - Abstract base class for calculating ticks - - Possible types - -------------- - None - use the default ticks - int - for an integer *i*, only every *i-th* tick of the default ticks are - used""" - - dependencies = ['transpose', 'plot'] - - group = 'ticks' - - @abstractproperty - def axis(self): - pass - - def __init__(self, *args, **kwargs): - super(TicksBase, self).__init__(*args, **kwargs) - self.default_locators = {} - - def initialize_plot(self, value): - self.set_default_locators() - self.update(value) - - def update_axis(self, value): - which = self.which - if value is None: - self.set_locator(self.default_locators[which]) - elif isinstance(value, int): - return self._reduce_ticks(value) - elif len(value) and isinstance(value[0], six.string_types): - return self.set_ticks(self.calc_funcs[value[0]](*value[1:])) - elif isinstance(value, tuple): - steps = 11 if len(value) == 2 else value[3] - self.set_ticks(np.linspace(value[0], value[1], steps, - endpoint=True)) - else: - self.set_ticks(value) - - def set_ticks(self, value): - self.axis.set_ticks(value, minor=self.which == 'minor') - - def get_locator(self): - return getattr(self.axis, 'get_%s_locator' % self.which)() - - def set_locator(self, locator): - """Sets the locator corresponding of the axis - - Parameters - ---------- - locator: matplotlib.ticker.Locator - The locator to set - which: {None, 'minor', 'major'} - Specify which locator shall be set. If None, it will be taken from - the :attr:`which` attribute""" - getattr(self.axis, "set_%s_locator" % self.which)(locator) - - def set_default_locators(self, which=None): - """Sets the default locator that is used for updating to None or int - - Parameters - ---------- - which: {None, 'minor', 'major'} - Specify which locator shall be set""" - if which is None or which == 'minor': - self.default_locators['minor'] = self.axis.get_minor_locator() - if which is None or which == 'major': - self.default_locators['major'] = self.axis.get_major_locator() - - def _reduce_ticks(self, i): - loc = self.default_locators[self.which] - self.set_locator(FixedLocator(loc()[::i])) - - -@docstrings.get_sections(base='DtTicksBase') -class DtTicksBase(TicksBase, TicksManager): - """ - Abstract base class for x- and y-tick formatoptions - - Possible types - -------------- - %(TicksManager.possible_types)s - %(TicksBase.possible_types)s - %(DataTicksCalculator.possible_types)s - hour - draw ticks every hour - day - draw ticks every day - week - draw ticks every week - month, monthend, monthbegin - draw ticks in the middle, at the end or at the beginning of each - month - year, yearend, yearbegin - draw ticks in the middle, at the end or at the beginning of each - year - - For data, mid, hour, day, week, month, etc., the optional second value - can be an integer i determining that every i-th data point shall be - used (by default, it is set to 1). For rounded, roundedsym, minmax and - sym, the second value determines the total number of ticks (defaults to - 11).""" - - def __init__(self, *args, **kwargs): - super(DtTicksBase, self).__init__(*args, **kwargs) - self.calc_funcs.update({ - 'hour': self._frequent_ticks('H'), - 'day': self._frequent_ticks('D'), - 'week': self._frequent_ticks(offsets.Week()), - 'month': self._mid_dt_ticks('M'), - 'monthend': self._frequent_ticks( - offsets.MonthEnd(), onset=offsets.MonthBegin()), - 'monthbegin': self._frequent_ticks( - offsets.MonthBegin(), onset=offsets.MonthBegin(), - offset=offsets.MonthBegin()), - 'year': self._mid_dt_ticks(offsets.YearBegin()), - 'yearend': self._frequent_ticks( - offsets.YearEnd(), onset=offsets.YearBegin()), - 'yearbegin': self._frequent_ticks( - offsets.YearBegin(), onset=offsets.YearBegin(), - offset=offsets.YearBegin())}) - - def update(self, value): - value = value or {'minor': None, 'major': None} - super(DtTicksBase, self).update(value) - - @property - def dtdata(self): - """The np.unique :attr:`data` as datetime objects""" - data = self.data - # do nothing if the data is a pandas.Index without time informations - # or not a pandas.Index - if not getattr(data, 'is_all_dates', None): - warn("[%s] - Could not convert time informations for %s ticks " - "with object %r." % (self.logger.name, self.key, type(data))) - return None - else: - return data - - def _frequent_ticks(self, freq, onset=None, offset=None): - def func(N=None, *args, **kwargs): - step = N or 1 - data = self.dtdata - if data is None: - return - mindata = data.min() if onset is None else data.min() - onset - maxdata = data.max() if offset is None else data.max() + offset - return date_range( - mindata, maxdata, freq=freq)[::step].to_pydatetime() - return func - - def _mid_dt_ticks(self, freq): - def func(N=None, *args, **kwargs): - step = N or 1 - data = self.dtdata - if data is None: - return - data = date_range( - data.min(), data.max(), freq=freq).to_pydatetime() - data[:-1] += (data[1:] - data[:-1])/2 - return data[:-1:step] - return func - - -class XTicks(DtTicksBase): - """ - Modify the x-axis ticks - - Possible types - -------------- - %(DtTicksBase.possible_types)s - - Examples - -------- - Plot 11 ticks over the whole data range:: - - >>> plotter.update(xticks='rounded') - - Plot 7 ticks over the whole data range where the maximal and minimal - tick matches the data maximum and minimum:: - - >>> plotter.update(xticks=['minmax', 7]) - - Plot ticks every year and minor ticks every month:: - - >>> plotter.update(xticks={'major': 'year', 'minor': 'month'}) - - See Also - -------- - xticklabels, ticksize, tickweight, xtickprops, yticks""" - - children = TicksBase.children + ['yticks'] - - dependencies = DtTicksBase.dependencies + ['plot'] - - name = 'Location of the x-Axis ticks' - - @property - def axis(self): - return self.ax.xaxis - - @property - def data(self): - def select_array(arr): - if arr.ndim > 1: - return arr.psy[0] - return arr - data = getattr(self.plot, 'plotted_data', super(XTicks, self).data) - if not len(data): - data = super(XTicks, self).data - if isinstance(data, InteractiveList): - df = InteractiveList(map(select_array, data)).to_dataframe() - else: - df = data.to_series() - if self.transpose.value: - return df - else: - if isinstance(df.index, MultiIndex) and len(df.index.names) == 1: - return df.index.get_level_values(0) - else: - return df.index - - def initialize_plot(self, *args, **kwargs): - super(XTicks, self).initialize_plot(*args, **kwargs) - self.transpose.swap_funcs['ticks'] = self._swap_ticks - - def _swap_ticks(self): - xticks = self - yticks = self.yticks - old_xlocators = xticks.default_locators - xticks.default_locators = yticks.default_locators - yticks.default_locators = old_xlocators - old_xval = self.value - with self.plotter.no_validation: - self.plotter[self.key] = self.yticks.value - self.plotter[self.yticks.key] = old_xval - - -class YTicks(DtTicksBase): - """ - Modify the y-axis ticks - - Possible types - -------------- - %(DtTicksBase.possible_types)s - - See Also - -------- - yticklabels, ticksize, tickweight, ytickprops - xticks: for possible examples""" - - dependencies = DtTicksBase.dependencies + ['plot'] - - name = 'Location of the y-Axis ticks' - - @property - def axis(self): - return self.ax.yaxis - - @property - def data(self): - def select_array(arr): - if arr.ndim > 1: - return arr.psy[0] - return arr - data = getattr(self.plot, 'plotted_data', super(XTicks, self).data) - if not len(data): - data = super(XTicks, self).data - if isinstance(data, InteractiveList): - df = InteractiveList(map(select_array, data)).to_dataframe() - else: - df = data.to_series() - if self.transpose.value: - if isinstance(df.index, MultiIndex) and len(df.index.names) == 1: - return df.index.get_level_values(0) - else: - return df.index - else: - return df - - -@docstrings.get_sections(base='TickLabelsBase') -class TickLabelsBase(TicksManagerBase): - """ - Abstract base class for ticklabels - - Possible types - -------------- - str - A formatstring like ``'%%Y'`` for plotting the year (in the case that - time is shown on the axis) or '%%i' for integers - array - An array of strings to use for the ticklabels""" - - dependencies = ['transpose'] - - group = 'ticks' - - @abstractproperty - def axis(self): - """The axis on the axes to modify the ticks of""" - pass - - def __init__(self, *args, **kwargs): - super(TickLabelsBase, self).__init__(*args, **kwargs) - self.default_formatters = {} - - def initialize_plot(self, value): - self.set_default_formatters() - self.update(value) - - def update_axis(self, value): - if value is None: - self.set_formatter(self.default_formatters['major']) - elif isinstance(value, six.string_types): - self.set_stringformatter(value) - else: - ticks = self.axis.get_ticklocs(minor=self.which == 'minor') - if len(ticks) != len(value): - warn("[%s] - Length of ticks (%i) and ticklabels (%i)" - "do not match!" % (self.key, len(ticks), len(value))) - self.set_ticklabels(value) - - def set_stringformatter(self, s): - default_formatter = self.default_formatters['major'] - if isinstance(default_formatter, AutoDateFormatter): - self.set_formatter(DateFormatter(s)) - else: - self.set_formatter(FormatStrFormatter(s)) - - def set_ticklabels(self, labels): - """Sets the given tick labels""" - self.set_formatter(FixedFormatter(labels)) - - @abstractmethod - def set_formatter(self, formatter): - """Sets a given formatter""" - pass - - @abstractmethod - def set_default_formatters(self): - """Sets the default formatters that is used for updating to None""" - pass - - -class TickLabels(TickLabelsBase, TicksManager): - - def update(self, value): - if (getattr(self, self.key.replace('label', '')).value.get( - 'minor') is not None and - 'minor' not in self.value): - items = chain(six.iteritems(value), [('minor', None)]) - else: - items = six.iteritems(value) - super(TickLabels, self).update(dict(items)) - - def set_default_formatters(self, which=None): - """Sets the default formatters that is used for updating to None - - Parameters - ---------- - which: {None, 'minor', 'major'} - Specify which locator shall be set""" - if which is None or which == 'minor': - self.default_formatters['minor'] = self.axis.get_minor_formatter() - if which is None or which == 'major': - self.default_formatters['major'] = self.axis.get_major_formatter() - - def set_formatter(self, formatter, which=None): - which = which or self.which - getattr(self.axis, 'set_%s_formatter' % which)(formatter) - - -class XTickLabels(TickLabels): - """ - Modify the x-axis ticklabels - - Possible types - -------------- - %(TicksManager.possible_types)s - %(TickLabelsBase.possible_types)s - - See Also - -------- - xticks, ticksize, tickweight, xtickprops, yticklabels""" - - dependencies = TickLabelsBase.dependencies + ['xticks', 'yticklabels'] - - name = 'x-xxis Ticklabels' - - @property - def axis(self): - return self.ax.xaxis - - def initialize_plot(self, *args, **kwargs): - super(XTickLabels, self).initialize_plot(*args, **kwargs) - self.transpose.swap_funcs['ticklabels'] = self._swap_ticklabels - - def _swap_ticklabels(self): - xticklabels = self - yticklabels = self.yticklabels - old_xformatters = xticklabels.default_formatters - xticklabels.default_formatters = yticklabels.default_formatters - yticklabels.default_formatters = old_xformatters - old_xval = self.value - with self.plotter.no_validation: - self.plotter[self.key] = self.yticklabels.value - self.plotter[self.yticklabels.key] = old_xval - - -class YTickLabels(TickLabels): - """ - Modify the y-axis ticklabels - - Possible types - -------------- - %(TicksManager.possible_types)s - %(TickLabelsBase.possible_types)s - - See Also - -------- - yticks, ticksize, tickweight, ytickprops, xticklabels""" - - dependencies = TickLabelsBase.dependencies + ['yticks'] - - name = 'y-xxis ticklabels' - - @property - def axis(self): - return self.ax.yaxis - - -class BarXTicks(XTicks): - - __doc__ = XTicks.__doc__ - - connections = XTicks.connections + ['xlim'] - - dependencies = XTicks.dependencies + ['categorical'] - - def update(self, value): - import matplotlib.ticker as mtick - if self.categorical.is_categorical and not self.transpose.value: - self.default_locators['major'] = mtick.FixedLocator( - np.unique(self.array)) - self.default_locators['minor'] = mtick.NullLocator() - else: - self.default_locators = self._orig_default_locators.copy() - return super(BarXTicks, self).update(value) - - def set_default_locators(self): - super(BarXTicks, self).set_default_locators() - self._orig_default_locators = self.default_locators.copy() - - @property - def array(self): - if self.transpose.value and 'stacked' in slist(self.plot.value): - df = self.data.to_dataframe() - return np.concatenate( - [[min([0, df.values.min()])], df.sum(axis=1).values]) - elif self.transpose.value: - return np.concatenate( - [self.plot.get_xys(arr)[1] for arr in self.plot.iter_data]) - else: - return np.concatenate( - [self.plot.get_xys(arr)[0] for arr in self.plot.iter_data]) - - -class BarYTicks(YTicks): - - __doc__ = YTicks.__doc__ - - connections = YTicks.connections + ['ylim'] - - dependencies = YTicks.dependencies + ['categorical'] - - def update(self, value): - import matplotlib.ticker as mtick - if self.categorical.is_categorical and self.transpose.value: - self.default_locators['major'] = mtick.FixedLocator( - np.unique(self.array)) - self.default_locators['minor'] = mtick.NullLocator() - else: - self.default_locators = self._orig_default_locators.copy() - return super(BarYTicks, self).update(value) - - def set_default_locators(self): - super(BarYTicks, self).set_default_locators() - self._orig_default_locators = self.default_locators.copy() - - @property - def array(self): - if not self.transpose.value and 'stacked' in slist(self.plot.value): - df = self.data.to_dataframe() - return np.concatenate( - [[min([0, df.values.min()])], df.sum(axis=1).values]) - elif self.transpose.value: - return np.concatenate( - [self.plot.get_xys(arr)[0] for arr in self.plot.iter_data]) - else: - return np.concatenate( - [self.plot.get_xys(arr)[1] for arr in self.plot.iter_data]) - - -class BarXTickLabels(XTickLabels): - - __doc__ = XTickLabels.__doc__ - - dependencies = XTickLabels.dependencies + ['plot', 'categorical'] - - def set_stringformatter(self, s): - if not self.transpose.value and self.plot.value is not None: - index = self.data.to_dataframe().index - if index.is_all_dates: - if self.categorical.is_categorical: - xticks = self.ax.get_xticks(minor=self.which == 'minor') - arr = list(map(lambda t: t.toordinal(), - to_datetime(index[xticks.astype(int)]))) - self.ax.set_xticklabels(list(map(DateFormatter(s), arr))) - else: - self.set_formatter(DateFormatter(s)) - return - super(BarXTickLabels, self).set_stringformatter(s) - - -class BarYTickLabels(YTickLabels): - - __doc__ = YTickLabels.__doc__ - - dependencies = YTickLabels.dependencies + ['plot', 'categorical'] - - def set_stringformatter(self, s): - if self.transpose.value and self.plot.value is not None: - index = self.data.to_dataframe().index - if index.is_all_dates: - if self.categorical.is_categorical: - yticks = self.ax.get_yticks(self.which == 'minor') - arr = list(map(lambda t: t.toordinal(), - to_datetime(index[yticks.astype(int)]))) - self.ax.set_yticklabels(list(map(DateFormatter(s), arr))) - else: - self.set_formatter(DateFormatter(s)) - return - super(BarYTickLabels, self).set_stringformatter(s) - - -class TicksOptions(TicksManagerBase): - """Base class for ticklabels options that apply for x- and y-axis""" - - def update(self, value): - for which, val in six.iteritems(value): - for axis, axisname in zip([self.ax.xaxis, self.ax.yaxis], 'xy'): - self.which = which - self.axis = axis - self.axisname = axisname - self.update_axis(val) - - -class TickSizeBase(TicksOptions): - """Abstract base class for modifying tick sizes""" - - def update_axis(self, value): - for t in self.axis.get_ticklabels(which=self.which): - t.set_size(value) - - -class TickSize(TickSizeBase, TicksOptions, DictFormatoption): - """ - Change the ticksize of the ticklabels - - Possible types - -------------- - %(TicksManager.possible_types)s - %(fontsizes)s - - See Also - -------- - tickweight, xtickprops, ytickprops""" - - dependencies = TicksOptions.dependencies + ['xtickprops', 'ytickprops'] - - name = 'Font size of the ticklabels' - - -class TickWeightBase(TicksOptions): - """Abstract base class for modifying font weight of ticks""" - - def update_axis(self, value): - for t in self.axis.get_ticklabels(which=self.which): - t.set_weight(value) - - -class TickWeight(TickWeightBase, TicksOptions, DictFormatoption): - """ - Change the fontweight of the ticks - - Possible types - -------------- - %(TicksManager.possible_types)s - %(fontweights)s - - See Also - -------- - ticksize, xtickprops, ytickprops""" - - dependencies = TicksOptions.dependencies + ['xtickprops', 'ytickprops'] - - name = 'Font weight of the ticklabels' - - -@docstrings.get_sections(base='TickPropsBase') -class TickPropsBase(TicksManagerBase): - """ - Abstract base class for tick parameters - - Possible types - -------------- - dict - Items may be anything of the :func:`matplotlib.pyplot.tick_params` - function""" - - @abstractproperty - def axisname(self): - """The name of the axis (either 'x' or 'y')""" - pass - - def update_axis(self, value): - value = value.copy() - if float('.'.join(mpl.__version__.split('.')[:2])) >= 1.5: - value.pop('visible', None) - self.ax.tick_params( - self.axisname, which=self.which, reset=True, **value) - - -@docstrings.get_sections(base='XTickProps') -class XTickProps(TickPropsBase, TicksManager, DictFormatoption): - """ - Specify the x-axis tick parameters - - This formatoption can be used to make a detailed change of the ticks - parameters on the x-axis. - - Possible types - -------------- - %(TicksManager.possible_types)s - %(TickPropsBase.possible_types)s - - See Also - -------- - xticks, yticks, ticksize, tickweight, ytickprops""" - - axisname = 'x' - - name = 'Font properties of the x-ticklabels' - - @property - def axis(self): - return self.ax.xaxis - - -class YTickProps(XTickProps): - """ - Specify the y-axis tick parameters - - This formatoption can be used to make a detailed change of the ticks - parameters of the y-axis. - - Possible types - -------------- - %(XTickProps.possible_types)s - - See Also - -------- - xticks, yticks, ticksize, tickweight, xtickprops""" - - axisname = 'y' - - name = 'Font properties of the y-ticklabels' - - @property - def axis(self): - return self.ax.xaxis - - -@docstrings.get_sections(base='Xlabel') -class Xlabel(TextBase, Formatoption): - """ - Set the x-axis label - - Set the label for the x-axis. - %(replace_note)s - - Possible types - -------------- - str - The text for the :func:`~matplotlib.pyplot.xlabel` function. - - See Also - -------- - xlabelsize, xlabelweight, xlabelprops""" - - children = ['transpose', 'ylabel'] - - name = 'x-axis label' - - @property - def enhanced_attrs(self): - arr = self.transpose.get_x(self.data) - replot = self.plotter.replot or not hasattr(self, '_enhanced_attrs') - attrs = self.get_enhanced_attrs(arr, replot=replot) - arr_attrs = self.get_enhanced_attrs(self.data, replot=replot) - for attr, val in arr_attrs.items(): - attrs.setdefault(attr, val) - self._enhanced_attrs = attrs - return attrs - - def initialize_plot(self, value): - self.transpose.swap_funcs['labels'] = self._swap_labels - self._texts = [self.ax.set_xlabel(self.replace( - value, self.data, self.enhanced_attrs))] - - def update(self, value): - self._texts[0].set_text(self.replace(value, self.data, - self.enhanced_attrs)) - - def _swap_labels(self): - plotter = self.plotter - self.transpose._swap_labels() - old_xlabel = self.value - with plotter.no_validation: - plotter[self.key] = self.ylabel.value - plotter[self.ylabel.key] = old_xlabel - - -class BarXlabel(Xlabel): - """ - Set the x-axis label - - Set the label for the x-axis. - %(replace_note)s - - Possible types - -------------- - %(Xlabel.possible_types)s - - See Also - -------- - xlabelsize, xlabelweight, xlabelprops""" - - #: Xlabel is modified by the pandas plot routine, therefore we update it - #: after each plot - update_after_plot = True - - -@docstrings.get_sections(base='Ylabel') -class Ylabel(TextBase, Formatoption): - """ - Set the y-axis label - - Set the label for the y-axis. - %(replace_note)s - - Possible types - -------------- - str - The text for the :func:`~matplotlib.pyplot.ylabel` function. - - See Also - -------- - ylabelsize, ylabelweight, ylabelprops""" - - children = ['transpose'] - - name = 'y-axis label' - - @property - def enhanced_attrs(self): - arr = self.transpose.get_y(self.data) - replot = self.plotter.replot or not hasattr(self, '_enhanced_attrs') - attrs = self.get_enhanced_attrs(arr, replot=replot) - arr_attrs = self.get_enhanced_attrs(self.data, replot=replot) - for attr, val in arr_attrs.items(): - attrs.setdefault(attr, val) - self._enhanced_attrs = attrs - return attrs - - def initialize_plot(self, value): - self._texts = [self.ax.set_ylabel(self.replace( - value, self.data, self.enhanced_attrs))] - - def update(self, value): - self._texts[0].set_text(self.replace( - value, self.data, self.enhanced_attrs)) - - -class BarYlabel(Ylabel): - """ - Set the y-axis label - - Set the label for the y-axis. - %(replace_note)s - - Possible types - -------------- - %(Ylabel.possible_types)s - - See Also - -------- - ylabelsize, ylabelweight, ylabelprops""" - - #: Ylabel is modified by the pandas plot routine, therefore we update it - #: after each plot - update_after_plot = True - - -@docstrings.get_sections(base='LabelOptions') -class LabelOptions(DictFormatoption): - """ - Base formatoption class for label sizes - - Possible types - -------------- - dict - A dictionary with the keys ``'x'`` and (or) ``'y'`` to specify - which ticks are managed. If the given value is not a dictionary with - those keys, it is used for the x- and y-axis. - The values in the dictionary can be one types below. - """ - - children = ['xlabel', 'ylabel'] - - def update(self, value): - for axis, val in value.items(): - self._text = getattr(self, axis + 'label')._texts[0] - self.axis_str = axis - self.update_axis(val) - - @abstractmethod - def update_axis(self, value): - pass - - -class LabelSize(LabelOptions): - """ - Set the size of both, x- and y-label - - Possible types - -------------- - %(LabelOptions.possible_types)s - %(fontsizes)s - - See Also - -------- - xlabel, ylabel, labelweight, labelprops""" - - group = 'labels' - - parents = ['labelprops'] - - name = 'font size of x- and y-axis label' - - def update_axis(self, value): - self._text.set_size(value) - - -class LabelWeight(LabelOptions): - """ - Set the font size of both, x- and y-label - - Possible types - -------------- - %(LabelOptions.possible_types)s - %(fontweights)s - - See Also - -------- - xlabel, ylabel, labelsize, labelprops""" - - group = 'labels' - - parents = ['labelprops'] - - name = 'font weight of x- and y-axis label' - - def update_axis(self, value): - self._text.set_weight(value) - - -class LabelProps(LabelOptions): - """ - Set the font properties of both, x- and y-label - - Possible types - -------------- - %(LabelOptions.possible_types)s - dict - Items may be any valid text property - - See Also - -------- - xlabel, ylabel, labelsize, labelweight""" - - group = 'labels' - - children = ['xlabel', 'ylabel', 'labelsize', 'labelweight'] - - name = 'font properties of x- and y-axis label' - - def update_axis(self, fontprops): - fontprops = fontprops.copy() - if 'size' not in fontprops and 'fontsize' not in fontprops: - fontprops['size'] = self.labelsize.value[self.axis_str] - if 'weight' not in fontprops and 'fontweight' not in fontprops: - fontprops['weight'] = self.labelweight.value[self.axis_str] - self._text.update(fontprops) - - -class Transpose(Formatoption): - """ - Switch x- and y-axes - - By default, one-dimensional arrays have the dimension on the x-axis and two - dimensional arrays have the first dimension on the y and the second on the - x-axis. You can set this formatoption to True to change this behaviour - - Possible types - -------------- - bool - If True, axes are switched""" - - group = 'axes' - - name = 'Switch x- and y-axes' - - priority = START - - def __init__(self, *args, **kwargs): - super(Transpose, self).__init__(*args, **kwargs) - self.swap_funcs = { - 'ticks': self._swap_ticks, - 'ticklabels': self._swap_ticklabels, - 'limits': self._swap_limits, - 'labels': self._swap_labels, - } - - def initialize_plot(self, value): - pass - - def update(self, value): - for func in six.itervalues(self.swap_funcs): - func() - - def _swap_ticks(self): - xaxis = self.ax.xaxis - yaxis = self.ax.yaxis - # swap major ticks - old_xlocator = xaxis.get_major_locator() - xaxis.set_major_locator(yaxis.get_major_locator()) - yaxis.set_major_locator(old_xlocator) - # swap minor ticks - old_xlocator = xaxis.get_minor_locator() - xaxis.set_minor_locator(yaxis.get_minor_locator()) - yaxis.set_minor_locator(old_xlocator) - - def _swap_ticklabels(self): - xaxis = self.ax.xaxis - yaxis = self.ax.yaxis - # swap major ticklabels - old_xformatter = xaxis.get_major_formatter() - xaxis.set_major_formatter(yaxis.get_major_formatter()) - yaxis.set_major_formatter(old_xformatter) - # swap minor ticklabels - old_xformatter = xaxis.get_minor_formatter() - xaxis.set_minor_formatter(yaxis.get_minor_formatter()) - yaxis.set_minor_formatter(old_xformatter) - - def _swap_limits(self): - old_xlim = list(self.ax.get_xlim()) - self.ax.set_xlim(*self.ax.get_ylim()) - self.ax.set_ylim(*old_xlim) - - def _swap_labels(self): - old_xlabel = self.ax.get_xlabel() - self.ax.set_xlabel(self.ax.get_ylabel()) - self.ax.set_ylabel(old_xlabel) - - def get_x(self, arr): - if not hasattr(arr, 'ndim'): # if the data object is an array list - arr = arr[0] - if arr.dims[0] == 'variable' and arr.ndim > 1: - arr = arr.psy[0] - is_unstructured = arr.psy.decoder.is_unstructured(arr) - if not is_unstructured and arr.ndim == 1: - if self.value: - return arr - else: - #: The x-coordinate name of the variable as stored in the - #: dataset (might differ from the one in this array because - #: this could also be time, z, y, etc.) - ds_coord = arr.psy.get_dim('x', True) - xname = arr.dims[0] - else: - if self.value: - ds_coord = arr.psy.get_dim('y', True) - xname = arr.dims[-2 if not is_unstructured else -1] - else: - ds_coord = arr.psy.get_dim('x', True) - xname = arr.dims[-1] - if xname == ds_coord: - if self.value: - return arr.psy.get_coord('y', True) - return arr.psy.get_coord('x', True) - else: - return arr.coords[xname] - - def get_y(self, arr): - if not hasattr(arr, 'ndim'): # if the data object is an array list - arr = arr[0] - elif arr.dims[0] == 'variable' and arr.ndim > 1: - arr = arr.psy[0] - is_unstructured = arr.psy.decoder.is_unstructured(arr) - if not is_unstructured and arr.ndim == 1: - if not self.value: - return arr - else: - #: The x-coordinate name of the variable as stored in the - #: dataset (might differ from the one in this array because - #: this could also be time, z, y, etc.) - ds_coord = arr.psy.get_dim('x', True) - yname = arr.dims[0] - else: - if not self.value: - ds_coord = arr.psy.get_dim('y', True) - yname = arr.dims[-2 if not is_unstructured else -1] - else: - ds_coord = arr.psy.get_dim('x', True) - yname = arr.dims[-1] - if yname == ds_coord: - if self.value: - return arr.psy.get_coord('x', True) - return arr.psy.get_coord('y', True) - else: - return arr.coords[yname] - - -@docstrings.get_sections(base='LineColors') -class LineColors(Formatoption): - """ - Set the color coding - - This formatoptions sets the color of the lines, bars, etc. - - Possible types - -------------- - None - to use the axes color_cycle - iterable - (e.g. list) to specify the colors manually - str - %(cmap_note)s - matplotlib.colors.ColorMap - to automatically choose the colors according to the number of lines, - etc. from the given colormap""" - - group = 'colors' - - priority = BEFOREPLOTTING - - name = 'Color cycle' - - @property - def value2pickle(self): - return self.colors - - @property - def value2share(self): - return self.extended_colors - - def __init__(self, *args, **kwargs): - super(LineColors, self).__init__(*args, **kwargs) - self.colors = [] - - @property - def extended_colors(self): - for c in self.colors: - yield c - while True: - c = next(self.color_cycle) - self.colors.append(c) - yield c - - def update(self, value): - changed = self.plotter.has_changed(self.key) - if value is None: - prop_cycler = mpl.rcParams['axes.prop_cycle'] - self.color_cycle = cycle((props['color'] for props in prop_cycler)) - prop_cycler._keys # this should make a copy - else: - try: - self.color_cycle = cycle(get_cmap(value)( - np.linspace(0., 1., len(list(self.iter_data)), - endpoint=True))) - except (ValueError, TypeError, KeyError): - try: - # do not use safe_list, because it might be a generator - validate_color(value) - except (ValueError, TypeError, AttributeError): - pass - else: - value = [value] - self.color_cycle = cycle(iter(value)) - if changed: - self.colors.clear() - - -class Marker(Formatoption): - """ - Choose the marker for points - - Possible types - -------------- - None - Use the default from matplotlibs rcParams - str - A valid symbol for the matplotlib markers (see - :mod:`matplotlib.markers`) - """ - - priority = BEFOREPLOTTING - - def update(self, value): - if value is None: - self.markers = repeat(mpl.rcParams['lines.marker']) - else: - self.markers = cycle(value) - - -class MarkerSize(Formatoption): - """ - Choose the size of the markers for points - - Possible types - -------------- - None - Use the default from matplotlibs rcParams - float - The size of the marker - """ - - connections = ['plot'] - - priority = BEFOREPLOTTING - - def update(self, value): - if value is None: - self.plot._kwargs.pop('markersize', None) - else: - self.plot._kwargs['markersize'] = value - - -class LineWidth(Formatoption): - """ - Choose the width of the lines - - Possible types - -------------- - None - Use the default from matplotlibs rcParams - float - The width of the lines - """ - - connections = ['plot'] - - priority = BEFOREPLOTTING - - def update(self, value): - if value is None: - self.plot._kwargs.pop('linewidth', None) - else: - self.plot._kwargs['linewidth'] = value - - -class LinePlot(Formatoption): - """ - Choose the line style of the plot - - Possible types - -------------- - None - Don't make any plotting - ``'area'`` - To make an area plot (filled between y=0 and y), see - :func:`matplotlib.pyplot.fill_between` - ``'areax'`` - To make a transposed area plot (filled between x=0 and x), see - :func:`matplotlib.pyplot.fill_betweenx` - ``'stacked'`` - Make a stacked plot - str or list of str - The line style string to use (['solid' | 'dashed', 'dashdot', 'dotted' - | (offset, on-off-dash-seq) | '-' | '--' | '-.' | ':' | 'None' | ' ' | - '']). - """ - - plot_fmt = True - - group = 'plotting' - - priority = BEFOREPLOTTING + 0.1 - - children = ['color', 'transpose', 'marker'] - - name = 'Line plot type' - - @property - def plotted_data(self): - """The data that is shown to the user""" - return InteractiveList( - [arr for arr, val in zip(self.iter_data, - cycle(slist(self.value))) - if val is not None]) - - def __init__(self, *args, **kwargs): - Formatoption.__init__(self, *args, **kwargs) - self._kwargs = {} - - def update(self, value): - # the real plot making is done by make_plot - pass - - def make_plot(self): - if hasattr(self, '_plot'): - self.remove() - value = self.value - if value is not None: - if 'stacked' in value: - self._stacked_plot() - else: - try: - markers = self.marker.markers - except AttributeError: - markers = repeat(None) - self._plot = list(filter(None, chain.from_iterable(starmap( - self.plot_arr, zip( - self.iter_data, self.color.extended_colors, - cycle(slist(self.value)), markers))))) - - def _stacked_plot(self): - transpose = self.transpose.value - data = self.data - if isinstance(data, InteractiveList): - data = InteractiveList([arr[0] if arr.ndim == 2 else arr - for arr in data]) - df = data.to_dataframe() - else: - df = data.to_series().to_frame() - index = self._get_index(df) - if not isinstance(index, DatetimeIndex): - try: - x = np.asarray(index.values).astype(float) - except ValueError: - x = np.arange(index.values.size) - else: - x = index.to_pydatetime() - base = np.zeros_like(df.iloc[:, 0]) - self._plot = [] - for (col, s), c, val in zip(df.items(), self.color.extended_colors, - cycle(slist(self.value))): - if val is None: - continue - pm = self.ax.fill_betweenx if transpose else \ - self.ax.fill_between - y = np.where(s.isnull(), 0, s.values) - self._plot.append(pm(x, base, base + y, facecolor=c)) - base += y - - def _get_index(self, df): - if isinstance(df.index, MultiIndex) and len(df.index.names) == 1: - index = df.index.get_level_values(0) - else: - index = df.index - return index - - def plot_arr(self, arr, c, ls, m): - if ls is None: - return [None] - # since date time objects are covered better by pandas, - # we convert to a series - if arr.ndim == 2: # contains also error information - arr = arr[0] - df = arr.to_series() - try: - y = np.asarray(df.values).astype(float) - except ValueError: - y = np.arange(df.values.size) - index = self._get_index(df) - if not isinstance(index, DatetimeIndex): - try: - x = np.asarray(index.values).astype(float) - except ValueError: - x = np.arange(index.values.size) - else: - x = index.to_pydatetime() - - if self.transpose.value: - x, y = y, x - if ls in ['area', 'areay']: - ymin = np.vstack([y, np.zeros_like(y)]).min(axis=0) - ymax = np.vstack([y, np.zeros_like(y)]).max(axis=0) - return [self.ax.fill_between(x, ymin, ymax, color=c)] - elif ls == 'areax': - xmin = np.vstack([x, np.zeros_like(x)]).min(axis=0) - xmax = np.vstack([x, np.zeros_like(x)]).max(axis=0) - return [self.ax.fill_betweenx(y, xmin, xmax, color=c)] - else: - return self.ax.plot(x, y, - color=c, linestyle=ls, marker=m, - **self._kwargs) - - def remove(self): - for artist in self._plot: - artist.remove() - del self._plot - - -class ErrorPlot(Formatoption): - """ - Visualize the error range - - This formatoption visualizes the error range. For this, you must provide a - two-dimensional data array as input. The first dimension might be either of - length - - - 2 to provide the deviation from minimum and maximum error range from - the data - - 3 to provide the minimum and maximum error range explicitly - - Possible types - -------------- - None - No errors are visualized - 'fill' - The area between min- and max-error is filled with the same color as - the line and the alpha is determined by the :attr:`fillalpha` attribute - - Examples - -------- - Assume you have the standard deviation stored in the ``'std'``-variable and - the data in the ``'data'`` variable. Then you can visualize the standard - deviation simply via:: - - >>> psy.plot.lineplot(input_ds, name=[['data', 'std']]) - - On the other hand, assume you want to visualize the area between the 25th - and 75th percentile (stored in the variables ``'p25'`` and ``'p75'``):: - - >>> psy.plot.lineplot(input_ds, name=[['data', 'p25', 'p75']]) - - See Also - -------- - erroralpha - """ - - plot_fmt = True - - group = 'plotting' - - priority = BEFOREPLOTTING - - children = ['color', 'transpose', 'plot'] - - name = 'Error plot type' - - def __init__(self, *args, **kwargs): - Formatoption.__init__(self, *args, **kwargs) - self._kwargs = {} - - def update(self, value): - pass # the work is done in make_plot - - def make_plot(self): - if hasattr(self, '_plot'): - self.remove() - if self.value is not None: - self._plot = [] - colors = self.color.extended_colors - for da, line in zip(self.iter_data, self.plot._plot): - if da.ndim == 2 and da.shape[0] > 1: - data = da[0].to_series() - error = da[1:, :] - if error.shape[0] == 1: - min_range = data.values - error[0] - max_range = data.values + error[0] - else: - min_range = error[0] - max_range = error[1] - if self.value == 'fill': - vals = self._get_x_values(data) - self.plot_fill(vals, min_range, max_range, - next(colors), zorder=line.zorder) - else: - next(colors) - - def _get_x_values(self, df): - if isinstance(df.index, MultiIndex) and len(df.index.names) == 1: - index = df.index.get_level_values(0) - else: - index = df.index - if not isinstance(index, DatetimeIndex): - try: - x = np.asarray(index.values).astype(float) - except ValueError: - x = np.arange(index.values.size) - else: - x = index.to_pydatetime() - return x - - def plot_fill(self, index, min_range, max_range, c, **kwargs): - if self.transpose.value: - plot_method = self.ax.fill_betweenx - else: - plot_method = self.ax.fill_between - self._plot.append( - plot_method(index, min_range, max_range, facecolor=c, - **dict(chain(*map( - six.iteritems, [self._kwargs, kwargs]))))) - - def remove(self): - for artist in self._plot: - artist.remove() - del self._plot - - -class ErrorAlpha(Formatoption): - """ - Set the alpha value for the error range - - This formatoption can be used to set the alpha value (opacity) for the - :attr:`error` formatoption - - Possible types - -------------- - float - A float between 0 and 1 - - See Also - -------- - error""" - - priority = BEFOREPLOTTING - - name = 'Alpha value of the error range' - - group = 'colors' - - connections = ['error'] - - def update(self, value): - self.error._kwargs['alpha'] = value - - -class BarWidths(Formatoption): - """ - Specify the widths of the bars - - Possible types - -------------- - 'equal' - Each bar will have the same width (the default) - 'data' - Each bar will have the width as specified by the boundaries - float - The width for each bar - - See Also - -------- - categorical - """ - - priority = BEFOREPLOTTING - - name = 'Width of the bars' - - def update(self, value): - # Does nothing, the work is done in the :class:`BarPlot` formatoption - pass - - -class CategoricalBars(Formatoption): - """ - The location of each bar - - Possible types - -------------- - None - If None, use a categorical plotting if the widths are ``'equal'``, - otherwise, not - bool - If True, use a categorical plotting - - See Also - -------- - widths - """ - - priority = BEFOREPLOTTING - - name = 'Categorical or non-categorical plotting' - - dependencies = ['widths'] - - def update(self, value): - widths = self.widths.value - self.is_categorical = (value is None and widths == 'equal') or value - - -class BarAlpha(Formatoption): - """ - Specify the transparency (alpha) - - Possible types - -------------- - float - A value between 0 (opaque) and 1 invisible""" - - priority = BEFOREPLOTTING - - name = 'Transparency of the bars' - - def update(self, value): - pass - - -class BarPlot(Formatoption): - """ - Choose how to make the bar plot - - Possible types - -------------- - None - Don't make any plotting - 'bar' - Create a usual bar plot with the bars side-by-side - 'stacked' - Create stacked plot - """ - - plot_fmt = True - - group = 'plotting' - - priority = BEFOREPLOTTING - - children = ['color', 'transpose', 'alpha'] - - dependencies = ['widths', 'categorical'] - - name = 'Bar plot type' - - def __init__(self, *args, **kwargs): - Formatoption.__init__(self, *args, **kwargs) - self._kwargs = {} - - def update(self, value): - # the real plot making is done by make_plot - pass - - def remove(self): - for artist in self._plot: - artist.remove() - del self._plot - - @property - def plotted_data(self): - """The data that is shown to the user""" - return InteractiveList( - [arr for arr, val in zip(self.iter_data, - cycle(slist(self.value))) - if val is not None]) - - def make_plot(self): - if hasattr(self, '_plot'): - self.remove() - if self.value is not None: - ax = self.ax - # for a transposed plot, we use the barh plot method of the axes - pm = ax.barh if self.transpose.value else ax.bar - alpha = self.alpha.value - if 'stacked' not in slist(self.value): - self._plot = [ - pm(*self.get_xys(arr), facecolor=c, alpha=alpha, - align='edge') - for arr, c in zip(self.iter_data, - self.color.extended_colors)] - if self._set_date: - if self.transpose.value: - ax.yaxis_date() - else: - ax.xaxis_date() - else: # make a stacked plot - if isinstance(self.data, InteractiveList): - df = self.data.to_dataframe() - else: - df = self.data.to_series().to_frame() - try: - df.index = df.index.get_level_values(0) - except AttributeError: - pass - x, y, s = self.get_xys(df.iloc[:, 0].to_xarray()) - self._plot = containers = [] - base = np.zeros_like(y) - for i, (col, c, plot) in enumerate( - zip(df.columns, self.color.extended_colors, - cycle(slist(self.value)))): - if not plot: - continue - y = df.iloc[:, i].values - y = np.where(np.isnan(y), 0, y) - if not i: - containers.append( - pm(x, y, s, facecolor=c, alpha=alpha)) - elif self.transpose.value: - containers.append( - pm(x, y, s, facecolor=c, alpha=alpha, left=base)) - else: - containers.append( - pm(x, y, s, facecolor=c, alpha=alpha, bottom=base)) - base += y - - def get_xys(self, arr): - width = self.widths.value - y = arr.values - self._set_date = False - if self.categorical.is_categorical: - x = np.arange(len(y)) - if width == 'data': - self.logger.warn( - "Cannot use 'data'-based bar width for categorical plots!") - width = 0.5 - elif width == 'equal': - width = 0.5 # pandas default value - elif width == 'data': - x = _infer_interval_breaks(arr.coords[arr.dims[0]].values) - is_datelike = arr.indexes[arr.dims[0]].is_all_dates - s = x[1:] - x[:-1] - if is_datelike: - # convert to datetime - x = to_datetime(x) - # calculate widths in days - s = to_timedelta(s).total_seconds() / 86400. - self._set_date = True - x = x[:-1] - width = s - else: - if width == 'equal': - # Use half of the smalles step - x = _infer_interval_breaks(arr.coords[arr.dims[0]].values) - width = np.abs(np.diff(x)).min() / 2 - x = arr.coords[arr.dims[0]].values - return x, y, width - - -class ViolinXTicks(XTicks): - - __doc__ = XTicks.__doc__ - - @property - def array(self): - if not self.transpose.value: - return np.array(list(range(len(self.data)))) - return super(ViolinXTicks, self).array - - -class ViolinYTicks(YTicks): - - __doc__ = YTicks.__doc__ - - @property - def array(self): - if self.transpose.value: - return np.array(list(range(len(self.data)))) - return super(ViolinYTicks, self).array - - -class ViolinXTickLabels(XTickLabels, TextBase): - __doc__ = XTickLabels.__doc__ - - data_dependent = True - - def update_axis(self, value): - if self.transpose.value or value is None: - return super(ViolinXTickLabels, self).update_axis(value) - if isinstance(value, six.string_types): - self.set_ticklabels([ - self.replace(value, arr, self.get_enhanced_attrs( - arr, replot=True)) for arr in self.data]) - else: - self.set_ticklabels([ - self.replace(val, arr, self.get_enhanced_attrs( - arr, replot=True)) for val, arr in zip(value, self.data)]) - - -class ViolinYTickLabels(YTickLabels, TextBase): - __doc__ = XTickLabels.__doc__ - - data_dependent = True - - def update_axis(self, value): - if self.transpose.value or value is None: - return super(ViolinYTickLabels, self).update_axis(value) - if isinstance(value, six.string_types): - self.set_ticklabels([ - self.replace(value, arr, self.get_enhanced_attrs( - arr, replot=True)) for arr in self.data]) - else: - self.set_ticklabels([ - self.replace(val, arr, self.get_enhanced_attrs( - arr, replot=True)) for val, arr in zip(value, self.data)]) - - -class ViolinPlot(Formatoption): - """ - Choose how to make the violin plot - - Possible types - -------------- - None or False - Don't make any plotting - bool - If True, visualize the violins - """ - - plot_fmt = True - - group = 'plotting' - - priority = BEFOREPLOTTING - - children = ['color', 'transpose'] - - name = 'Violin plot type' - - def __init__(self, *args, **kwargs): - Formatoption.__init__(self, *args, **kwargs) - self._kwargs = {} - - def update(self, value): - # the real plot making is done by make_plot - pass - - def remove(self): - for artist in self._plot: - artist.remove() - del self._plot - - def make_plot(self): - if hasattr(self, '_plot'): - self.remove() - if self.value: - from seaborn import violinplot - if isinstance(self.data, InteractiveList): - df = self.data.to_dataframe() - else: - df = self.data.to_series().to_frame() - old_artists = self.ax.containers[:] + self.ax.lines[:] \ - + self.ax.collections[:] - palette = list(islice(self.color.extended_colors, df.shape[1])) - violinplot(data=df, palette=palette, ax=self.ax, - orient='h' if self.transpose.value else 'v', - **self._kwargs) - artists = self.ax.containers + self.ax.lines + self.ax.collections - self._plot = [ - artist for artist in artists - if artist not in old_artists] - - -@docstrings.get_sections(base='LimitBase') -@dedent -class LimitBase(DataTicksCalculator): - """ - Base class for x- and y-limits - - Possible types - -------------- - None - To not change the current limits - str or list [str, str] or [[str, float], [str, float]] - Automatically determine the ticks corresponding to the data. The given - string determines how the limits are calculated. The float determines - the percentile to use - A string can be one of the following: - - rounded - Sets the minimum and maximum of the limits to the rounded data - minimum or maximum. Limits are rounded to the next 0.5 value with - to the difference between data max- and minimum. The minimum - will always be lower or equal than the data minimum, the maximum - will always be higher or equal than the data maximum. - roundedsym - Same as `rounded` above but the limits are chosen such that they - are symmetric around zero - minmax - Uses the minimum and maximum - sym - Same as minmax but symmetric around zero - tuple (xmin, xmax) - `xmin` is the smaller value, `xmax` the larger. Any of those values can - be None or one of the strings (or lists) above to use the corresponding - value here - """ - - group = 'axes' - - children = ['transpose'] - - connections = ['plot'] - - @property - def value2share(self): - return self.range - - @abstractmethod - def set_limit(self, min_val, max_val): - """The method to set the minimum and maximum limit - - Parameters - ---------- - min_val: float - The value for the lower limit - max_val: float - The value for the upper limit""" - pass - - def __init__(self, *args, **kwargs): - super(LimitBase, self).__init__(*args, **kwargs) - self._calc_funcs = { - 'rounded': self._round_min_max, - 'roundedsym': self._roundedsym_min_max, - 'minmax': self._min_max, - 'sym': self._sym_min_max} - - def _round_min_max(self, vmin, vmax): - try: - exp = np.floor(np.log10(abs(vmax - vmin))) - larger = round_to_05([vmin, vmax], exp, mode='l') - smaller = round_to_05([vmin, vmax], exp, mode='s') - except TypeError: - self.logger.debug("Failed to calculate rounded limits!", - exc_info=True) - return vmin, vmax - return min([larger[0], smaller[0]]), max([larger[1], smaller[1]]) - - def _min_max(self, vmin, vmax): - return vmin, vmax - - def _roundedsym_min_max(self, vmin, vmax): - vmax = max(map(abs, self._round_min_max(vmin, vmax))) - return -vmax, vmax - - def _sym_min_max(self, vmin, vmax): - vmax = max(abs(vmin), abs(vmax)) - return -vmax, vmax - - def update(self, value): - value = list(value) - value_lists = list(map(slist, value)) - kwargs = {} - for kw, l in zip(['percmin', 'percmax'], value_lists): - if len(l) == 2: - kwargs[kw] = l[1] - vmin, vmax = self._calc_vmin_vmax(**kwargs) - if vmin == vmax: - vmax = vmax + 1 - vmin = vmin - 1 - for key, func in self._calc_funcs.items(): - if key in value_lists[0] or key in value_lists[1]: - minmax = func(vmin, vmax) - for i, val in enumerate(value_lists): - if key in val: - value[i] = minmax[i] - self.range = value - self.logger.debug('Setting %s with %s', self.key, value) - self.set_limit(*value) - - -class Xlim(LimitBase): - """ - Set the x-axis limits - - Possible types - -------------- - %(LimitBase.possible_types)s - - See Also - -------- - ylim - """ - - children = LimitBase.children + ['ylim'] - - dependencies = ['xticks'] - - connections = LimitBase.connections + ['sym_lims'] - - axisname = 'x' - - name = 'x-axis limits' - - @property - def array(self): - def select_array(arr): - if arr.ndim > 1: - return arr.psy[0] - return arr - data = list(getattr(self.plot, 'plotted_data', self.iter_data)) or \ - self.iter_data - df = InteractiveList(map(select_array, data)).to_dataframe() - if (self.transpose.value and 'stacked' in slist(self.plot.value)): - summed = df.sum(axis=1).values - arr = np.concatenate( - [[min(summed.min(), 0)], df.sum(axis=1).values]) - elif self.transpose.value: - arr = df.values[df.notnull().values] - else: - arr = _get_index_vals(df.index) - try: - arr.astype(float) - except (ValueError, TypeError): - arr = np.arange(len(arr)) - return arr - - def set_limit(self, *args): - if self.ax.xaxis_inverted(): - args = reversed(args) - try: - self.ax.set_xlim(*args) - except (AttributeError, TypeError): # np.datetime64 - self.ax.set_xlim(*to_datetime(args)) - - def initialize_plot(self, value): - super(Xlim, self).initialize_plot(value) - self.transpose.swap_funcs['limits'] = self._swap_limits - - def _swap_limits(self): - self.transpose._swap_limits() - old_xlim = self.value - with self.plotter.no_validation: - self.plotter[self.key] = self.ylim.value - self.plotter[self.ylim.key] = old_xlim - - -class Ylim(LimitBase): - """ - Set the y-axis limits - - Possible types - -------------- - %(LimitBase.possible_types)s - - See Also - -------- - xlim - """ - children = LimitBase.children + ['xlim'] - - dependencies = ['yticks'] - - connections = LimitBase.connections + ['sym_lims'] - - axisname = 'y' - - name = 'y-axis limits' - - @property - def array(self): - def select_array(arr): - if arr.ndim > 1: - return arr.psy[0] - return arr - data = list(getattr(self.plot, 'plotted_data', self.iter_data)) or \ - self.iter_data - df = InteractiveList(map(select_array, data)).to_dataframe() - if (not self.transpose.value and 'stacked' in slist(self.plot.value)): - summed = df.sum(axis=1).values - arr = np.concatenate( - [[min(summed.min(), 0)], df.sum(axis=1).values]) - elif self.transpose.value: - arr = _get_index_vals(df.index) - else: - arr = df.values[df.notnull().values] - try: - arr.astype(float) - except ValueError: - return np.arange(len(arr)) - return arr - - def set_limit(self, *args): - if self.ax.yaxis_inverted(): - args = reversed(args) - try: - self.ax.set_ylim(*args) - except (AttributeError, TypeError): # np.datetime64 - self.ax.set_ylim(*to_datetime(args)) - - -class SymmetricLimits(Formatoption): - """ - Make x- and y-axis symmetric - - Possible types - -------------- - None - No symmetric type - 'min' - Use the minimum of x- and y-limits - 'max' - Use the maximum of x- and y-limits - [str, str] - A combination, ``None``, ``'min'`` and ``'max'`` specific for minimum - and maximum limit - """ - - dependencies = ['xlim', 'ylim'] - - name = 'Symmetric x- and y-axis limits' - - def update(self, value): - if all(v is None for v in value): - return - xlim = self.xlim.range[:] - ylim = self.ylim.range[:] - for i, v in enumerate(value): - if v == 'min': - xlim[i] = ylim[i] = min(xlim[i], ylim[i]) - elif v == 'max': - xlim[i] = ylim[i] = max(xlim[i], ylim[i]) - self.xlim.set_limit(*xlim) - self.ylim.set_limit(*ylim) - - -class ViolinXlim(Xlim): - # xlim class for ViolinPlotter - __doc__ = Xlim.__doc__ - - @property - def array(self): - if not self.transpose.value: - return np.array( - [-0.5, len(list(self.iter_data)) - 0.5]) - return super(ViolinXlim, self).array - - def _round_min_max(self, *args, **kwargs): - if not self.transpose.value: - return self.array - return super(ViolinXlim, self)._round_min_max(*args, **kwargs) - - -class BarXlim(ViolinXlim): - # xlim class for bar plotter - __doc__ = Xlim.__doc__ - - dependencies = ViolinXlim.dependencies + ['categorical'] - - @property - def array(self): - def select_array(arr): - if arr.ndim > 1: - return arr.psy[0] - return arr - categorical = self.categorical.is_categorical - if self.transpose.value and 'stacked' in slist(self.plot.value): - data = list(getattr(self.plot, 'plotted_data', - self.iter_data)) or self.iter_data - df = InteractiveList(map(select_array, data)).to_dataframe() - summed = df.sum(axis=1).values - return np.concatenate( - [[min(summed.min(), 0)], df.sum(axis=1).values]) - elif categorical and not self.transpose.value: - return np.array( - [-0.5, len(self.data.to_dataframe().index) - 0.5]) - elif not categorical: - return _infer_interval_breaks(Xlim.array.fget(self)) - return super(BarXlim, self).array - - def _round_min_max(self, *args, **kwargs): - if not self.categorical.is_categorical: - return Xlim._round_min_max(self, *args, **kwargs) - else: - return super(BarXlim, self)._round_min_max(*args, **kwargs) - - -class Xlim2D(Xlim): - __doc__ = Xlim.__doc__ - - @property - def array(self): - xcoord = self.transpose.get_x(self.data) - func = 'get_x' if not self.transpose.value else 'get_y' - data = next(self.iter_data) - if xcoord.name == getattr(self.decoder, func)(data).name: - bounds = self.decoder.get_cell_node_coord( - data, axis='x', coords=data.coords) - if bounds is None: - bounds = xcoord - if self.plotter.convert_radian: - bounds = convert_radian(bounds, xcoord, bounds) - return bounds.values.ravel() - return self.decoder.get_plotbounds(xcoord) - - -class Ylim2D(Ylim): - __doc__ = Ylim.__doc__ - - @property - def array(self): - ycoord = self.transpose.get_y(self.data) - func = 'get_x' if self.transpose.value else 'get_y' - data = next(self.iter_data) - if ycoord.name == getattr(self.decoder, func)(data).name: - bounds = self.decoder.get_cell_node_coord( - data, axis='y', coords=data.coords) - if bounds is None: - bounds = ycoord - if self.plotter.convert_radian: - bounds = convert_radian(bounds, ycoord, bounds) - return bounds.values.ravel() - return self.decoder.get_plotbounds(self.transpose.get_y(self.data)) - - -class ViolinYlim(Ylim): - # Ylim class for ViolinPlotter - __doc__ = Ylim.__doc__ - - @property - def array(self): - if self.transpose.value: - return np.array( - [-0.5, len(list(self.iter_data)) - 0.5]) - return super(ViolinYlim, self).array - - def _round_min_max(self, *args, **kwargs): - if self.transpose.value: - return self.array - return super(ViolinYlim, self)._round_min_max(*args, **kwargs) - - -class BarYlim(ViolinYlim): - # ylim class for bar plotter - __doc__ = Ylim.__doc__ - - dependencies = ViolinYlim.dependencies + ['categorical'] - - @property - def array(self): - def select_array(arr): - if arr.ndim > 1: - return arr.psy[0] - return arr - categorical = self.categorical.is_categorical - if not self.transpose.value and 'stacked' in slist(self.plot.value): - data = list(getattr(self.plot, 'plotted_data', - self.iter_data)) or self.iter_data - df = InteractiveList(map(select_array, data)).to_dataframe() - summed = df.sum(axis=1).values - return np.concatenate( - [[min(summed.min(), 0)], df.sum(axis=1).values]) - elif categorical and self.transpose.value: - return np.array( - [-0.5, len(self.data.to_dataframe().index) - 0.5]) - elif not categorical and self.transpose.value: - return _infer_interval_breaks(Ylim.array.fget(self)) - elif not categorical: - return Ylim.array.fget(self) - return super(BarYlim, self).array - - def _round_min_max(self, *args, **kwargs): - if not self.categorical.is_categorical: - return Ylim._round_min_max(self, *args, **kwargs) - else: - return super(BarYlim, self)._round_min_max(*args, **kwargs) - - -class XRotation(Formatoption): - """ - Rotate the x-axis ticks - - Possible types - -------------- - float - The rotation angle in degrees - - See Also - -------- - yrotation""" - - group = 'ticks' - - children = ['yticklabels'] - - name = 'Rotate x-ticklabels' - - def update(self, value): - for text in self.ax.get_xticklabels(which='both'): - text.set_rotation(value) - - -class YRotation(Formatoption): - """ - Rotate the y-axis ticks - - Possible types - -------------- - float - The rotation angle in degrees - - See Also - -------- - xrotation""" - - group = 'ticks' - - children = ['yticklabels'] - - name = 'Rotate y-ticklabels' - - def update(self, value): - for text in self.ax.get_yticklabels(which='both'): - text.set_rotation(value) - - -class CMap(Formatoption): - """ - Specify the color map - - This formatoption specifies the color coding of the data via a - :class:`matplotlib.colors.Colormap` - - Possible types - -------------- - str - %(cmap_note)s - matplotlib.colors.Colormap - The colormap instance to use - - See Also - -------- - bounds: specifies the boundaries of the colormap""" - - group = 'colors' - - priority = BEFOREPLOTTING - - name = 'Colormap' - - connections = ['bounds', 'cbar'] # necessary for get_fmt_widget - - def get_cmap(self, arr=None, cmap=None, N=None): - """Get the :class:`matplotlib.colors.Colormap` for plotting - - Parameters - ---------- - arr: np.ndarray - The array to plot - cmap: str or matplotlib.colors.Colormap - The colormap to use. If None, the :attr:`value` of this - formatoption is used - N: int - The number of colors in the colormap. If None, the norm of the - :attr:`bounds` formatoption is used and, if necessary, the - given array `arr` - - Returns - ------- - matplotlib.colors.Colormap - The colormap returned by :func:`psy_simple.colors.get_cmap`""" - N = N or None - if cmap is None: - cmap = self.value - if N is None: - try: - N = self.bounds.norm.Ncmap - except AttributeError: - if arr is not None and self.bounds.norm is not None: - N = len(np.unique(self.bounds.norm(arr.ravel()))) - if N is not None: - return get_cmap(cmap, N) - return get_cmap(cmap) - - def update(self, value): - pass # the colormap is set when plotting - - def get_fmt_widget(self, parent, project): - """Open a :class:`psy_simple.widget.CMapFmtWidget`""" - from psy_simple.widgets.colors import CMapFmtWidget - return CMapFmtWidget(parent, self, project) - - -class MissColor(Formatoption): - """ - Set the color for missing values - - Possible types - -------------- - None - Use the default from the colormap - string, tuple. - Defines the color of the grid.""" - - group = 'colors' - - priority = END - - dependencies = ['plot'] - - connections = ['transform'] - - name = 'Color of missing values' - - update_after_plot = True - - def update(self, value): - if self.plotter.replot: - self.remove() - if self.plot.value is None: - return - elif value is not None and self.plot.value == 'contourf': - warn('[%s] - The miss_color formatoption is not supported for ' - 'filled contour plots!' % self.logger.name) - mappable = self.plot.mappable - if value is not None: - mappable.get_cmap().set_bad(value) - else: - mappable.get_cmap().set_bad(alpha=0) - mappable.changed() - - def remove(self): - if hasattr(self, '_miss_color_plot'): - try: - self._miss_color_plot.remove() - del self._miss_color_plot - except ValueError: - pass - - -@docstrings.get_sections(base='Bounds', sections=['Possible types', 'Examples', - 'See Also']) -class Bounds(DataTicksCalculator): - """ - Specify the boundaries of the colorbar - - Possible types - -------------- - None - make no normalization - %(DataTicksCalculator.possible_types)s - int - Specifies how many ticks to use with the ``'rounded'`` option. I.e. if - integer ``i``, then this is the same as ``['rounded', i]``. - matplotlib.colors.Normalize - A matplotlib normalization instance - - Examples - -------- - - Plot 11 bounds over the whole data range:: - - >>> plotter.update(bounds='rounded') - - which is equivalent to:: - - >>> plotter.update(bounds={'method': 'rounded'}) - - - Plot 7 ticks over the whole data range where the maximal and minimal - tick matches the data maximum and minimum:: - - >>> plotter.update(bounds=['minmax', 7]) - - which is equivaluent to:: - - >>> plotter.update(bounds={'method': 'minmax', 'N': 7}) - - - chop the first and last five percentiles:: - - >>> plotter.update(bounds=['rounded', None, 5, 95]) - - which is equivalent to:: - - >>> plotter.update(bounds={'method': 'rounded', 'percmin': 5, - ... 'percmax': 95}) - - - Plot 3 bounds per power of ten:: - - >>> plotter.update(bounds=['log', 3]) - - - Plot continuous logarithmic bounds:: - - >>> from matplotlib.colors import LogNorm - >>> plotter.update(bounds=LogNorm()) - - - See Also - -------- - cmap: Specifies the colormap""" - - group = 'colors' - - priority = BEFOREPLOTTING - - name = 'Boundaries of the color map' - - connections = ['cmap', 'cbar'] # necessary for get_fmt_widget - - @property - def value2share(self): - """The normalization instance""" - if len(self.bounds) > 1: - return list(self.bounds) - return self.norm - - def update(self, value): - if value is None or isinstance(value, mpl.colors.Normalize): - self.norm = value - self.bounds = [0] - else: - if isinstance(value[0], six.string_types): - value = self.calc_funcs[value[0]](*value[1:]) - self.bounds = value - self.norm = mpl.colors.BoundaryNorm( - value, len(value) - 1) - - def get_fmt_widget(self, parent, project): - """Open a :class:`psy_simple.widget.CMapFmtWidget`""" - from psy_simple.widgets.colors import BoundsFmtWidget - return BoundsFmtWidget(parent, self, project) - - -def format_coord_func(ax, ref): - """Create a function that can replace the - :func:`matplotlib.axes.Axes.format_coord` - - Parameters - ---------- - ax: matplotlib.axes.Axes - The axes instance - ref: weakref.weakref - The reference to the :class:`~psyplot.plotter.Formatoption` instance - - Returns - ------- - function - The function that can be used to replace `ax.format_coord` - """ - orig_format_coord = ax.format_coord - - def func(x, y): - orig_s = orig_format_coord(x, y) - fmto = ref() - if fmto is None: - return orig_s - try: - orig_s += fmto.add2format_coord(x, y) - except Exception: - fmto.logger.debug( - 'Failed to get plot informations for status bar!', exc_info=1) - return orig_s - - return func - - -class InterpolateBounds(Formatoption): - """ - Interpolate grid cell boundaries for 2D plots - - This formatoption can be used to tell enable and disable the interpolation - of grid cell boundaries. Usually, netCDF files only contain the centered - coordinates. In this case, we interpolate the boundaries between the - grid cell centers. - - Possible types - -------------- - None - Interpolate the boundaries, except for circumpolar grids - bool - If True (the default), the grid cell boundaries are inter- and - extrapolated. Otherwise, if False, the coordinate centers are used and - the default behaviour of matplotlib cuts of the most outer row and - column of the 2D-data. Note that this results in a slight shift of the - data - """ - - priority = BEFOREPLOTTING - - def update(self, value): - pass - - -@docstrings.get_sections(base='Plot2D') -class Plot2D(Formatoption): - """ - Choose how to visualize a 2-dimensional scalar data field - - Possible types - -------------- - None - Don't make any plotting - 'mesh' - Use the :func:`matplotlib.pyplot.pcolormesh` function to make the plot - or the :func:`matplotlib.pyplot.tripcolor` for an unstructered grid - 'poly' - Draw each polygon indivually. This method is used by default for - unstructured grids. If there are no grid cell boundaries in the - dataset, we will interpolate them - 'contourf' - Make a filled contour plot using the :func:`matplotlib.pyplot.contourf` - function or the :func:`matplotlib.pyplot.tricontourf` for unstructured - data. The levels for the contour plot are controlled by the - :attr:`levels` formatoption - 'contour' - Same a ``'contourf'``, but does not make a filled contour plot, only - lines. - """ - - plot_fmt = True - - group = 'plotting' - - priority = BEFOREPLOTTING - - name = '2D plot type' - - children = ['cmap', 'bounds'] - - dependencies = ['levels', 'interp_bounds'] - - @property - def array(self): - """The (masked) data array that is plotted""" - arr = self.data.values - return np.ma.masked_array(arr, mask=np.isnan(arr)) - - @property - def notnull_array(self): - """The data array that is plotted""" - arr = self.data.values - return arr[~np.isnan(arr)] - - @property - def xbounds(self): - """Boundaries of the x-coordinate""" - data = self.data - coord = self.decoder.get_x(data, coords=data.coords) - return self.decoder.get_plotbounds(coord) - - @property - def ybounds(self): - """Boundaries of the y-coordinate""" - data = self.data - coord = self.decoder.get_y(data, coords=data.coords) - return self.decoder.get_plotbounds(coord) - - @property - def xcoord(self): - """The x coordinate :class:`xarray.Variable`""" - return self.decoder.get_x(self.data, coords=self.data.coords) - - @property - def ycoord(self): - """The y coordinate :class:`xarray.Variable`""" - return self.decoder.get_y(self.data, coords=self.data.coords) - - @property - def mappable(self): - """Returns the mappable that can be used for colorbars""" - return self._plot - - @property - def format_coord(self): - """The function that can replace the axes.format_coord method""" - return format_coord_func(self.ax, weakref.ref(self)) - - def __init__(self, *args, **kwargs): - Formatoption.__init__(self, *args, **kwargs) - self._plot_funcs = { - 'mesh': self._pcolormesh, - 'contourf': self._contourf, - 'contour': self._contourf, - 'poly': self._polycolor, - } - self._orig_format_coord = None - self._kwargs = {} - - def update(self, value): - # the real plot making is done by make_plot - pass - - def make_plot(self): - # remove the plot if it shall be replotted or any of the dependencies - # changed - if self.plotter.replot or any( - self.plotter.has_changed(key) for key in chain( - self.connections, self.dependencies, [self.key])): - self.remove() - if self.value is not None: - if self.value == 'tri': - warn("The 'tri' value is depreceated and will be removed " - "in the future. Use 'poly' instead!", - DeprecationWarning) - self._plot_funcs[self.value]() - if self._orig_format_coord is None: - self._orig_format_coord = self.ax.format_coord - self.ax.format_coord = self.format_coord - - def _pcolormesh(self): - if self.decoder.is_unstructured(self.raw_data): - return self._polycolor() - arr = self.array - cmap = self.cmap.get_cmap(arr) - if hasattr(self, '_plot'): - self._plot.update(dict(cmap=cmap, norm=self.bounds.norm)) - # for cartopy, we have to consider the wrapped collection if the - # data has to be transformed - try: - coll = self._plot._wrapped_collection_fix - except AttributeError: - pass - else: - coll.update(dict(cmap=cmap, norm=self.bounds.norm)) - else: - x, y = self._get_xy_pcolormesh() - self._plot = self.ax.pcolormesh( - x, y, arr, norm=self.bounds.norm, - cmap=cmap, rasterized=True, **self._kwargs) - - def _get_xy_pcolormesh(self): - interp_bounds = self.interp_bounds.value - if interp_bounds is None and not self.decoder.is_circumpolar( - self.raw_data): - interp_bounds = True - if interp_bounds: - return self.xbounds, self.ybounds - else: - return self.xcoord.values, self.ycoord.values - - def _contourf(self): - if hasattr(self, '_plot') and self.plotter.has_changed( - self.levels.key): - self.remove() - arr = self.array - cmap = self.cmap.get_cmap(arr) - filled = self.value not in ['contour', 'tricontour'] - if hasattr(self, '_plot'): - self._plot.set_cmap(cmap) - self._plot.set_norm(self.bounds.norm) - else: - levels = self.levels.norm.boundaries - xcoord = self.xcoord - ycoord = self.ycoord - if self.plotter.convert_radian: - xcoord = convert_radian(xcoord, xcoord) - ycoord = convert_radian(ycoord, ycoord) - if (self.value in ['tricontourf', 'tricontour'] or - self.decoder.is_unstructured(self.raw_data)): - pm = self.ax.tricontourf if filled else self.ax.tricontour - mask = ~np.isnan(arr) - x = xcoord.values[mask] - y = ycoord.values[mask] - arr = arr[mask] - else: - pm = self.ax.contourf if filled else self.ax.contour - x = xcoord.values - y = ycoord.values - self._plot = pm( - x, y, arr, levels, norm=self.bounds.norm, - cmap=cmap, **self._kwargs) - - @property - def cell_nodes_x(self): - """The unstructured x-boundaries with shape (N, m) where m > 2""" - decoder = self.decoder - xcoord = self.xcoord - data = self.data - xbounds = decoder.get_cell_node_coord( - data, coords=data.coords, axis='x') - if self.plotter.convert_radian: - xbounds = convert_radian(xbounds, xcoord, xbounds) - return xbounds.values - - @property - def cell_nodes_y(self): - """The unstructured y-boundaries with shape (N, m) where m > 2""" - decoder = self.decoder - ycoord = self.ycoord - data = self.data - ybounds = decoder.get_cell_node_coord( - data, coords=data.coords, axis='y') - if self.plotter.convert_radian: - ybounds = convert_radian(ybounds, ycoord, ybounds) - return ybounds.values - - def _polycolor(self): - from matplotlib.collections import PolyCollection - self.logger.debug('Retrieving bounds') - xbounds = self.cell_nodes_x - ybounds = self.cell_nodes_y - self.logger.debug('Retrieving data') - arr = self.array - cmap = self.cmap.get_cmap(arr) - if hasattr(self, '_plot'): - self.logger.debug('Updating plot') - self._plot.update(dict(cmap=cmap, norm=self.bounds.norm)) - else: - self.logger.debug('Making plot with %i cells', arr.size) - if xbounds.ndim > 2: - xbounds = xbounds.reshape((-1, xbounds.shape[-1])) - ybounds = ybounds.reshape((-1, ybounds.shape[-1])) - self._plot = PolyCollection( - np.dstack([xbounds, ybounds]), array=arr.ravel(), - norm=self.bounds.norm, rasterized=True, cmap=cmap, - edgecolors='none', antialiaseds=False, **self._kwargs) - self.logger.debug('Adding collection to axes') - self.ax.add_collection(self._plot, autolim=False) - self.logger.debug('Done.') - - def remove(self): - if hasattr(self, '_plot'): - try: - self._plot.remove() - except AttributeError: # contour plot - for artist in self._plot.collections[:]: - try: - artist.remove() - except ValueError: - pass - del self._plot - - def add2format_coord(self, x, y): - """Additional information for the :meth:`format_coord`""" - if self.value is None: - return '' - data = self.data - xcoord = self.xcoord - ycoord = self.ycoord - if self.decoder.is_unstructured(self.raw_data): - x, y, z = self.get_xyz_tri(xcoord, x, ycoord, y, data) - elif xcoord.ndim == 1: - x, y, z = self.get_xyz_1d(xcoord, x, ycoord, y, data) - elif xcoord.ndim == 2: - x, y, z = self.get_xyz_2d(xcoord, x, ycoord, y, data) - if z is None: - return '' - xunit = xcoord.attrs.get('units', '') - if xunit: - xunit = ' ' + xunit - yunit = ycoord.attrs.get('units', '') - if yunit: - yunit = ' ' + yunit - zunit = data.attrs.get('units', '') - if zunit: - zunit = ' ' + zunit - return ', data: %s: %.4g%s, %s: %.4g%s, %s: %.4g%s' % ( - xcoord.name, x, xunit, ycoord.name, y, yunit, - data.name, z, zunit) - - def get_xyz_tri(self, xcoord, x, ycoord, y, data): - """Get closest x, y and z for the given `x` and `y` in `data` for - 1d coords""" - return self.get_xyz_2d(xcoord, x, ycoord, y, data) - - def get_xyz_1d(self, xcoord, x, ycoord, y, data): - """Get closest x, y and z for the given `x` and `y` in `data` for - 1d coords""" - x_idx = xcoord.indexes[xcoord.name] - y_idx = ycoord.indexes[ycoord.name] - xclose = x_idx.get_loc(x, method='nearest') - yclose = y_idx.get_loc(y, method='nearest') - dx_max = np.diff(x_idx.sort_values()).max() - dy_max = np.diff(y_idx.sort_values()).max() - - x_data = xcoord[xclose].values - y_data = ycoord[yclose].values - if abs(x_data - x) > dx_max or abs(y_data - y) > dy_max: - val = None - else: - val = data[yclose, xclose].values - return x_data, y_data, val - - def get_xyz_2d(self, xcoord, x, ycoord, y, data): - """Get closest x, y and z for the given `x` and `y` in `data` for - 2d coords""" - xy = xcoord.values.ravel() + 1j * ycoord.values.ravel() - dist = np.abs(xy - (x + 1j * y)) - imin = np.nanargmin(dist) - xy_min = xy[imin] - - xb = self.decoder.get_cell_node_coord( - data, {xcoord.name: xcoord, ycoord.name: ycoord}, - axis='x') - yb = self.decoder.get_cell_node_coord( - data, {xcoord.name: xcoord, ycoord.name: ycoord}, - axis='y') - - dx_max = np.diff(xb).max() - dy_max = np.diff(yb).max() - - x_data = xy_min.real - y_data = xy_min.imag - - if abs(x_data - x) > dx_max or abs(y_data - y) > dy_max: - val = None - else: - val = data.values.ravel()[imin] - - return x_data, y_data, val - - -docstrings.delete_types('Bounds.possible_types', 'no_norm|None', - 'None', 'matplotlib.colors.Normalize') - - -class ContourLevels(Bounds): - """ - The levels for the contour plot - - This formatoption sets the levels for the filled contour plot and only has - an effect if the :attr:`plot` Formatoption is set to ``'contourf'`` - - Possible types - -------------- - None - Use the settings from the :attr:`bounds` formatoption and if this - does not specify boundaries, use 11 - %(Bounds.possible_types.no_norm|None)s - """ - - dependencies = ['cbounds'] - - priority = BEFOREPLOTTING - - name = 'Levels for the filled contour plot' - - def update(self, value): - if value is None: - try: - value = self.cbounds.norm.boundaries - except AttributeError: - value = ['rounded', 11] - super(ContourLevels, self).update(value) - - -class MaskDataGrid(Formatoption): - """Mask the datagrid where the array is NaN - - This boolean formatoption enables to mask the grid of the :attr:`datagrid` - formatoption where the data is NaN - - Possible types - -------------- - bool - Either True, to not display the data grid for cells with NaN, or False - - See Also - -------- - datagrid""" - - def update(self, value): - """dummy, since this fmt is considered in the :class:`DataGrid ` fmt""" - pass - - - -class DataGrid(Formatoption): - """ - Show the grid of the data - - This formatoption shows the grid of the data (without labels) - - Possible types - -------------- - None - Don't show the data grid - str - A linestyle in the form ``'k-'``, where ``'k'`` is the color and - ``'-'`` the linestyle. - dict - any keyword arguments that are passed to the plotting function ( - :func:`matplotlib.pyplot.triplot` for unstructured grids and - :func:`matplotlib.pyplot.hlines` for rectilinear grids) - - See Also - -------- - mask_datagrid: To display cells with NaN""" - - children = ['transform'] - - dependencies = ['mask_datagrid'] - - connections = ['plot'] - - name = 'Grid of the data' - - @property - def xcoord(self): - """The x coordinate :class:`xarray.Variable`""" - return self.decoder.get_x(self.data, coords=self.data.coords) - - @property - def ycoord(self): - """The y coordinate :class:`xarray.Variable`""" - return self.decoder.get_y(self.data, coords=self.data.coords) - - @property - def xbounds(self): - """Boundaries of the x-coordinate""" - return self.decoder.get_plotbounds(self.xcoord) - - @property - def ybounds(self): - """Boundaries of the y-coordinate""" - return self.decoder.get_plotbounds(self.ycoord) - - @property - def cell_nodes_x(self): - """The unstructured x-boundaries with shape (N, m) where m > 2""" - decoder = self.decoder - xcoord = self.xcoord - data = self.data - xbounds = decoder.get_cell_node_coord( - data, coords=data.coords, axis='x', - nans='skip' if self.mask_datagrid.value else None) - if self.plotter.convert_radian: - xbounds = convert_radian(xbounds, xcoord, xbounds) - return xbounds.values - - @property - def cell_nodes_y(self): - """The unstructured y-boundaries with shape (N, m) where m > 2""" - decoder = self.decoder - ycoord = self.ycoord - data = self.data - ybounds = decoder.get_cell_node_coord( - data, coords=data.coords, axis='y', - nans='skip' if self.mask_datagrid.value else None) - if self.plotter.convert_radian: - ybounds = convert_radian(ybounds, ycoord, ybounds) - return ybounds.values - - def __init__(self, *args, **kwargs): - """ - Parameters - ---------- - %(Formatoption.parameters)s""" - super(DataGrid, self).__init__(*args, **kwargs) - self._kwargs = {} - - def update(self, value): - self.remove() - if value is not None: - xb = self.cell_nodes_x - yb = self.cell_nodes_y - if xb.ndim > 2: - xb = xb.reshape((-1, xb.shape[-1])) - yb = yb.reshape((-1, yb.shape[-1])) - n = len(xb) - xb = np.c_[xb, xb[:, :1], [[np.nan]] * n].ravel() - yb = np.c_[yb, yb[:, :1], [[np.nan]] * n].ravel() - if isinstance(value, dict): - self._artists = self.ax.plot(xb, yb, **value) - else: - self._artists = self.ax.plot(xb, yb, value) - - def remove(self): - if not hasattr(self, '_artists'): - return - for artist in self._artists: - artist.remove() - del self._artists - - -class VectorDataGrid(DataGrid): - - @property - def data(self): - return super().data[0] - - -class SimplePlot2D(Plot2D): - """ - Specify the plotting method - - Possible types - -------------- - None - Don't make any plotting - 'mesh' - Use the :func:`matplotlib.pyplot.pcolormesh` function to make the plot - """ - - dependencies = Plot2D.dependencies + ['transpose'] - - @property - def array(self): - if self.transpose.value: - return super(SimplePlot2D, self).array.T - else: - return super(SimplePlot2D, self).array - - @property - def xbounds(self): - return self.decoder.get_plotbounds(self.transpose.get_x( - self.data)) - - @property - def ybounds(self): - return self.decoder.get_plotbounds(self.transpose.get_y( - self.data)) - - @property - def xcoord(self): - if self.transpose.value: - return super(SimplePlot2D, self).ycoord - return super(SimplePlot2D, self).xcoord - - @property - def ycoord(self): - if self.transpose.value: - return super(SimplePlot2D, self).xcoord - return super(SimplePlot2D, self).ycoord - - @property - def cell_nodes_x(self): - if self.transpose.value: - return super(SimplePlot2D, self).cell_nodes_y - return super(SimplePlot2D, self).cell_nodes_x - - @property - def cell_nodes_y(self): - if self.transpose.value: - return super(SimplePlot2D, self).cell_nodes_x - return super(SimplePlot2D, self).cell_nodes_y - - -class XTicks2D(XTicks): - - __doc__ = XTicks.__doc__ - - @property - def data(self): - data = [] - plot_data = super(XTicks, self).data - if not isinstance(plot_data, InteractiveList): - plot_data = [plot_data] - for da in plot_data: - data.append(self.transpose.get_x(da)) - if len(data) == 1: - return data[0] - try: - return xr.concat(data) - except Exception: - self.logger.debug( - 'Failed to concatenate the data, returning first object!', - exc_info=True) - return data[0] - - -class YTicks2D(YTicks): - - __doc__ = YTicks.__doc__ - - @property - def data(self): - data = [] - plot_data = super(YTicks, self).data - if not isinstance(plot_data, InteractiveList): - plot_data = [plot_data] - for da in plot_data: - for da in plot_data: - data.append(self.transpose.get_y(da)) - if len(data) == 1: - return data[0] - try: - return xr.concat(data) - except Exception: - self.logger.debug( - 'Failed to concatenate the data, returning first object!', - exc_info=True) - return data[0] - - -class Extend(Formatoption): - """ - Draw arrows at the side of the colorbar - - Possible types - -------------- - str {'neither', 'both', 'min' or 'max'} - If not 'neither', make pointed end(s) for out-of-range values - """ - - group = 'colors' - - name = 'Ends of the colorbar' - - connections = ['plot'] - - def update(self, value): - # nothing to do here because the extend is set by the Cbar formatoption - if self.plot.value == 'contourf' and value != 'neither': - warn('[%s] - Extend keyword is not implemented for contour ' - 'plots' % self.logger.name) - else: - if self.plot.value is not None: - self.plot.mappable.norm.extend = value - - -class CbarSpacing(Formatoption): - """ - Specify the spacing of the bounds in the colorbar - - Possible types - -------------- - str {'uniform', 'proportional'} - if ``'uniform'``, every color has exactly the same width in the - colorbar, if ``'proportional'``, the size is chosen according to the - data""" - - group = 'colors' - - connections = ['cbar'] - - name = 'Spacing of the colorbar' - - def update(self, value): - self.cbar._kwargs['spacing'] = value - - -@docstrings.get_sections(base='Cbar') -class Cbar(Formatoption): - """ - Specify the position of the colorbars - - Possible types - -------------- - bool - True: defaults to 'b' - False: Don't draw any colorbar - str - The string can be a combination of one of the following strings: - {'fr', 'fb', 'fl', 'ft', 'b', 'r', 'sv', 'sh'} - - - 'b', 'r' stand for bottom and right of the axes - - 'fr', 'fb', 'fl', 'ft' stand for bottom, right, left and top of the - figure - - 'sv' and 'sh' stand for a vertical or horizontal colorbar in a - separate figure - list - A containing one of the above positions - - Examples - -------- - Draw a colorbar at the bottom and left of the axes:: - - >>> plotter.update(cbar='bl')""" - - dependencies = ['plot', 'cmap', 'bounds', 'extend', 'cbarspacing', - 'levels'] - - group = 'colors' - - name = 'Position of the colorbar' - - priority = END + 0.1 - - figure_positions = {'fr', 'fb', 'fl', 'ft', 'b', 'r', 'l', 't'} - - original_position = None - - @property - def init_kwargs(self): - return dict(chain(six.iteritems(super(Cbar, self).init_kwargs), - [('other_cbars', self.other_cbars)])) - - @docstrings.dedent - def __init__(self, *args, **kwargs): - """ - Parameters - ---------- - %(Formatoption.parameters)s - other_cbars: list of str - List of other colorbar formatoption keys (necessary for a - sufficient resizing of the axes)""" - self.other_cbars = kwargs.pop('other_cbars', []) - super(Cbar, self).__init__(*args, **kwargs) - self._kwargs = {} - self._just_drawn = set() - - def initialize_plot(self, value): - self._set_original_position() - self.cbars = {} - super(Cbar, self).initialize_plot(value) - - def _set_original_position(self): - """Gets and sets the original position of the axes without colorbar""" - # this is somewhat a hack to make sure that we get the right position - # although the figure has not been drawn so far - for key in self.other_cbars: - fmto = getattr(self.plotter, key, None) - if fmto is not None and fmto.original_position: - self.original_position = fmto.original_position - return - ax = self.ax - if ax._adjustable in ['box', 'box-forced']: - figW, figH = ax.get_figure().get_size_inches() - fig_aspect = figH / figW - position = ax.get_position(True) - pb = position.frozen() - box_aspect = ax.get_data_ratio() - pb1 = pb.shrunk_to_aspect(box_aspect, pb, fig_aspect) - self.original_position = pb1.anchored(ax.get_anchor(), pb) - else: - self.original_position = ax.get_position(True) - - @property - def value2share(self): - """Those colorbar positions that are directly at the axes""" - return self.value.intersection(['r', 'b', 'l', 't']) - - def update(self, value): - """ - Updates the colorbar - - Parameters - ---------- - value - The value to update (see possible types) - no_fig_cbars - Does not update the colorbars that are not in the axes of this - plot""" - plotter = self.plotter - if plotter.replot or any( - plotter.has_changed(key, False) for key in self.dependencies - if getattr(self, key, None) is not None and key not in [ - self._child_mapping['cmap'], self._child_mapping[ - 'bounds']]): - cbars2delete = set(self.cbars) - else: - changed_bounds = plotter.has_changed(self.bounds.key) - if changed_bounds and (type(changed_bounds[0]) is not - type(changed_bounds[1])): - cbars2delete = set(self.cbars) - else: - cbars2delete = set(self.cbars).difference(value) - if cbars2delete: - # if the colorbars are in the figure of the axes, we have to first - # remove all the colorbars and then redraw it in order to make - # sure that the axes gets the right position - if cbars2delete & self.figure_positions: - cbars2delete.update(self.figure_positions) - self.remove(positions=cbars2delete) - # remove other cbars - for key in self.other_cbars: - fmto = getattr(plotter, key) - fmto.remove(self.figure_positions) - # redraw other cbars - for key in self.other_cbars: - fmto = getattr(plotter, key) - fmto.update(fmto.value) - else: - self.remove(positions=cbars2delete) - for pos in value.intersection(self.cbars): - if self.plot.value is not None: - self.update_colorbar(pos) - for pos in sorted(value.difference(self.cbars)): - if self.plot.value is not None: - self.draw_colorbar(pos) - plotter._figs2draw.update(map(lambda cbar: cbar.ax.get_figure(), - six.itervalues(self.cbars))) - - def update_colorbar(self, pos): - cbar = self.cbars[pos] - mappable = self.plot.mappable - if mpl.__version__ < '3.1': - cbar.set_norm(self.plot.mappable.norm) - cbar.set_cmap(self.plot.mappable.cmap) - else: # change the colorbar and reconnect signals - old = cbar.mappable - cbar.update_normal(mappable) - if not getattr(mappable, 'colorbar_cid', False): - if getattr(old, 'colorbar_cid', False): - old.callbacksSM.disconnect(old.colorbar_cid) - old.colorbar = None - old.colorbar_cid = None - cid = mappable.callbacksSM.connect( - 'changed', cbar.on_mappable_changed) - mappable.colorbar = cbar - mappable.colorbar_cid = cid - cbar.update_normal(cbar.mappable) - cbar.draw_all() - - def remove(self, positions='all'): - import matplotlib.pyplot as plt - - def try2remove(cbar): - try: - cbar.remove() - except KeyError: - # the colorbar has been removed already from some other - # Cbar instance - pass - if positions == 'all': - positions = self.cbars.keys() - positions = set(positions).intersection(self.cbars.keys()) - if not positions: - return - adjustment = {} - to_adjust = {'fr': 'right', 'fl': 'left', 'ft': 'top', 'fb': 'bottom'} - for pos in positions: - cbar = self.cbars.pop(pos) - if pos in ['sh', 'sv']: - plt.close(cbar.ax.get_figure()) - else: - # set the axes for the mappable if this has been removed - mappable = cbar.mappable - delaxes = not hasattr(mappable, 'axes') - if getattr(mappable, 'axes', None) is None: - mappable.axes = self.plotter.ax - try2remove(cbar) - if delaxes: - del mappable.axes - else: - mappable.axes = None - else: - try2remove(cbar) - if pos in to_adjust: - adjustment[to_adjust[pos]] = mpl.rcParams[ - 'figure.subplot.' + to_adjust[pos]] - if adjustment: - self.ax.get_figure().subplots_adjust(**adjustment) - if self.figure_positions.intersection(positions): - self.ax.set_position(self.original_position) - return - - def draw_colorbar(self, pos): - import matplotlib.pyplot as plt - # TODO: Manage to draw colorbars left and top (gridspec does not work) - orientations = { - # 'b': 'bottom', 'r': 'right', 'l': 'left', 't': 'top', - 'b': 'horizontal', 'r': 'vertical', - 'fr': 'vertical', 'fl': 'vertical', 'sv': 'vertical', - 'ft': 'horizontal', 'fb': 'horizontal', 'sh': 'horizontal'} - - orientation = orientations[pos] - kwargs = self._kwargs.copy() - if pos in ['b', 'r', 'l', 't']: - fig = self.ax.get_figure() - # kwargs = {'ax': self.ax, 'location': orientation} - kwargs.update({'ax': self.ax, 'orientation': orientation}) - elif pos == 'sh': - fig = plt.figure(figsize=(8, 1)) - kwargs.update({'cax': fig.add_axes([0.05, 0.5, 0.9, 0.3])}) - self.plotter._figs2draw.add(fig) # add figure for drawing - elif pos == 'sv': - fig = plt.figure(figsize=(1, 8)) - kwargs.update({'cax': fig.add_axes([0.3, 0.05, 0.3, 0.9])}) - self.plotter._figs2draw.add(fig) # add figure for drawing - else: - fig = self.ax.get_figure() - if pos == 'fb': - fig.subplots_adjust(bottom=0.2) - kwargs['cax'] = fig.add_axes( - [0.125, 0.135, 0.775, 0.05], - label=self.raw_data.psy.arr_name + '_fb') - elif pos == 'fr': - fig.subplots_adjust(right=0.8) - kwargs['cax'] = fig.add_axes( - [0.825, 0.25, 0.035, 0.6], - label=self.raw_data.psy.arr_name + '_fr') - elif pos == 'fl': - fig.subplots_adjust(left=0.225) - kwargs['cax'] = fig.add_axes( - [0.075, 0.25, 0.035, 0.6], - label=self.raw_data.psy.arr_name + '_fl') - elif pos == 'ft': - fig.subplots_adjust(top=0.75) - kwargs['cax'] = fig.add_axes( - [0.125, 0.825, 0.775, 0.05], - label=self.raw_data.psy.arr_name + '_ft') - if float('.'.join(mpl.__version__.split('.')[:2])) <= 3.2: - kwargs['extend'] = self.extend.value - if 'location' not in kwargs: - kwargs['orientation'] = orientation - self.cbars[pos] = cbar = fig.colorbar(self.plot.mappable, **kwargs) - self._just_drawn.add(cbar) - self.set_label_pos(pos) - - def set_label_pos(self, pos): - ax = self.cbars[pos].ax - if pos == 'fl': - # draw tick labels left - ax.tick_params('y', labelleft=True, labelright=False) - ax.yaxis.set_label_position('left') - ax.yaxis.tick_left() - elif pos == 'ft': - # draw ticklabels at the top - ax.tick_params('x', labeltop=True, labelbottom=False) - ax.xaxis.set_label_position('top') - ax.xaxis.tick_top() - elif pos == 'r': - # draw ticklabels on the right - ax.tick_params('y', labelleft=False, labelright=True) - ax.yaxis.set_label_position('right') - ax.yaxis.tick_right() - - def finish_update(self): - # Set the label position again in case this has been changed - for pos, cbar in self.cbars.items(): - self.set_label_pos(pos) - self._just_drawn.clear() - - -class CLabel(TextBase, Formatoption): - """ - Show the colorbar label - - Set the label of the colorbar. - %(replace_note)s - - Possible types - -------------- - str - The title for the :meth:`~matplotlib.colorbar.Colorbar.set_label` - method. - - See Also - -------- - clabelsize, clabelweight, clabelprops""" - - children = ['plot'] - - dependencies = ['cbar'] - - name = 'Colorbar label' - - data_dependent = True - - group = 'labels' - - axis_locations = { - 'b': 'x', 'r': 'y', 'l': 'y', 't': 'x', # axes locations - 'fr': 'y', 'fl': 'y', 'sv': 'y', # vertical figure cbars - 'ft': 'x', 'fb': 'x', 'sh': 'x'} # horizontal figure cbars - - def update(self, value): - arr = self.plot.data - self.texts = [] - for pos, cbar in six.iteritems(self.cbar.cbars): - cbar.set_label(self.replace( - value, arr, attrs=self.get_enhanced_attrs(arr))) - self.texts.append(getattr( - cbar.ax, self.axis_locations[pos] + 'axis').get_label()) - - -class VCLabel(CLabel): - """ - Show the colorbar label of the vector plot - - Set the label of the colorbar. - %(replace_note)s - - Possible types - -------------- - str - The title for the :meth:`~matplotlib.colorbar.Colorbar.set_label` - method. - - See Also - -------- - vclabelsize, vclabelweight, vclabelprops""" - pass - - -class CbarOptions(Formatoption): - """Base class for colorbar formatoptions""" - - which = 'major' - - children = ['plot'] - - dependencies = ['cbar'] - - @property - def colorbar(self): - try: - return self._colorbar - except AttributeError: - try: - pos, cbar = next(six.iteritems(self.cbar.cbars)) - except StopIteration: - raise AttributeError("No colorbar set") - self.position = pos - self.colorbar = cbar - return self.colorbar - - @colorbar.setter - def colorbar(self, cbar): - self._colorbar = cbar - - @property - def axis(self): - """axis of the colorbar with the ticks. Will be overwritten during - update process.""" - return getattr( - self.colorbar.ax, self.axis_locations[self.position] + 'axis') - - @property - def axisname(self): - return self.axis_locations[self.position] - - @property - def data(self): - try: - return self.plot.data - except AttributeError: - return super().data - - axis_locations = CLabel.axis_locations - - def update(self, value): - for pos, cbar in six.iteritems(self.cbar.cbars): - self.colorbar = cbar - self.position = pos - self.update_axis(value) - - -@docstrings.get_sections(base='CTicks') -class CTicks(CbarOptions, TicksBase): - """ - Specify the tick locations of the colorbar - - Possible types - -------------- - None - use the default ticks - %(DataTicksCalculator.possible_types)s - bounds - let the :attr:`bounds` keyword determine the ticks. An - additional integer `i` may be specified to only use every i-th - bound as a tick (see also `int` below) - midbounds - Same as `bounds` but in the middle between two bounds - int - Specifies how many ticks to use with the ``'bounds'`` option. I.e. if - integer ``i``, then this is the same as ``['bounds', i]``. - - See Also - -------- - cticklabels - """ - - dependencies = CbarOptions.dependencies + ['bounds'] - - connections = CbarOptions.connections + ['cmap'] - - name = 'Colorbar ticks' - - _default_locator = None - - @property - def default_locator(self): - """Default locator of the axis of the colorbars""" - if self._default_locator is None: - self.set_default_locators() - return self._default_locator - - @default_locator.setter - def default_locator(self, locator): - self._default_locator = locator - - def __init__(self, *args, **kwargs): - super(CTicks, self).__init__(*args, **kwargs) - self.calc_funcs['bounds'] = self._bounds_ticks - self.calc_funcs['midbounds'] = self._mid_bounds_ticks - - def set_ticks(self, value): - self.ticks = value - self.colorbar.set_ticks(value) - - def _bounds_ticks(self, step=None, *args, **kwargs): - step = step or 1 - return self.bounds.bounds[::step] - - def _mid_bounds_ticks(self, step=None, *args, **kwargs): - step = step or 1 - ret = 0.5 * (self.bounds.bounds[1:] + self.bounds.bounds[:-1]) - return ret[::step] - - def update(self, value): - # reset the locators if the colorbar has been drawn from scratch - if self.cbar._just_drawn or ( - not self.plotter.has_changed(self.key) and self.value is None): - if self.cbar.cbars: - try: - del self._colorbar - except AttributeError: - pass - self.set_default_locators() - super(CTicks, self).update(value) - - def update_axis(self, value): - cbar = self.colorbar - if value is None: - cbar.locator = self.default_locator - cbar.formatter = self.default_formatter - cbar.update_ticks() - else: - TicksBase.update_axis(self, value) - - def set_default_locators(self, *args, **kwargs): - try: - cbar = self.colorbar - except AttributeError: - pass - else: - self.default_locator = cbar.locator - self.default_formatter = cbar.formatter - - def get_fmt_widget(self, parent, project): - """Open a :class:`psy_simple.widget.CMapFmtWidget`""" - from psy_simple.widgets.colors import CTicksFmtWidget - return CTicksFmtWidget(parent, self, project) - - -class VectorCTicks(CTicks): - """ - Specify the tick locations of the vector colorbar - - Possible types - -------------- - %(CTicks.possible_types)s - - See Also - -------- - cticklabels, vcticklabels - """ - - dependencies = CTicks.dependencies + ['color'] - - @property - def array(self): - arr = self.color._color_array - return arr[~np.isnan(arr)] - - -class CTickLabels(CbarOptions, TickLabelsBase): - """ - Specify the colorbar ticklabels - - Possible types - -------------- - %(TickLabelsBase.possible_types)s - - See Also - -------- - cticks, cticksize, ctickweight, ctickprops - vcticks, vcticksize, vctickweight, vctickprops - """ - - name = 'Colorbar ticklabels' - - @property - def default_formatters(self): - """Default locator of the axis of the colorbars""" - if self._default_formatters: - return self._default_formatters - else: - self.set_default_formatters() - return self._default_formatters - - @default_formatters.setter - def default_formatters(self, d): # d is expected to be a dictionary - self._default_formatters = d - - def set_default_formatters(self): - if self.cbar.cbars: - self.default_formatters = {self.which: self.colorbar.formatter} - - def set_formatter(self, formatter): - cbar = self.colorbar - cbar.formatter = formatter - cbar.update_ticks() - - -class CTickSize(CbarOptions, TickSizeBase): - """ - Specify the font size of the colorbar ticklabels - - Possible types - -------------- - %(fontsizes)s - - See Also - -------- - ctickweight, ctickprops, cticklabels, cticks - vctickweight, vctickprops, vcticklabels, vcticks""" - - group = 'colors' - - name = 'Font size of the colorbar ticklabels' - - dependencies = CbarOptions.dependencies + ['ctickprops'] - - -class CTickWeight(CbarOptions, TickWeightBase): - """ - Specify the fontweight of the colorbar ticklabels - - Possible types - -------------- - %(fontweights)s - - See Also - -------- - cticksize, ctickprops, cticklabels, cticks - vcticksize, vctickprops, vcticklabels, vcticks""" - - group = 'colors' - - name = 'Font weight of the colorbar ticklabels' - - dependencies = CbarOptions.dependencies + ['ctickprops'] - - -class CTickProps(CbarOptions, TickPropsBase): - """ - Specify the font properties of the colorbar ticklabels - - Possible types - -------------- - %(TickPropsBase.possible_types)s - - See Also - -------- - cticksize, ctickweight, cticklabels, cticks - vcticksize, vctickweight, vcticklabels, vcticks""" - - children = CbarOptions.children + TickPropsBase.children - - group = 'colors' - - name = 'Font properties of the colorbar ticklabels' - - def update_axis(self, value): - value = value.copy() - default = self.default - if 'major' in default or 'minor' in default: - default = default.get(self.which, {}) - for key, val in chain( - default.items(), mpl.rcParams.find_all( - self.axisname + 'tick\.%s\.\w' % self.which).items()): - value.setdefault(key.split('.')[-1], val) - - if float('.'.join(mpl.__version__.split('.')[:2])) >= 1.5: - value.pop('visible', None) - posnames = ['top', 'bottom'] if self.axisname == 'x' else [ - 'left', 'right'] - label_positions = dict(zip( - map('label{}'.format, posnames), - [True, False] if self.position in ['t', 'ft', 'l', 'fl'] else - [False, True])) - label_positions.update(**value) - self.colorbar.ax.tick_params( - self.axisname, which=self.which, reset=True, **label_positions) - - -class ArrowSize(Formatoption): - """ - Change the size of the arrows - - Possible types - -------------- - None - make no scaling - float - Factor scaling the size of the arrows - - See Also - -------- - arrowstyle, linewidth, density, color""" - - group = 'vector' - - priority = BEFOREPLOTTING - - dependencies = ['plot'] - - name = 'Size of the arrows' - - def update(self, value): - kwargs = self.plot._kwargs - if self.plot.value == 'stream': - kwargs.pop('scale', None) - kwargs['arrowsize'] = value or 1.0 - else: - kwargs.pop('arrowsize', None) - kwargs['scale'] = value - - -class ArrowStyle(Formatoption): - """Change the style of the arrows - - Possible types - -------------- - str - Any arrow style string (see - :class:`~matplotlib.patches.FancyArrowPatch`) - - Notes - ----- - This formatoption only has an effect for stream plots - - See Also - -------- - arrowsize, linewidth, density, color""" - - group = 'vector' - - priority = BEFOREPLOTTING - - dependencies = ['plot'] - - name = 'Style of the arrows' - - def update(self, value): - if self.plot.value == 'stream': - self.plot._kwargs['arrowstyle'] = value - else: - self.plot._kwargs.pop('arrowstyle', None) - - -@docstrings.get_sections(base='WindCalculator') -class VectorCalculator(Formatoption): - """ - Abstract formatoption that provides calculation functions for speed, etc. - - Possible types - -------------- - string {'absolute', 'u', 'v'} - Strings may define how the formatoption is calculated. Possible strings - are - - - **absolute**: for the absolute wind speed - - **u**: for the u component - - **v**: for the v component - """ - - dependencies = ['plot', 'transpose'] - - priority = BEFOREPLOTTING - - data_dependent = True - - def __init__(self, *args, **kwargs): - super(VectorCalculator, self).__init__(*args, **kwargs) - self._calc_funcs = { - 'absolute': self._calc_speed, - 'u': self._get_u, - 'v': self._get_v} - - def _maybe_ravel(self, arr): - if (getattr(self, 'transpose', None) is not None and - self.transpose.value): - arr = arr.T - if self.plot.value == 'quiver': - return np.ravel(arr) - return np.asarray(arr) - - def _calc_speed(self, scale=1.0): - data = self.plot.data - return self._maybe_ravel( - np.sqrt(data[0].values**2 + data[1].values**2)) * scale - - def _get_u(self, scale=1.0): - return self._maybe_ravel(self.plot.data[0].values) * scale - - def _get_v(self, scale=1.0): - return self._maybe_ravel(self.plot.data[1].values) * scale - - -class VectorLineWidth(VectorCalculator): - """ - Change the linewidth of the arrows - - Possible types - -------------- - float - give the linewidth explicitly - %(WindCalculator.possible_types)s - tuple (string, float) - `string` may be one of the above strings, `float` may be a scaling - factor - 2D-array - The values determine the linewidth for each plotted arrow. Note that - the shape has to match the one of u and v. - - See Also - -------- - arrowsize, arrowstyle, density, color""" - - name = 'Linewidth of the arrows' - - def update(self, value): - if value is None: - self.plot._kwargs['linewidth'] = 0 if self.plot.value == 'quiver' \ - else None - elif np.asarray(value).ndim and isinstance(value[0], six.string_types): - self.plot._kwargs['linewidth'] = self._calc_funcs[value[0]]( - *value[1:]) - else: - self.plot._kwargs['linewidth'] = self._maybe_ravel(value) - - -class VectorColor(VectorCalculator): - """ - Set the color for the arrows - - This formatoption can be used to set a single color for the vectors or - define the color coding - - Possible types - -------------- - float - Determines the greyness - color - Defines the same color for all arrows. The string can be either a html - hex string (e.g. '#eeefff'), a single letter (e.g. 'b': blue, - 'g': green, 'r': red, 'c': cyan, 'm': magenta, 'y': yellow, 'k': black, - 'w': white) or any other color - %(WindCalculator.possible_types)s - 2D-array - The values determine the color for each plotted arrow. Note that - the shape has to match the one of u and v. - - See Also - -------- - arrowsize, arrowstyle, density, linewidth""" - - dependencies = VectorCalculator.dependencies + ['cmap', 'bounds'] - - group = 'colors' - - name = 'Color of the arrows' - - def update(self, value): - try: - value = validate_color(value) - self.colored = False - except ValueError: - if (isinstance(value, six.string_types) and - value in self._calc_funcs): - value = self._calc_funcs[value]() - self.colored = True - self._color_array = value - else: - try: - value = validate_float(value) - self.colored = False - except ValueError: - value = self._maybe_ravel(value) - self.colored = True - self._color_array = value - if self.plot.value == 'quiver' and self.colored: - self.plot._args = [value] - self.plot._kwargs.pop('color', None) - else: - self.plot._args = [] - self.plot._kwargs['color'] = value - if self.colored: - self._set_cmap() - else: - self._delete_cmap() - - def _set_cmap(self): - if self.plotter.has_changed(self.key) or self.plotter._initializing: - self.bounds.update(self.bounds.value) - self.plot._kwargs['cmap'] = get_cmap( - self.cmap.value, len(self.bounds.bounds) - 1 or None) - self.plot._kwargs['norm'] = self.bounds.norm - - def _delete_cmap(self): - self.plot._kwargs.pop('cmap', None) - self.plot._kwargs.pop('norm', None) - - -@docstrings.get_sections(base='Density') -class Density(Formatoption): - """ - Change the density of the arrows - - Possible types - -------------- - float - Scales the density of the arrows in x- and y-direction (1.0 means - no scaling) - tuple (x, y) - Defines the scaling in x- and y-direction manually - - Notes - ----- - quiver plots do not support density scaling - """ - - dependencies = ['plot'] - - group = 'vector' - - name = 'Density of the arrows' - - priority = BEFOREPLOTTING - - data_dependent = True - - def __init__(self, *args, **kwargs): - super(Density, self).__init__(*args, **kwargs) - self._density_funcs = { - 'stream': self._set_stream_density, - 'quiver': self._set_quiver_density} - self._remove_funcs = { - 'stream': self._unset_stream_density, - 'quiver': self._unset_quiver_density} - - def update(self, value): - has_changed = self.plotter.has_changed(self.plot.key) - if has_changed: - self.remove(has_changed[0]) - try: - value = tuple(value) - except TypeError: - value = [value, value] - if self.plot.value: - self._density_funcs[self.plot.value](value) - - def _set_stream_density(self, value): - return - self.plot._kwargs['density'] = value - - def _set_quiver_density(self, value): - if any(val != 1.0 for val in value): - warn("[%s] - Quiver plot does not support the density " - "keyword!" % self.logger.name, - RuntimeWarning) - - def _unset_stream_density(self): - self.plot._kwargs.pop('density', None) - - def _unset_quiver_density(self): - pass - - def remove(self, plot_type=None): - plot_type = plot_type or self.plot.value - self._remove_funcs[plot_type]() - - -class VectorPlot(Formatoption): - """ - Choose the vector plot type - - Possible types - -------------- - str - Plot types can be either - - quiver - to make a quiver plot - stream - to make a stream plot""" - - plot_fmt = True - - group = 'plotting' - - name = 'Plot type of the arrows' - - priority = BEFOREPLOTTING - - children = ['cmap', 'bounds'] - - connections = ['transpose', 'transform', 'arrowsize', 'arrowstyle', - 'density', 'linewidth', 'color'] - - @property - def format_coord(self): - """The function that can replace the axes.format_coord method""" - return format_coord_func(self.ax, weakref.ref(self)) - - @property - def mappable(self): - """The mappable, i.e. the container of the plot""" - if self.value == 'stream': - return self._plot.lines - else: - return self._plot - - @property - def xcoord(self): - """The x coordinate :class:`xarray.Variable`""" - v = next(self.raw_data.psy.iter_base_variables) - return self.decoder.get_x(v, coords=self.data.coords) - - @property - def ycoord(self): - """The y coordinate :class:`xarray.Variable`""" - v = next(self.raw_data.psy.iter_base_variables) - return self.decoder.get_y(v, coords=self.data.coords) - - def __init__(self, *args, **kwargs): - Formatoption.__init__(self, *args, **kwargs) - self._plot_funcs = { - 'quiver': self._quiver_plot, - 'stream': self._stream_plot} - self._orig_format_coord = None - self._args = [] - self._kwargs = {} - - @property - def array(self): - return self.data.values - - def update(self, value): - pass - # the real plot making is done by make_plot but we store the value here - # in case it is shared - - def make_plot(self): - # remove the plot if it shall be replotted or any of the dependencies - # changed. Otherwise there is nothing to change - if hasattr(self, '_plot') and (self.plotter.replot or any( - self.plotter.has_changed(key) for key in chain( - self.connections, self.dependencies, [self.key]))): - self.remove() - if not hasattr(self, "_plot") and self.value is not None: - self._plot_funcs[self.value]() - if self._orig_format_coord is None: - self._orig_format_coord = self.ax.format_coord - self.ax.format_coord = self.format_coord - - def _quiver_plot(self): - x, y, u, v = self._get_data() - self._plot = self.ax.quiver(x, y, u, v, *self._args, rasterized=True, - **self._kwargs) - - def _stream_plot(self): - x, y, u, v = self._get_data() - dx = (x[-1] - x[0]) / (len(x) - 1) - dy = (y[-1] - y[0]) / (len(y) - 1) - if not np.allclose(np.diff(x), dx): - warn("Rescaling x to be equally spaced!", PsyPlotRuntimeWarning) - x = x[0] + np.zeros_like(x) + (np.arange(len(x)) * dx) - if not np.allclose(np.diff(y), dy): - warn("Rescaling y to be equally spaced!", PsyPlotRuntimeWarning) - y = y[0] + np.zeros_like(y) + (np.arange(len(y)) * dy) - if not (np.diff(y) > 0).all(): - assert u.shape == v.shape == (y.size, x.size) - y = y[::-1] - u = u[::-1] - v = v[::-1] - if not (np.diff(x) > 0).all(): - assert u.shape == v.shape == (y.size, x.size) - x = x[::-1] - u = u[..., ::-1] - v = v[..., ::-1] - self._plot = self.ax.streamplot(x, y, u, v, **self._kwargs) - - def _get_data(self): - data = self.data - if self.transpose.value: - u = data[0].T.values - v = data[1].T.values - else: - u, v = data.values - x = self.transpose.get_x(data) - y = self.transpose.get_y(data) - return np.asarray(x), np.asarray(y), u, v - - def remove(self): - - def keep(x): - return not isinstance(x, mpl.patches.FancyArrowPatch) - - if not hasattr(self, '_plot'): - return - if isinstance(self._plot, mpl.streamplot.StreamplotSet): - try: - self._plot.lines.remove() - except ValueError: - pass - # remove arrows - self.ax.patches = [patch for patch in self.ax.patches - if keep(patch)] - else: - try: - self._plot.remove() - except ValueError: # the artist has already been removed - pass - del self._plot - - def add2format_coord(self, x, y): - """Additional information for the :meth:`format_coord`""" - u, v = self.data - uname, vname = self.data.coords['variable'].values - xcoord = self.xcoord - ycoord = self.ycoord - if self.decoder.is_unstructured(self.raw_data[0]): - x, y, z1, z2 = self.get_xyz_tri(xcoord, x, ycoord, y, u, v) - elif xcoord.ndim == 1: - x, y, z1, z2 = self.get_xyz_1d(xcoord, x, ycoord, y, u, v) - elif xcoord.ndim == 2: - x, y, z1, z2 = self.get_xyz_2d(xcoord, x, ycoord, y, u, v) - speed = (z1**2 + z2**2)**0.5 - xunit = xcoord.attrs.get('units', '') - if xunit: - xunit = ' ' + xunit - yunit = ycoord.attrs.get('units', '') - if yunit: - yunit = ' ' + yunit - zunit = u.attrs.get('units', '') - if zunit: - zunit = ' ' + zunit - return (', vector data: %s: %.4g%s, %s: %.4g%s, %s: %.4g%s, ' - '%s: %.4g%s, absolute: %.4g%s') % ( - xcoord.name, x, xunit, ycoord.name, y, yunit, - uname, z1, zunit, vname, z2, zunit, - speed, zunit) - - def get_xyz_tri(self, xcoord, x, ycoord, y, u, v): - """Get closest x, y and z for the given `x` and `y` in `data` for - 1d coords""" - return self.get_xyz_2d(xcoord, x, ycoord, y, u, v) - - def get_xyz_1d(self, xcoord, x, ycoord, y, u, v): - """Get closest x, y and z for the given `x` and `y` in `data` for - 1d coords""" - xclose = xcoord.indexes[xcoord.name].get_loc(x, method='nearest') - yclose = ycoord.indexes[ycoord.name].get_loc(y, method='nearest') - uval = u[yclose, xclose].values - vval = v[yclose, xclose].values - return xcoord[xclose].values, ycoord[yclose].values, uval, vval - - def get_xyz_2d(self, xcoord, x, ycoord, y, u, v): - """Get closest x, y and z for the given `x` and `y` in `data` for - 2d coords""" - xy = xcoord.values.ravel() + 1j * ycoord.values.ravel() - dist = np.abs(xy - (x + 1j * y)) - imin = np.nanargmin(dist) - xy_min = xy[imin] - return (xy_min.real, xy_min.imag, u.values.ravel()[imin], - v.values.ravel()[imin]) - - -class SimpleVectorPlot(VectorPlot): - # disable the stream plot for unstructured grids because it is not supported - # for 1d arrays and for circumpolar grids because 2d coordinates are not - # supported - - __doc__ = VectorPlot.__doc__ - - def set_value(self, value, *args, **kwargs): - if value == 'stream' and self.raw_data is not None: - u = self.raw_data[0] - if u.psy.decoder.is_unstructured(u): - warn('[%s] - Streamplot is not supported for unstructured ' - 'grids!' % self.logger.name) - value = 'quiver' - elif u.psy.decoder.is_circumpolar(u): - warn('[%s] - Streamplot is not supported for circumpolar ' - 'grids!' % self.logger.name) - value = 'quiver' - super(SimpleVectorPlot, self).set_value(value, *args, **kwargs) - - -class CombinedVectorPlot(VectorPlot): - - __doc__ = VectorPlot.__doc__ - - def update(self, *args, **kwargs): - self._kwargs['zorder'] = 2 - super(CombinedVectorPlot, self).update(*args, **kwargs) - - -class VectorCbar(Cbar): - """ - Specify the position of the vector plot colorbars - - Possible types - -------------- - %(Cbar.possible_types)s - """ - - dependencies = Cbar.dependencies + ['color'] - - priority = END - - def update(self, *args, **kwargs): - if self.color.colored: - super(VectorCbar, self).update(*args, **kwargs) - else: - self.remove() - - -class VectorBounds(Bounds): - """ - Specify the boundaries of the vector colorbar - - Possible types - -------------- - %(Bounds.possible_types)s - - Examples - -------- - %(Bounds.examples)s - - See Also - -------- - %(Bounds.see_also)s""" - - parents = ['color'] - - @property - def array(self): - arr = self.color._color_array - return arr[~np.isnan(arr)] - - def update(self, *args, **kwargs): - if not self.color.colored: - return - return super(VectorBounds, self).update(*args, **kwargs) - - -class LegendLabels(Formatoption, TextBase): - """ - Set the labels of the arrays in the legend - - This formatoption specifies the labels for each array in the legend. - %(replace_note)s - - Possible types - -------------- - str: - A single string that shall be used for all arrays. - list of str: - Same as a single string but specified for each array - - See Also - -------- - legend""" - - data_dependent = True - - name = 'Labels in the legend' - - def update(self, value): - def get1d(arr): - if arr.ndim > 1: - return arr[0] - return arr - if isinstance(value, six.string_types): - self.labels = [ - self.replace(value, arr, self.get_enhanced_attrs( - get1d(arr), replot=True)) - for arr in self.iter_data] - else: - self.labels = [ - self.replace(val, arr, self.get_enhanced_attrs( - get1d(arr), replot=True)) for val, arr in zip( - value, self.iter_data)] - - -class Legend(DictFormatoption): - """ - Draw a legend - - This formatoption determines where and if to draw the legend. It uses the - :attr:`labels` formatoption to determine the labels. - - Possible types - -------------- - bool - Draw a legend or not - str or int - Specifies where to plot the legend (i.e. the location) - dict - Give the keywords for the :func:`matplotlib.pyplot.legend` function - - See Also - -------- - labels""" - - dependencies = ['legendlabels', 'plot', 'color', 'marker'] - - name = 'Properties of the legend' - - def update(self, value): - self.remove() - shared_by = self.shared_by - if shared_by is not None: - # update the legend of the other formatoption instead of this one - if not shared_by.plotter._updating: - shared_by.update(shared_by.value) - return - if not value.get('loc'): - return - artists = [] - labels = [] - for fmto in self.shared.union([self]): - if hasattr(fmto.plot, '_plot'): - this_artists, this_labels = fmto.get_artists_and_labels() - artists.extend(this_artists) - labels.extend(this_labels) - self.legend = self.ax.legend(artists, labels, **value) - - def get_artists_and_labels(self): - return self.plot._plot, [ - l for l, ls in zip(self.legendlabels.labels, - cycle(slist(self.plot.value))) - if ls is not None] - - def remove(self): - if hasattr(self, 'legend'): - self.legend.remove() - - -class MeanCalculator(Formatoption): - """ - Determine how the error is visualized - - Possible types - -------------- - 'mean' - Calculate the weighted mean - 'median' - Calculate the weighted median (i.e. the 50th percentile) - float between 0 and 100 - Calculate the given quantile - - See Also - -------- - err_calc: Determines how to calculate the error - """ - - priority = START - - name = 'Mean calculation' - - group = 'data' - - data_dependent = True - - requires_replot = True - - def update(self, value): - for i, arr in enumerate(self.iter_data): - if value == 'mean': - data = arr.psy.fldmean() - elif value == 'median': - data = arr.psy.fldpctl(50) - else: - data = arr.psy.fldpctl(value) - data.psy.arr_name = arr.psy.arr_name - self.set_data(data, i) - - -class ErrorCalculator(Formatoption): - """ - Calculation of the error - - This formatoption is used to calculate the error range. - - Possible types - -------------- - None - Do not calculate any error range - float - A float between 0 and 50. This will represent the distance from the - median (i.e. the 50th percentile). A value of 45 will hence correspond - to the 5th and 95th percentile - list of 2 floats between 0 and 100 - Two floats where the first corresponds to the minimum and the second - to the maximum percentile - str - A string with 'std' in it. Then we will use the standard deviation. Any - number in this string, e.g. '3.5std' will serve as a multiplier - (in this case 3.5 times the standard deviation). - - See Also - -------- - mean: Determines how the line is calculated - """ - - priority = START - - name = 'Mean calculation' - - group = 'data' - - children = ['mean'] - - data_dependent = True - - requires_replot = True - - def update(self, value): - if value is None: - return - if isstring(value): - use_std = True - m = re.search(r'\d+\.?\d*', value) - if m: - multiplier = float(m.group()) - else: - multiplier = 1 - else: - use_std = False - for i, (arr, mean) in enumerate(zip(self.iter_raw_data, - self.iter_data)): - mean = mean.to_dataset() - if use_std: - err = multiplier * arr.psy.fldstd() - mean[value] = err.variable - data = mean[[arr.name, value]].psy.to_array() - else: - err = arr.psy.fldpctl(value) - names = list(map('pctl{:1.3g}'.format, value)) - mean[names[0]] = err.variable[0] - mean[names[1]] = err.variable[1] - data = mean[[arr.name] + names].psy.to_array() - data.psy.arr_name = arr.psy.arr_name - data.attrs.update(arr.attrs) - data.name = arr.name - self.set_data(data, i) - - -docstrings.delete_types('LimitBase.possible_types', 'no_None', 'None') - - -class Hist2DXRange(LimitBase): - """ - Specify the range of the histogram for the x-dimension - - This formatoption specifies the minimum and maximum of the histogram - in the x-dimension - - Possible types - -------------- - %(LimitBase.possible_types.no_None)s - - Notes - ----- - This formatoption always acts on the coordinate, no matter what the - value of the :attr:`transpose` formatoption is - - See also - -------- - yrange""" - - priority = START - - group = 'data' - - name = 'Range of the histogram in x-direction' - - data_dependent = True - - dependencies = ['coord'] - - @property - def array(self): - # We don't use the :attr:`data` attribute because this fails if the - # formatoption is shared and the ``coord`` formatoption is not None - if self.coord.value is not None: - coord = self.coord.get_alternative_coord( - self.raw_data, self.index_in_list or 0)[1].values - else: - da = self.raw_data - coord = da.coords[da.dims[0]].values - ret = coord[~np.isnan(coord)] - return ret - - def set_limit(self, *args): - self.range = args - - -class Hist2DYRange(Hist2DXRange): - """ - Specify the range of the histogram for the x-dimension - - This formatoption specifies the minimum and maximum of the histogram - in the x-dimension - - Possible types - -------------- - %(LimitBase.possible_types.no_None)s - - Notes - ----- - This formatoption always acts on the DataArray, no matter what the - value of the :attr:`transpose` formatoption is - - See Also - -------- - xrange""" - - name = 'Range of the histogram in y-direction' - - data_dependent = True - - @property - def array(self): - return np.asarray(self.raw_data)[np.asarray(self.raw_data.notnull())] - - -class DataPrecision(Formatoption): - """ - Set the precision of the data - - This formatoption can be used to specify the precision of the data which - then will be the minimal bin width of the 2D histogram or the bandwith of - the kernel size (if the :attr:`density` formatoption is set to ``'kde'``) - - Possible types - -------------- - float - If 0, this formatoption has no effect at all. Otherwise it is assumed - to be the precision of the data - str - One of ``{'scott' | 'silverman'}``. This uses the statsmodels package - to estimate the bandwidth of the data that is then used in the - histogram or KDE plot""" - - priority = START - - dependencies = ['xrange', 'yrange'] - - connections = ['density'] - - group = 'data' - - name = 'Precision of the visualized data' - - data_dependent = True - - def estimate_bw(self, method, values, data_range=None): - import statsmodels.nonparametric.api as smnp - bw_func = getattr(smnp.bandwidths, "bw_" + method) - if data_range is not None: - vmin, vmax = sorted(data_range) - values = values[(values >= vmin) & (values <= vmax)] - if not len(values): - raise ValueError("No values found within the given range of " - f"{data_range}!") - return bw_func(values) - - def update(self, value): - self.bins = [0, 0] - value = slist(value) - if len(value) == 1: - value = [value[0], value[0]] - self.prec = value - for i, prec in enumerate(value): - if prec == 0: - continue - da = self.data - if i == 0: - data = da.coords[da.dims[0]].values - data = data[~np.isnan(data)] - r = self.xrange.range - else: - data = da[da.notnull()].values - r = self.yrange.range - if isstring(prec): - prec = self.prec[i] = self.estimate_bw(prec, data, r) - if r is not None: - dmin, dmax = r - else: - dmax = np.ceil(data.max().values / prec) * prec - dmin = data.min().values - self.bins[i] = max(int((dmax - dmin) / prec), 1) - - -class HistBins(Formatoption): - """ - Specify the bins of the 2D-Histogramm - - This formatoption can be used to specify, how many bins to use. In other - words, it determines the grid size of the resulting histogram or kde plot. - If however you also set the :attr:`precision` formatoption keyword then the - minimum of precision and the bins specified here will be used. - - Possible types - -------------- - int - If 0, only use the bins specified by the :attr:`precision` keyword - (raises an error if the :attr:`precision` is also set to 0), - otherwise the number of bins to use - tuple (x, y) of int - The bins for x and y explicitly - """ - - priority = START - - dependencies = ['precision'] - - group = 'data' - - name = 'Number of bins of the histogram' - - data_dependent = True - - def update(self, value): - self.bins = [0, 0] - try: - value = tuple(value) - except TypeError: - value = [value, value] - for i, (bins, bins_prec) in enumerate(zip(value, self.precision.bins)): - if bins == 0 and bins_prec == 0: - raise ValueError('precision and bins must not both be 0!') - elif bins == 0: - self.bins[i] = bins_prec - elif bins_prec == 0: - self.bins[i] = bins - else: - self.bins[i] = min(bins, bins_prec) - - -class NormedHist2D(Formatoption): - """ - Specify the normalization of the histogram - - This formatoption can be used to normalize the histogram. It has no effect - if the :attr:`density` formatoption is set to ``'kde'`` - - Possible types - -------------- - None - Do not make any normalization - str - One of - - counts - To make the normalization based on the total number counts - area - To make the normalization basen on the total number of counts and - area (the default behaviour of :func:`numpy.histogram2d`) - x, col, column or columns - To normalize every column - y, row or rows - To normalize every row - - See Also - -------- - density - """ - - priority = START - - name = 'Specify how to normalize the histogram' - - group = 'data' - - name = 'Normalize the histogram' - - data_dependent = True - - def update(self, value): - pass # nothing to do here - - def hist2d(self, da, **kwargs): - """Make the two dimensional histogram - - Parameters - ---------- - da: xarray.DataArray - The data source""" - if self.value is None or self.value == 'counts': - normed = False - else: - normed = True - y = da.values - x = da.coords[da.dims[0]].values - counts, xedges, yedges = np.histogram2d( - x, y, normed=normed, **kwargs) - if self.value == 'counts': # normalize such that all values sum to one - counts = counts / counts.sum().astype(float) - elif self.value in ['x', 'col', 'column', 'columns']: - # normalize such that every column sums to one - counts = counts / counts.sum(axis=1, keepdims=True).astype(float) - elif self.value in ['y', 'row', 'rows']: - # normalize such that every row sums to one - counts = counts / counts.sum(axis=1, keepdims=True).astype(float) - return counts, xedges, yedges - - -class PointDensity(Formatoption): - """ - Specify the method to calculate the density - - Possible types - -------------- - str - One of the following strings are possible - - hist - Make a 2D-histogram. The normalization is controlled by the - :attr:`normed` formatoption - kde - Fit a bivariate kernel density estimate to the data. Note that - this choice requires pythons [statsmodels]_ module to be - installed - - References - ---------- - .. [statsmodels] http://statsmodels.sourceforge.net/ - """ - - priority = START - - name = 'Type of the density plot' - - dependencies = ['normed', 'bins', 'xrange', 'yrange', 'precision', 'coord'] - - group = 'data' - - name = 'Calculation of the point density' - - data_dependent = True - - def update(self, value): - if value == 'hist': - self._hist() - else: - self._kde() - - def _kde(self): - if self.coord.value is None: - raw_da = self.raw_data - else: - raw_da = self.coord.replace_coord(0) - xyranges = [self.xrange.range, self.yrange.range] - bws = self.precision.prec - grid = self.bins.bins - for i, bw in enumerate(bws): - if bw == 0: - bws[i] = 'scott' - coord = raw_da.coords[raw_da.dims[0]] - xname = coord.name - yname = raw_da.name - x, y, z = self._statsmodels_bivariate_kde( - raw_da.coords[raw_da.dims[0]].values, raw_da.values, bws, - grid[0], grid[1], xyranges) - xcent = xr.Variable((xname, ), x, attrs=coord.attrs.copy()) - ycent = xr.Variable((yname, ), y, attrs=raw_da.attrs.copy()) - var = xr.Variable((yname, xname), z, - attrs=raw_da.psy.base.attrs.copy()) - ds = xr.Dataset({'counts': var}, {xname: xcent, yname: ycent}) - ds = ds.assign_coords(**self._get_other_coords(raw_da)) - self.decoder = CFDecoder(ds) - arr = ds.counts - arr.psy.init_accessor(base=ds, decoder=self.decoder) - self.data = arr - - def _statsmodels_bivariate_kde(self, x, y, bws, xsize, ysize, xyranges): - """Compute a bivariate kde using statsmodels. - This function is mainly motivated through - seaborn.distributions._statsmodels_bivariate_kde""" - import statsmodels.nonparametric.api as smnp - for i, (coord, bw) in enumerate(zip([x, y], bws)): - if isinstance(bw, six.string_types): - bw_func = getattr(smnp.bandwidths, "bw_" + bw) - bws[i] = bw_func(coord) - kde = smnp.KDEMultivariate([x, y], "cc", bws) - x_support = np.linspace(xyranges[0][0], xyranges[0][1], xsize) - y_support = np.linspace(xyranges[1][0], xyranges[1][1], ysize) - xx, yy = np.meshgrid(x_support, y_support) - z = kde.pdf([xx.ravel(), yy.ravel()]).reshape(xx.shape) - return x_support, y_support, z - - def _hist(self): - if self.coord.value is None: - raw_da = self.raw_data - else: - raw_da = self.coord.replace_coord(0) - bins = self.bins.bins - range_ = [self.xrange.range, self.yrange.range] - z, x, y = self.normed.hist2d(raw_da, bins=bins, range=range_) - coord = raw_da.coords[raw_da.dims[0]] - xname = coord.name - yname = raw_da.name - # calculate the centers - xcent = xr.Variable((xname, ), np.c_[[x[:-1], x[1:]]].mean(axis=0), - attrs=coord.attrs.copy()) - ycent = xr.Variable((yname, ), np.c_[[y[:-1], y[1:]]].mean(axis=0), - attrs=raw_da.attrs.copy()) - xbounds = xr.Variable((xname, 'bnds'), np.c_[[x[:-1], x[1:]]].T) - ybounds = xr.Variable((yname, 'bnds'), np.c_[[y[:-1], y[1:]]].T) - xcent.attrs['bounds'] = xname + '_bnds' - ycent.attrs['bounds'] = yname + '_bnds' - var = xr.Variable((yname, xname), z.T, - attrs=raw_da.psy.base.attrs.copy()) - variables = {'counts': var} - coords = {xname: xcent, yname: ycent, - xname + '_bnds': xbounds, yname + '_bnds': ybounds} - ds = xr.Dataset(variables, coords) - ds = ds.assign_coords(**self._get_other_coords(raw_da)) - self.decoder = CFDecoder(ds) - arr = ds.counts - arr.psy.init_accessor(base=ds, decoder=self.decoder) - self.data = arr - - def _get_other_coords(self, raw_da): - return {key: raw_da.coords[key] - for key in set(raw_da.coords).difference(raw_da.dims)} - - -class XYTickPlotter(Plotter): - """Plotter class for x- and y-ticks and x- and y- ticklabels - """ - _rcparams_string = ['plotter.simple.'] - - transpose = Transpose('transpose') - xticks = XTicks('xticks') - xticklabels = XTickLabels('xticklabels') - yticks = YTicks('yticks') - yticklabels = YTickLabels('yticklabels') - ticksize = TickSize('ticksize') - tickweight = TickWeight('tickweight') - xtickprops = XTickProps('xtickprops') - ytickprops = YTickProps('ytickprops') - xlabel = Xlabel('xlabel') - ylabel = Ylabel('ylabel') - labelsize = LabelSize('labelsize') - labelweight = LabelWeight('labelweight') - labelprops = LabelProps('labelprops') - xrotation = XRotation('xrotation') - yrotation = YRotation('yrotation') - - -class Base2D(Plotter): - """Base plotter for 2-dimensional plots - """ - - #: Boolean that is True if coordinates with units in radian should be - #: converted to degrees - convert_radian = False - - _rcparams_string = ['plotter.plot2d.'] - - cmap = CMap('cmap') - bounds = Bounds('bounds') - extend = Extend('extend') - cbar = Cbar('cbar') - plot = None - clabel = CLabel('clabel') - clabelsize = label_size(clabel, 'Colorbar label', dependencies=['clabel']) - clabelweight = label_weight(clabel, 'Colorbar label', - dependencies=['clabel']) - cbarspacing = CbarSpacing('cbarspacing') - clabelprops = label_props(clabel, 'Colorbar label', - dependencies=['clabel']) - cticks = CTicks('cticks') - cticklabels = CTickLabels('cticklabels') - cticksize = CTickSize('cticksize') - ctickweight = CTickWeight('ctickweight') - ctickprops = CTickProps('ctickprops') - mask_datagrid = MaskDataGrid('mask_datagrid') - datagrid = DataGrid('datagrid', index_in_list=0) - - -class SimplePlotterBase(BasePlotter, XYTickPlotter): - """Base class for all simple plotters""" - - #: The number variables that one data array visualized by this plotter - #: might have. - allowed_vars = 1 - - #: The number of allowed dimensions in the for the visualization. If - #: the array is unstructured, one dimension will be subtracted - allowed_dims = 1 - - transpose = Transpose('transpose') - axiscolor = AxisColor('axiscolor') - grid = Grid('grid') - color = LineColors('color') - xlim = Xlim('xlim') - ylim = Ylim('ylim') - sym_lims = SymmetricLimits('sym_lims') - legendlabels = LegendLabels('legendlabels') - legend = Legend('legend') - - @classmethod - @docstrings.dedent - def check_data(cls, name, dims, is_unstructured=None): - """ - A validation method for the data shape - - Parameters - ---------- - name: str or list of str - The variable names (at maximum :attr:`allowed_vars` variables per - array) - dims: list with length 1 or list of lists with length 1 - The dimension of the arrays. Only 1D-Arrays are allowed - is_unstructured: bool or list of bool, optional - True if the corresponding array is unstructured. This keyword is - ignored - - Returns - ------- - %(Plotter.check_data.returns)s - """ - if isinstance(name, six.string_types) or not is_iterable(name): - name = [name] - dims = [dims] - N = len(name) - if len(dims) != N: - return [False] * N, [ - 'Number of provided names (%i) and dimensions ' - '%(i) are not the same' % (N, len(dims))] * N - checks = [True] * N - messages = [''] * N - for i, (n, d) in enumerate(zip(name, dims)): - if n != 0 and not n: - checks[i] = False - messages[i] = 'At least one variable name is required!' - elif ((not isstring(n) and is_iterable(n) and - len(n) > cls.allowed_vars) and - len(d) != (cls.allowed_dims - len(slist(n)))): - checks[i] = False - messages[i] = 'Only %i names are allowed per array!' % ( - cls.allowed_vars) - elif len(d) != cls.allowed_dims: - checks[i] = False - messages[i] = 'Only %i-dimensional arrays are allowed!' % ( - cls.allowed_dims) - return checks, messages - - -class LinePlotter(SimplePlotterBase): - """Plotter for simple one-dimensional line plots - """ - - _rcparams_string = ['plotter.line.'] - - #: The number variables that one data array visualized by this plotter - #: might have. We allow up to 3 variableswhere the second and third - #: variable might be the errors (see the :attr:`error` formatoption) - allowed_vars = 3 - - coord = AlternativeXCoord('coord') - marker = Marker('marker') - markersize = MarkerSize('markersize') - linewidth = LineWidth('linewidth') - plot = LinePlot('plot') - error = ErrorPlot('error') - erroralpha = ErrorAlpha('erroralpha') - - -class ViolinPlotter(SimplePlotterBase): - """Plotter for making violin plots""" - - _rcparams_string = ['plotter.violin.'] - - plot = ViolinPlot('plot') - xlim = ViolinXlim('xlim') - ylim = ViolinYlim('ylim') - xticks = ViolinXTicks('xticks') - xticklabels = ViolinXTickLabels('xticklabels') - yticks = ViolinYTicks('yticks') - yticklabels = ViolinYTickLabels('yticklabels') - - -class BarPlotter(SimplePlotterBase): - """Plotter for making bar plots""" - - _rcparams_string = ['plotter.bar.'] - - coord = AlternativeXCoord('coord') - widths = BarWidths('widths') - alpha = BarAlpha('alpha') - categorical = CategoricalBars('categorical') - plot = BarPlot('plot') - xlim = BarXlim('xlim') - ylim = BarYlim('ylim') - xticks = BarXTicks('xticks') - yticks = BarYTicks('yticks') - xticklabels = BarXTickLabels('xticklabels') - yticklabels = BarYTickLabels('yticklabels') - xlabel = BarXlabel('xlabel') - ylabel = BarYlabel('ylabel') - - -class Simple2DBase(Base2D): - """Base class for :class:`Simple2DPlotter` and - :class:`psyplot.plotter.maps.FieldPlotter` that defines the data - management""" - - #: The number of allowed dimensions in the for the visualization. If - #: the array is unstructured, one dimension will be subtracted - allowed_dims = 2 - - miss_color = MissColor('miss_color', index_in_list=0) - - @classmethod - @docstrings.dedent - def check_data(cls, name, dims, is_unstructured): - """ - A validation method for the data shape - - Parameters - ---------- - name: str or list of str - The variable names (one variable per array) - dims: list with length 1 or list of lists with length 1 - The dimension of the arrays. Only 1D-Arrays are allowed - is_unstructured: bool or list of bool - True if the corresponding array is unstructured. - - Returns - ------- - %(Plotter.check_data.returns)s - """ - if isinstance(name, six.string_types) or not is_iterable(name): - name = [name] - dims = [dims] - is_unstructured = [is_unstructured] - N = len(name) - if N != 1: - return [False] * N, [ - 'Number of provided names (%i) must equal 1!' % (N)] * N - elif len(dims) != 1: - return [False], [ - 'Number of provided dimension lists (%i) must equal 1!' % ( - len(dims))] - elif len(is_unstructured) != 1: - return [False], [ - ('Number of provided unstructured information (%i) must ' - 'equal 1!') % (len(is_unstructured))] - if name[0] != 0 and not name[0]: - return [False], ['At least one variable name must be provided!'] - # unstructured arrays have only 1 dimension - dimlen = cls.allowed_dims - if is_unstructured[0]: - dimlen -= 1 - # Check that the array is two-dimensional - # - # if more than one array name is provided, the dimensions should be - # one les than dimlen to have a 2D array - if (not isstring(name[0]) and not is_iterable(name[0]) - and len(name[0]) != 1 and len(dims[0]) != dimlen - 1): - return [False], ['Only one name is allowed per array!'] - # otherwise the number of dimensions must equal dimlen - if len(dims[0]) != dimlen: - return [False], [ - 'An array with dimension %i is required, not %i' % ( - dimlen, len(dims[0]))] - return [True], [''] - - def _set_data(self, *args, **kwargs): - Plotter._set_data(self, *args, **kwargs) - if isinstance(self.data, InteractiveList): - data = self.data[0] - else: - data = self.data - ndims = self.allowed_dims - if data.psy.decoder.is_unstructured(data): - ndims -= 1 - if data.ndim != ndims: - raise ValueError(f"Can only plot {self.allowed_dims}-dimensional " - "data!") - - -class Simple2DPlotter(Simple2DBase, SimplePlotterBase): - """Plotter for visualizing 2-dimensional data. - - See Also - -------- - psyplot.plotter.maps.FieldPlotter""" - - transpose = Transpose('transpose') - interp_bounds = InterpolateBounds('interp_bounds') - plot = SimplePlot2D('plot') - xticks = XTicks2D('xticks') - yticks = YTicks2D('yticks') - xlim = Xlim2D('xlim') - ylim = Ylim2D('ylim') - levels = ContourLevels('levels', cbounds='bounds') - legend = None - legendlabels = None - color = None # no need for this formatoption - - -class DensityPlotter(Simple2DPlotter): - """A plotter to visualize the density of points in a 2-dimensional grid""" - - allowed_vars = 1 - - allowed_dims = 1 - - _rcparams_string = ['plotter.density.'] - - coord = AlternativeXCoord('coord') - xrange = Hist2DXRange('xrange') - yrange = Hist2DYRange('yrange') - precision = DataPrecision('precision') - bins = HistBins('bins') - normed = NormedHist2D('normed') - density = PointDensity('density') - - -class BaseVectorPlotter(Base2D): - """Base plotter for vector plots - """ - - _rcparams_string = ["plotter.vector."] - - allowed_dims = 3 - - arrowsize = ArrowSize('arrowsize') - arrowstyle = ArrowStyle('arrowstyle') - density = Density('density') - color = VectorColor('color') - linewidth = VectorLineWidth('linewidth') - cbar = VectorCbar('cbar') - bounds = VectorBounds('bounds') - cticks = VectorCTicks('cticks') - datagrid = VectorDataGrid('datagrid') - - @classmethod - @docstrings.dedent - def check_data(cls, name, dims, is_unstructured): - """ - A validation method for the data shape - - Parameters - ---------- - name: str or list of str - The variable names (two variables for the array or one if the dims - are one greater) - dims: list with length 1 or list of lists with length 1 - The dimension of the arrays. Only 2D-Arrays are allowed (or 1-D if - the array is unstructured) - is_unstructured: bool or list of bool - True if the corresponding array is unstructured. - - Returns - ------- - %(Plotter.check_data.returns)s - """ - if isinstance(name, six.string_types) or not is_iterable(name): - name = [name] - dims = [dims] - is_unstructured = [is_unstructured] - N = len(name) - if N != 1: - return [False] * N, [ - 'Number of provided names (%i) must equal 1!' % (N)] * N - elif len(dims) != 1: - return [False], [ - 'Number of provided dimension lists (%i) must equal 1!' % ( - len(dims))] - elif len(is_unstructured) != 1: - return [False], [ - ('Number of provided unstructured information (%i) must ' - 'equal 1!') % (len(is_unstructured))] - if name[0] != 0 and not name[0]: - return [False], ['Two variable names must be provided!'] - # unstructured arrays have only 1 dimension - dimlen = 1 if is_unstructured[0] else 2 - # Check that the array is two-dimensional - # - # if more than one array name is provided, the dimensions should be - # one les than dimlen to have a 2D array - if (((isstring(name[0] or not is_iterable(name[0])) or - len(name[0]) == 1) and len(dims[0]) != dimlen + 1) or - len(name[0]) > 2): - return [False], [ - ('Two variables (one for x- and one for y-direction) are ' - 'required!')] - elif ((isstring(name[0]) or len(name[0]) == 1) and - len(dims[0]) == dimlen + 1): - dimlen += 1 - # otherwise the number of dimensions must equal dimlen - if len(dims[0]) != dimlen: - return [False], [ - 'An array with dimension %i is required, not %i' % ( - dimlen, len(dims[0]))] - return [True], [''] - - def _set_data(self, *args, **kwargs): - Plotter._set_data(self, *args, **kwargs) - if isinstance(self.data, InteractiveList): - data = self.data[0] - else: - data = self.data - ndims = self.allowed_dims - if data.psy.decoder.is_unstructured(data): - ndims -= 1 - if data.ndim != ndims: - raise ValueError(f"Can only plot {self.allowed_dims}-dimensional " - "data!") - - -class SimpleVectorPlotter(BaseVectorPlotter, SimplePlotterBase): - """Plotter for visualizing 2-dimensional vector data - - See Also - -------- - psyplot.plotter.maps.VectorPlotter""" - - plot = SimpleVectorPlot('plot') - xticks = XTicks2D('xticks') - yticks = YTicks2D('yticks') - xlim = Xlim2D('xlim') - ylim = Ylim2D('ylim') - legend = None - legendlabels = None - - -class ScalarCombinedBase(Plotter): - """Base plotter for combined 2-dimensional scalar field with any other - plotter""" - - _rcparams_string = ["plotter.combinedsimple."] - - # scalar plot formatoptions - cbar = Cbar('cbar', other_cbars=['vcbar']) - cticks = CTicks('cticks') - bounds = Bounds('bounds', index_in_list=0) - - # make sure that masking options only affect the scalar field - maskless = MaskLess('maskless', index_in_list=0) - maskleq = MaskLeq('maskleq', index_in_list=0) - maskgreater = MaskGreater('maskgreater', index_in_list=0) - maskgeq = MaskGeq('maskgeq', index_in_list=0) - maskbetween = MaskBetween('maskbetween', index_in_list=0) - - -class CombinedBase(ScalarCombinedBase): - """Base plotter for combined 2-dimensional scalar and vector plot""" - - # vector plot formatoptions - color = VectorColor('color', plot='vplot', cmap='vcmap', bounds='vbounds', - index_in_list=1) - linewidth = VectorLineWidth('linewidth', plot='vplot', index_in_list=1) - arrowsize = ArrowSize('arrowsize', plot='vplot', index_in_list=1) - arrowstyle = ArrowStyle('arrowstyle', plot='vplot', index_in_list=1) - vcbar = VectorCbar('vcbar', plot='vplot', cmap='vcmap', bounds='vbounds', - cbarspacing='vcbarspacing', other_cbars=['cbar'], - index_in_list=1) - vcbarspacing = CbarSpacing('vcbarspacing', cbar='vcbar', index_in_list=1) - vclabel = VCLabel('vclabel', plot='vplot', cbar='vcbar', index_in_list=1) - vclabelsize = label_size(vclabel, 'Vector colorbar label', - dependencies=['vclabel']) - vclabelweight = label_weight(vclabel, 'Vector colorbar label', - dependencies=['vclabel']) - vclabelprops = label_props(vclabel, 'Vector colorbar label', - dependencies=['vclabel']) - vcmap = CMap('vcmap', index_in_list=1, bounds='vbounds', cbar='vcbar') - vbounds = VectorBounds('vbounds', index_in_list=1, cmap='vcmap', - cbar='vcbar') - vcticks = VectorCTicks('vcticks', cbar='vcbar', plot='vplot', - bounds='vbounds', index_in_list=1) - vcticklabels = CTickLabels('vcticklabels', cbar='vcbar', index_in_list=1) - vcticksize = CTickSize('vcticksize', cbar='vcbar', index_in_list=1, - ctickprops='vctickprops') - vctickweight = CTickWeight('vctickweight', cbar='vcbar', index_in_list=1) - vctickprops = CTickProps('vctickprops', cbar='vcbar', - index_in_list=1) - - @classmethod - @docstrings.dedent - def check_data(cls, name, dims, is_unstructured): - """ - A validation method for the data shape - - Parameters - ---------- - name: list of str with length 2 - The variable names (one for the first, two for the second array) - dims: list with length 2 of lists with length 1 - The dimension of the arrays. Only 2D-Arrays are allowed (or 1-D if - an array is unstructured) - is_unstructured: bool or list of bool - True if the corresponding array is unstructured. - - Returns - ------- - %(Plotter.check_data.returns)s - """ - if isinstance(name, six.string_types) or not is_iterable(name): - name = [name] - dims = [dims] - is_unstructured = [is_unstructured] - msg = ('Two arrays are required (one for the scalar and ' - 'one for the vector field)') - if len(name) < 2: - return [None], [msg] - elif len(name) > 2: - return [False], [msg] - valid1, msg1 = Simple2DBase.check_data(name[:1], dims[0:1], - is_unstructured[:1]) - valid2, msg2 = BaseVectorPlotter.check_data(name[1:], dims[1:], - is_unstructured[1:]) - return valid1 + valid2, msg1 + msg2 - - def _set_data(self, *args, **kwargs): - super(CombinedBase, self)._set_data(*args, **kwargs) - # implement 2 simple checks to make sure that we get the right data - if not isinstance(self.plot_data, InteractiveList): - raise ValueError( - "Combined plots must be lists of one scalar field and a" - "vector field. Got one %s instead" % str(type( - self.plot_data))) - elif len(self.plot_data) < 2: - raise ValueError( - "Combined plots must be lists of one scalar field and a" - "vector field. Got a list of length %i instead!" % len( - self.plot_data)) - - -class CombinedSimplePlotter(CombinedBase, Simple2DPlotter, - SimpleVectorPlotter): - """Combined 2D plotter and vector plotter - - See Also - -------- - psyplot.plotter.maps.CombinedPlotter: for visualizing the data on a map""" - plot = Plot2D('plot', index_in_list=0) - vplot = CombinedVectorPlot('vplot', index_in_list=1, cmap='vcmap', - bounds='vbounds') - density = Density('density', plot='vplot', index_in_list=1) - - -class FldmeanPlotter(LinePlotter): - - _rcparams_string = ["plotter.fldmean."] - - allowed_dims = 3 - - err_calc = ErrorCalculator('err_calc') - mean = MeanCalculator('mean') - - # We reimplement the masking formatoption to make sure, that they are - # called after the mean calculation - maskgeq = MaskGeq('maskgeq', additional_children=['err_calc']) - maskleq = MaskLeq('maskleq', additional_children=['err_calc']) - maskgreater = MaskGreater('maskgreater', additional_children=['err_calc']) - maskless = MaskLess('maskless', additional_children=['err_calc']) - maskbetween = MaskBetween('maskbetween', additional_children=['err_calc']) - mask = Mask('mask', additional_children=['err_calc']) - coord = AlternativeXCoordPost('coord', additional_children=['err_calc']) diff --git a/psy_simple/plugin.py b/psy_simple/plugin.py deleted file mode 100644 index 82bf4cd8..00000000 --- a/psy_simple/plugin.py +++ /dev/null @@ -1,1181 +0,0 @@ -"""psy-simple psyplot plugin - -This module defines the rcParams for the psy-simple plugin. -""" - -# Disclaimer -# ---------- -# -# Copyright (C) 2021 Helmholtz-Zentrum Hereon -# Copyright (C) 2020-2021 Helmholtz-Zentrum Geesthacht -# Copyright (C) 2016-2021 University of Lausanne -# -# This file is part of psy-simple and is released under the GNU LGPL-3.O license. -# See COPYING and COPYING.LESSER in the root of the repository for full -# licensing details. -# -# This program is free software: you can redistribute it and/or modify -# it under the terms of the GNU Lesser General Public License version 3.0 as -# published by the Free Software Foundation. -# -# 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 LGPL-3.0 license for more details. -# -# You should have received a copy of the GNU LGPL-3.0 license -# along with this program. If not, see . - -import six -import re -import matplotlib as mpl -import dataclasses -import numpy as np -import enum -from matplotlib.patches import ArrowStyle -from warnings import warn -from itertools import repeat -from psyplot.config.rcsetup import ( - RcParams, safe_list, SubDict, validate_dict, validate_stringlist, - validate_stringset) -from matplotlib.rcsetup import ( - validate_bool, validate_color, validate_fontsize, - ValidateInStrings, validate_int, validate_legend_loc, - validate_colorlist) -from psy_simple import __version__ as plugin_version -import xarray as xr - - -def get_versions(requirements=True): - return {'version': plugin_version} - - -def patch_prior_1_0(plotter_d, versions): - """Patch psy_simple plotters for versions smaller than 1.0 - - Before psyplot 1.0.0, the plotters in the psy_simple package where part of - the psyplot.plotter.simple module. This has to be corrected""" - plotter_d['cls'] = ('psy_simple.plotters', plotter_d['cls'][1]) - - -#: patches to apply when loading a project -patches = { - ('psyplot.plotter.simple', 'LinRegPlotter'): patch_prior_1_0, - ('psyplot.plotter.simple', 'DensityRegPlotter'): patch_prior_1_0, - ('psyplot.plotter.simple', 'ViolinPlotter'): patch_prior_1_0, - ('psyplot.plotter.simple', 'Simple2DPlotter'): patch_prior_1_0, - ('psyplot.plotter.simple', 'SimpleVectorPlotter'): patch_prior_1_0, - ('psyplot.plotter.simple', 'BarPlotter'): patch_prior_1_0, - ('psyplot.plotter.simple', 'CombinedSimplePlotter'): patch_prior_1_0, - ('psyplot.plotter.simple', 'DensityPlotter'): patch_prior_1_0, - ('psyplot.plotter.simple', 'LinePlotter'): patch_prior_1_0, - ('psyplot.plotter.simple', 'SimplePlotterBase'): patch_prior_1_0, - } - - -bound_strings = ['data', 'mid', 'rounded', 'roundedsym', 'minmax', 'sym', - 'log', 'symlog'] - -tick_strings = bound_strings + ['hour', 'day', 'week', 'month', 'monthend', - 'monthbegin', 'year', 'yearend', 'yearbegin'] - - -class strEnum(str, enum.Enum): - pass - - -BoundsMethod = strEnum( - 'BoundsMethod', zip(bound_strings, bound_strings), module=__name__) - - -cticks_strings = bound_strings + ['bounds', 'midbounds'] - - -CTicksMethod = strEnum( - 'CTicksMethod', zip(cticks_strings, cticks_strings), module=__name__) - -TicksMethod = strEnum( - 'TicksMethod', zip(tick_strings, tick_strings), module=__name__) - - -@dataclasses.dataclass -class BoundsType: - method: BoundsMethod - N: int = None - percmin: float = 0 - percmax: float = 100 - vmin: float = None - vmax: float = None - - def __post_init__(self): - for field, val in zip(dataclasses.fields(self), self): - if val is not None or field.name == 'method': - val = field.type(val) - setattr(self, field.name, val) - - def __iter__(self): - return iter(dataclasses.astuple(self)) - - -@dataclasses.dataclass -class CTicksType(BoundsType): - method: CTicksMethod - - -@dataclasses.dataclass -class TicksType(BoundsType): - method: TicksMethod - - -def try_and_error(*funcs): - """Apply multiple validation functions - - Parameters - ---------- - ``*funcs`` - Validation functions to test - - Returns - ------- - function""" - def validate(value): - exc = None - for func in funcs: - try: - return func(value) - except (ValueError, TypeError) as e: - exc = e - raise exc - return validate - - -# ----------------------------------------------------------------------------- -# ------------------------- validation functions ------------------------------ -# ----------------------------------------------------------------------------- - - -def validate_str(s): - """Validate a string - - Parameters - ---------- - s: str - - Returns - ------- - str - - Raises - ------ - ValueError""" - if not isinstance(s, six.string_types): - raise ValueError("Did not found string!") - return six.text_type(s) - - -def validate_float(s): - """convert `s` to float or raise - - Returns - ------- - s converted to a float: float - - Raises - ------ - ValueError""" - try: - return float(s) - except (ValueError, TypeError): - raise ValueError('Could not convert "%s" to float' % str(s)) - - -def validate_text(value): - """Validate a text formatoption - - Parameters - ---------- - value: see :attr:`psyplot.plotter.labelplotter.text` - - Raises - ------ - ValueError""" - possible_transform = ['axes', 'fig', 'data'] - validate_transform = ValidateInStrings('transform', possible_transform, - True) - tests = [validate_float, validate_float, validate_str, - validate_transform, dict] - if isinstance(value, six.string_types): - xpos, ypos = rcParams['texts.default_position'] - return [(xpos, ypos, value, 'axes', {'ha': 'right'})] - elif isinstance(value, tuple): - value = [value] - try: - value = list(value)[:] - except TypeError: - raise ValueError("Value must be string or list of tuples!") - for i, val in enumerate(value): - try: - val = tuple(val) - except TypeError: - raise ValueError( - "Text must be an iterable of the form " - "(x, y, s[, trans, params])!") - if len(val) < 3: - raise ValueError( - "Text tuple must at least be like [x, y, s], with floats x, " - "y and string s!") - elif len(val) == 3 or isinstance(val[3], dict): - val = list(val) - val.insert(3, 'data') - if len(val) == 4: - val += [{}] - val = tuple(val) - if len(val) > 5: - raise ValueError( - "Text tuple must not be longer then length 5. It can be " - "like (x, y, s[, trans, params])!") - value[i] = (validate(x) for validate, x in zip(tests, val)) - return value - - -def validate_fontweight(value): - if value is None: - return None - elif isinstance(value, six.string_types): - return six.text_type(value) - elif mpl.__version__ >= '1.5': - return validate_float(value) - raise ValueError("Font weights must be None or a string!") - - -def validate_limits(value): - if value is None or isinstance(value, six.string_types): - return (value, value) - if not len(value) == 2: - raise ValueError("Limits must have length 2!") - return tuple(value) - - -def validate_none(b): - """Validate that None is given - - Parameters - ---------- - b: {None, 'none'} - None or string (the case is ignored) - - Returns - ------- - None - - Raises - ------ - ValueError""" - if isinstance(b, six.string_types): - b = b.lower() - if b is None or b == 'none': - return None - else: - raise ValueError('Could not convert "%s" to None' % b) - - -validate_bool_maybe_none = try_and_error(validate_none, validate_bool) - - -def validate_axiscolor(value): - """Validate a dictionary containing axiscolor definitions - - Parameters - ---------- - value: dict - see :attr:`psyplot.plotter.baseplotter.axiscolor` - - Returns - ------- - dict - - Raises - ------ - ValueError""" - validate = try_and_error(validate_none, validate_color) - possible_keys = {'right', 'left', 'top', 'bottom'} - try: - value = dict(value) - false_keys = set(value) - possible_keys - if false_keys: - raise ValueError("Wrong keys (%s)!" % (', '.join(false_keys))) - for key, val in value.items(): - value[key] = validate(val) - except: - value = dict(zip(possible_keys, repeat(validate(value)))) - return value - - -def validate_dataarray(val): - if not isinstance(val, xr.DataArray): - raise ValueError("Require xarray.DataArray, not %r" % type(val)) - return val - - -def validate_marker(val): - """Does not really make a validation because markers can be quite of - different types""" - if val is None: - return None - else: - return safe_list(val) - - -def validate_alpha(val): - '''Validate an alpha value between 0 and 1''' - val = validate_float(val) - if val < 0 or val > 1: - raise ValueError('Alpha values must lay between 0 and 1!') - return val - - -def validate_iter(value): - """Validate that the given value is an iterable""" - try: - iter(value) - except TypeError: - raise ValueError("%s is not an iterable!" % repr(value)) - else: - return value - - -def validate_cbarpos(value): - """Validate a colorbar position - - Parameters - ---------- - value: bool or str - A string can be a combination of 'sh|sv|fl|fr|ft|fb|b|r' - - Returns - ------- - list - list of strings with possible colorbar positions - - Raises - ------ - ValueError""" - patt = 'sh|sv|fl|fr|ft|fb|b|r' - if value is True: - value = {'b'} - elif not value: - value = set() - elif isinstance(value, six.string_types): - for s in re.finditer('[^%s]+' % patt, value): - warn("Unknown colorbar position %s!" % s.group(), RuntimeWarning) - value = set(re.findall(patt, value)) - else: - value = validate_stringset(value) - for s in (s for s in value - if not re.match(patt, s)): - warn("Unknown colorbar position %s!" % s) - value.remove(s) - return value - - -def validate_cmap(val): - """Validate a colormap - - Parameters - ---------- - val: str or :class:`mpl.colors.Colormap` - - Returns - ------- - str or :class:`mpl.colors.Colormap` - - Raises - ------ - ValueError""" - from matplotlib.colors import Colormap - try: - return validate_str(val) - except ValueError: - if not isinstance(val, Colormap): - raise ValueError( - "Could not find a valid colormap!") - return val - - -def validate_cmaps(cmaps): - """Validate a dictionary of color lists - - Parameters - ---------- - cmaps: dict - a mapping from a colormap name to a list of colors - - Raises - ------ - ValueError - If one of the values in `cmaps` is not a color list - - Notes - ----- - For all items (listname, list) in `cmaps`, the reversed list is - automatically inserted with the ``listname + '_r'`` key.""" - cmaps = {validate_str(key): validate_colorlist(val) for key, val in cmaps} - for key, val in six.iteritems(cmaps): - cmaps.setdefault(key + '_r', val[::-1]) - return cmaps - - -def validate_sym_lims(val): - validator = try_and_error(validate_none, ValidateInStrings( - 'sym_links', ['min', 'max'], True)) - val = safe_list(val) - if len(val) != 2: - val = val + val - if not len(val) == 2: - raise ValueError("Need two values for the symmetric limits, not %i" % ( - len(val))) - return list(map(validator, val)) - - -def validate_legend(value): - if isinstance(value, dict): - return value - try: - return {'loc': validate_int(value)} - except (ValueError, TypeError) as e: - pass - try: - return {'loc': validate_legend_loc(value)} - except (ValueError, TypeError) as e: - pass - value = validate_bool(value) - return {'loc': 'best' if value else False} - - -def validate_lineplot(value): - """Validate the value for the LinePlotter.plot formatoption - - Parameters - ---------- - value: None, str or list with mixture of both - The value to validate""" - if value is None: - return value - elif isinstance(value, six.string_types): - return six.text_type(value) - else: - value = list(value) - for i, v in enumerate(value): - if v is None: - pass - elif isinstance(v, six.string_types): - value[i] = six.text_type(v) - else: - raise ValueError('Expected None or string, found %s' % (v, )) - return value - - -validate_ticklabels = try_and_error(validate_none, validate_str, - validate_stringlist) - -validate_extend = ValidateInStrings('extend', - ['neither', 'both', 'min', 'max']) - - -class ValidateList(object): - """Validate a list of the specified `dtype` - """ - - def __init__(self, dtype=None, length=None, listtype=list): - """ - Parameters - ---------- - dtype: object - A datatype (e.g. :class:`float`) that shall be used for the - conversion - length: int - The expected length of the list - listtype: type - The type to use for creating the list. Should accept any iterable - """ - #: data type (e.g. :class:`float`) used for the conversion - self.dtype = dtype - self.length = length - self.listtype = list - - def __call__(self, l): - """Validate whether `l` is a list with contents of :attr:`dtype` - - Parameters - ---------- - l: list-like - - Returns - ------- - list - list with values of dtype :attr:`dtype` - - Raises - ------ - ValueError""" - try: - if self.dtype is None: - validated = self.listtype(l) - else: - try: - len(self.dtype) - except TypeError: - validated = self.listtype(map(self.dtype, l)) - else: - validated = self.listtype() - for val in l: - valid = False - for dtype in self.dtype: - try: - validated.append(dtype(val)) - except (TypeError, ValueError): - pass - else: - valid = True - break - if not valid: - raise ValueError( - f"{val} cannot be converted to any of the " - f"given data types: {self.dtype}!") - - except TypeError: - if self.dtype is None: - raise ValueError("Could not convert to list!") - else: - raise ValueError( - "Could not convert to list of type %s!" % str(self.dtype)) - if self.length is not None and len(validated) != self.length: - raise ValueError('List with length %i is required! Not %i!' % ( - self.length, len(validated))) - return validated - - -def validate_err_calc(val): - """Validation function for the - :attr:`psy_simple.plotter.FldmeanPlotter.err_calc` formatoption""" - try: - val = validate_float(val) - except (ValueError, TypeError): - pass - else: - if val <= 100 and val >= 0: - return val - raise ValueError("Percentiles for the error calculation must lie " - "between 0 and 100, not %s" % val) - try: - val = ValidateList(float, 2)(val) - except (ValueError, TypeError): - pass - else: - if all((v <= 100 and v >= 0) for v in val): - return val - raise ValueError("Percentiles for the error calculation must lie " - "between 0 and 100, not %s" % val) - try: - val = validate_str(val) - except ValueError: - pass - else: - if 'std' not in val: - raise ValueError( - 'A string for the error calculation must contain std!') - return val - - -class DictValValidator(object): - """A validation class for formatoptions that expect dictionaries as values - """ - - def __init__(self, key, valid, validators, default, ignorecase=False): - """ - Parameters - ---------- - key: str - The name of the formatoption (will be used for error handling) - valid: list of str - The valid keys for the dictionary - validators: func - The validation function for the values of the dictionary - default: object - The default value to use if a key from `valid` is given in the - provided value - ignorecase: bool - Whether the case of the keys should be ignored - """ - self.key = key - self.valid = valid - self.key_validator = ValidateInStrings(key, valid, ignorecase) - self.default = default - self.validate = validators - - def __call__(self, value): - if isinstance(value, dict) and value and all( - isinstance(key, six.string_types) for key in value): - failed_key = False - for key, val in list(six.iteritems(value)): - try: - new_key = self.key_validator(key) - except ValueError: - failed_key = True - break - else: - value[new_key] = self.validate(value.pop(key)) - if failed_key: - if self.default is None: - value = self.validate(value) - value = dict(zip(self.valid, repeat(value))) - else: - value = {self.default: self.validate(value)} - elif self.default is None: - value = self.validate(value) - value = dict(zip(self.valid, repeat(value))) - else: - value = {self.default: self.validate(value)} - return value - - -class TicksValidator(ValidateInStrings): - - def __call__(self, val): - # validate the ticks - # if None, int or tuple (defining min- and max-range), pass - if val is None or isinstance(val, int) or ( - isinstance(val, tuple) and len(val) <= 3): - return val - # strings must be in the given list - elif isinstance(val, six.string_types): - return list(TicksType(val)) - elif isinstance(val, dict): - return list(TicksType(**val)) - elif len(val) and isinstance(val[0], six.string_types): - return list(TicksType(*val)) - # otherwise we assume an array - else: - return ValidateList()(val) - - -class BoundsValidator: - - def __init__(self, type, default='rounded', possible_instances=None): - """ - For parameter description see - :class:`matplotlib.rcsetup.ValidateInStrings`. - - Other Parameters - ---------------- - inis: tuple - Tuple of object types that may pass the check - default: str - The default string to use for an integer (Default: 'rounded')""" - self.type = type - self.possible_instances = possible_instances - self.default = default - - def instance_check(self, val): - if self.possible_instances: - return isinstance(val, self.possible_instances) - return False - - def __call__(self, val): - if val is None or self.instance_check(val): - return val - elif isinstance(val, dict): - return list(self.type(**val)) - elif isinstance(val, int): - return list(self.type(self.default, val)) - elif isinstance(val, six.string_types): - return list(self.type(val)) - elif isinstance(val[0], six.string_types): - return list(self.type(*val)) - # otherwise we assume an array - else: - return ValidateList(float)(val) - - -class LineWidthValidator(ValidateInStrings): - - def __call__(self, val): - if val is None: - return val - elif isinstance(val, six.string_types): - return [ValidateInStrings.__call__(self, val), 1.0] - elif np.asarray(val).ndim and isinstance(val[0], six.string_types): - return [ValidateInStrings.__call__(self, val[0])] + list(val[1:]) - # otherwise we assume an array - else: - return np.asarray(val, float) - - -def validate_plot(val): - validator = ValidateInStrings( - '2d plot', ['mesh', 'contourf', 'contour', 'poly', - 'tri', 'tricontourf', 'tricontour'], True) - - val = validator(val) - depr_map = { - "tri": "poly", "tricontourf": "contourf", "tricontour": "contour" - } - if val in depr_map: - warn("plot=%r is depreceated for the plot formatoption and will be " - "removed in psy-simple 1.4.0. Please use plot=%r instead." % ( - val, depr_map[val]), - DeprecationWarning) - return depr_map[val] - return val - - -# ----------------------------------------------------------------------------- -# ------------------------------ rcParams ------------------------------------- -# ----------------------------------------------------------------------------- - - -#: the :class:`~psyplot.config.rcsetup.RcParams` for the psy-simple plugin -rcParams = RcParams(defaultParams={ - - # ------------------------------------------------------------------------- - # ----------------------- Registered plotters ----------------------------- - # ------------------------------------------------------------------------- - - 'project.plotters': [ - {'simple': { - 'module': 'psy_simple.plotters', - 'plotter_name': 'SimplePlotterBase', - 'plot_func': False, - 'summary': ('All plotters that are visualized by the psy-simple ' - 'package')}, - 'lineplot': { - 'module': 'psy_simple.plotters', - 'plotter_name': 'LinePlotter', - 'prefer_list': True, - 'default_slice': None, - 'summary': 'Make a line plot of one-dimensional data'}, - 'fldmean': { - 'module': 'psy_simple.plotters', - 'plotter_name': 'FldmeanPlotter', - 'prefer_list': True, - 'default_slice': None, - 'summary': 'Calculate and plot the mean over x- and y-dimensions' - }, - 'density': { - 'module': 'psy_simple.plotters', - 'plotter_name': 'DensityPlotter', - 'prefer_list': False, - 'default_slice': None, - 'summary': 'Make a density plot of point data'}, - 'barplot': { - 'module': 'psy_simple.plotters', - 'plotter_name': 'BarPlotter', - 'prefer_list': True, - 'default_slice': None, - 'summary': 'Make a bar plot of one-dimensional data'}, - 'violinplot': { - 'module': 'psy_simple.plotters', - 'plotter_name': 'ViolinPlotter', - 'prefer_list': True, - 'default_slice': None, - 'summary': 'Make a violin plot of your data'}, - 'plot2d': { - 'module': 'psy_simple.plotters', - 'plotter_name': 'Simple2DPlotter', - 'prefer_list': False, - 'default_slice': 0, - 'default_dims': {'x': slice(None), 'y': slice(None)}, - 'summary': 'Make a simple plot of a 2D scalar field'}, - 'vector': { - 'module': 'psy_simple.plotters', - 'plotter_name': 'SimpleVectorPlotter', - 'prefer_list': False, - 'default_slice': 0, - 'default_dims': {'x': slice(None), 'y': slice(None)}, - 'summary': 'Make a simple plot of a 2D vector field', - 'example_call': "filename, name=[['u_var', 'v_var']], ..."}, - 'combined': { - 'module': 'psy_simple.plotters', - 'plotter_name': 'CombinedSimplePlotter', - 'prefer_list': True, - 'default_slice': 0, - 'default_dims': {'x': slice(None), 'y': slice(None)}, - 'summary': ('Plot a 2D scalar field with an overlying vector ' - 'field'), - 'example_call': ( - "filename, name=[['my_variable', ['u_var', 'v_var']]], ...")}, - }, - validate_dict], - - # ------------------------------------------------------------------------- - # --------------------- Default formatoptions ----------------------------- - # ------------------------------------------------------------------------- - - 'plotter.baseplotter.tight': [False, validate_bool, - 'fmt key for tight layout of the plots'], - 'plotter.simple.grid': [ - False, try_and_error(validate_bool_maybe_none, validate_color), - 'fmt key to visualize the grid on simple plots (i.e. without ' - 'projection)'], - - # labels - 'plotter.baseplotter.title': [ - '', six.text_type, 'fmt key to control the title of the axes'], - 'plotter.baseplotter.figtitle': [ - '', six.text_type, 'fmt key to control the title of the axes'], - 'plotter.baseplotter.text': [ - [], validate_text, 'fmt key to show text anywhere on the plot'], - 'plotter.simple.ylabel': [ - '', six.text_type, 'fmt key to modify the y-axis label for simple' - 'plot (i.e. plots withouth projection)'], - 'plotter.simple.xlabel': [ - '', six.text_type, 'fmt key to modify the y-axis label for simple' - 'plot (i.e. plots withouth projection)'], - 'plotter.plot2d.clabel': [ - '', six.text_type, 'fmt key to modify the colorbar label for 2D' - 'plots'], - - # text sizes - 'plotter.baseplotter.titlesize': [ - 'large', validate_fontsize, - 'fmt key for the fontsize of the axes title'], - 'plotter.baseplotter.figtitlesize': [ - 12, validate_fontsize, 'fmt key for the fontsize of the figure title'], - 'plotter.simple.labelsize': [ - 'medium', DictValValidator( - 'labelsize', ['x', 'y'], validate_fontsize, None, True), - 'fmt key for the fontsize of the x- and y-l abel of simple plots ' - '(i.e. without projection)'], - 'plotter.simple.ticksize': [ - 'medium', DictValValidator( - 'ticksize', ['major', 'minor'], validate_fontsize, 'major', True), - 'fmt key for the fontsize of the ticklabels of x- and y-axis of ' - 'simple plots (i.e. without projection)'], - 'plotter.plot2d.cticksize': [ - 'medium', validate_fontsize, - 'fmt key for the fontsize of the ticklabels of the colorbar of 2D ' - 'plots'], - 'plotter.plot2d.clabelsize': [ - 'medium', validate_fontsize, - 'fmt key for the fontsize of the colorbar label'], - - # text weights - 'plotter.baseplotter.titleweight': [ - None, validate_fontweight, - 'fmt key for the fontweight of the axes title'], - 'plotter.baseplotter.figtitleweight': [ - None, validate_fontweight, - 'fmt key for the fontweight of the figure title'], - 'plotter.simple.labelweight': [ - None, DictValValidator( - 'labelweight', ['x', 'y'], validate_fontweight, None, True), - 'fmt key for the fontweight of the x- and y-l abel of simple plots ' - '(i.e. without projection)'], - 'plotter.simple.tickweight': [None, DictValValidator( - 'tickweight', ['major', 'minor'], validate_fontweight, 'major', True), - 'fmt key for the fontweight of the ticklabels of x- and y-axis of ' - 'simple plots (i.e. without projection)'], - 'plotter.plot2d.ctickweight': [ - None, validate_fontweight, - 'fmt key for the fontweight of the ticklabels of the colorbar of 2D ' - 'plots'], - 'plotter.plot2d.clabelweight': [ - None, validate_fontweight, - 'fmt key for the fontweight of the colorbar label'], - - # text properties - 'plotter.baseplotter.titleprops': [ - {}, validate_dict, 'fmt key for the additional properties of the title' - ], - 'plotter.baseplotter.figtitleprops': [ - {}, validate_dict, - 'fmt key for the additional properties of the figure title'], - 'plotter.simple.labelprops': [{}, DictValValidator( - 'labelprops', ['x', 'y'], validate_dict, None, True), - 'fmt key for the additional properties of the x- and y-label'], - 'plotter.simple.xtickprops': [ - {'major': {}, 'minor': {}}, DictValValidator( - 'xtickprops', ['major', 'minor'], validate_dict, 'major', True), - 'fmt key for the additional properties of the ticklabels of x-axis'], - 'plotter.simple.ytickprops': [ - {'major': {}, 'minor': {}}, DictValValidator( - 'ytickprops', ['major', 'minor'], validate_dict, 'major', True), - 'fmt key for the additional properties of the ticklabels of y-axis'], - 'plotter.plot2d.clabelprops': [ - {}, validate_dict, - 'fmt key for the additional properties of the colorbar label'], - 'plotter.plot2d.ctickprops': [ - {}, validate_dict, - 'fmt key for the additional properties of the colorbar ticklabels'], - - # mask formatoptions - 'plotter.baseplotter.background': [ - 'rc', try_and_error(ValidateInStrings('background', ['rc']), - validate_none, validate_color), - "The background color for the plot"], - 'plotter.baseplotter.mask': [ - None, try_and_error(validate_none, validate_str, validate_dataarray)], - 'plotter.baseplotter.maskleq': [ - None, try_and_error(validate_none, validate_float), - 'fmt key to mask values less or equal than a certain threshold'], - 'plotter.baseplotter.maskless': [ - None, try_and_error(validate_none, validate_float), - 'fmt key to mask values less than a certain threshold'], - 'plotter.baseplotter.maskgreater': [ - None, try_and_error(validate_none, validate_float), - 'fmt key to mask values greater than a certain threshold'], - 'plotter.baseplotter.maskgeq': [ - None, try_and_error(validate_none, validate_float), - 'fmt key to mask values greater than or equal to a certain threshold'], - 'plotter.baseplotter.maskbetween': [ - None, try_and_error(validate_none, ValidateList(float, 2)), - 'fmt key to mask values between a certain range'], - - # density plotter - 'plotter.density.coord': [ - None, try_and_error(validate_none, validate_dataarray, - validate_str, validate_stringlist), - 'Alternative x-coordinate to use for DensityPlotter'], - 'plotter.density.xrange': [ - 'minmax', validate_limits, 'The histogram limits of the density plot'], - 'plotter.density.yrange': [ - 'minmax', validate_limits, 'The histogram limits of the density plot'], - 'plotter.density.precision': [ - 0, try_and_error(validate_float, ValidateList((float, str), 2), - validate_str), - 'The precision of the data to make sure that the bin width is not ' - 'below this value'], - 'plotter.density.bins': [ - 10, try_and_error(validate_int, ValidateList(int, 2)), - 'The bins in x- and y-direction of the density plot'], - 'plotter.density.normed': [ - None, try_and_error(validate_none, ValidateInStrings( - 'normed', ['area', 'counts', 'x', 'y', 'col', 'column', 'columns', - 'row', 'rows'], True)), - 'The normalization of the density histogram'], - 'plotter.density.density': [ - 'hist', ValidateInStrings('density', ['hist', 'kde'], True)], - - # axis color - 'plotter.simple.axiscolor': [ - None, validate_axiscolor, 'fmt key to modify the color of the spines'], - - # SimplePlot - 'plotter.line.coord': [ - None, try_and_error(validate_none, validate_dataarray, - validate_str, validate_stringlist), - 'Alternative x-coordinate to use for LinePlotter'], - 'plotter.line.plot': [ - '-', validate_lineplot, - 'fmt key to modify the line style'], - 'plotter.line.error': [ - 'fill', try_and_error(ValidateInStrings('error', ['fill'], True), - validate_none), - 'The visualization type of the errors for line plots'], - 'plotter.line.marker': [ - None, validate_marker, 'The symbol of the marker'], - 'plotter.line.markersize': [ - None, try_and_error(validate_none, validate_float), - 'The size of the marker'], - 'plotter.line.linewidth': [ - None, try_and_error(validate_none, validate_float), - 'The widths of the lines'], - 'plotter.line.erroralpha': [ - 0.15, validate_alpha, 'The alpha value of the error range'], - 'plotter.bar.coord': [ - None, try_and_error(validate_none, validate_dataarray, - validate_str, validate_stringlist), - 'Alternative x-coordinate to use for BarPlotter'], - 'plotter.bar.widths': [ - 'equal', try_and_error( - validate_float, ValidateInStrings( - 'widths', ['equal', 'data'], True)), - 'fmt key to change between equal and data given width of the bars'], - 'plotter.bar.categorical': [ - None, validate_bool_maybe_none, - 'fmt key to change between categorical and non-categorical plotting'], - 'plotter.bar.alpha': [ - 1.0, validate_float, - 'fmt key to control the transparency for the bar plots'], - 'plotter.bar.plot': [ - 'bar', validate_lineplot, - 'fmt key to modify whether bar plots shall be stacked or not'], - 'plotter.violin.plot': [ - True, validate_bool_maybe_none, - 'fmt key to modify whether violin plots shall be drawn'], - 'plotter.simple.transpose': [ - False, validate_bool, 'fmt key to switch x- and y-axis'], - 'plotter.simple.color': [ - None, try_and_error(validate_none, validate_cmap, validate_iter), - 'fmt key to modify the color cycle simple plots'], - 'plotter.simple.ylim': [ - 'rounded', validate_limits, 'fmt key to specify the y-axis limits'], - 'plotter.simple.xlim': [ - 'rounded', validate_limits, 'fmt key to specify the x-axis limits'], - 'plotter.simple.sym_lims': [ - None, validate_sym_lims, - 'fmt key to make symmetric x- and y-axis limits'], - 'plotter.simple.xticks': [ - {'major': None, 'minor': None}, DictValValidator( - 'xticks', ['major', 'minor'], TicksValidator( - 'xticks', tick_strings, True), 'major', True), - 'fmt key to modify the x-axis ticks'], - 'plotter.simple.yticks': [ - {'major': None, 'minor': None}, DictValValidator( - 'yticks', ['major', 'minor'], TicksValidator( - 'yticks', tick_strings, True), 'major', True), - 'fmt key to modify the y-axis ticks'], - 'plotter.simple.xticklabels': [ - None, DictValValidator('xticklabels', ['major', 'minor'], - validate_ticklabels, 'major', True), - 'fmt key to modify the x-axis ticklabels'], - 'plotter.simple.yticklabels': [ - None, DictValValidator('yticklabels', ['major', 'minor'], - validate_ticklabels, 'major', True), - 'fmt key to modify the y-axis ticklabels'], - 'plotter.simple.xrotation': [ - 0, validate_float, - 'fmt key to modify the rotation of the x-axis ticklabels'], - 'plotter.simple.yrotation': [ - 0, validate_float, - 'fmt key to modify the rotation of the x-axis ticklabels'], - 'plotter.simple.legendlabels': [ - '%(arr_name)s', try_and_error( - validate_str, ValidateList(six.text_type)), - 'fmt key to modify the legend labels'], - 'plotter.simple.legend': [ - True, validate_legend, 'fmt key to draw a legend'], - - # FldmeanPlotter - 'plotter.fldmean.mean': [ - 'mean', try_and_error( - ValidateInStrings('mean', ['mean', 'median'], True), - validate_float), - "The calculation result, either the 'mean', 'median' or a percentile"], - 'plotter.fldmean.err_calc': [ - 'std', validate_err_calc, - "The error calculation method, either the 'std' or a minimum " - "and maximum percentile"], - - # Plot2D - 'plotter.plot2d.interp_bounds': [ - None, validate_bool_maybe_none, - 'Switch to interpolate the bounds for 2D plots'], - 'plotter.plot2d.plot': [ - 'mesh', try_and_error(validate_none, validate_plot), - 'fmt key to specify the plot type of 2D scalar plots'], - 'plotter.plot2d.plot.min_circle_ratio': [ - 0.05, validate_float, - 'fmt key to specify the min_circle_ratio that is used to mask very ' - ' flat triangles in a triangular plot'], - 'plotter.plot2d.cbar': [ - ['b'], validate_cbarpos, - 'fmt key to specify the position of the colorbar'], - 'plotter.plot2d.cbarspacing': [ - 'uniform', validate_str, - 'fmt key to specify the spacing of the colorbar'], - 'plotter.plot2d.miss_color': [ - None, try_and_error(validate_none, validate_color), - 'fmt key to specify the color of missing values'], - 'plotter.plot2d.cmap': [ - 'white_blue_red', validate_cmap, 'fmt key to specify the colormap'], - 'plotter.plot2d.cticks': [ - None, try_and_error(validate_none, BoundsValidator( - CTicksType, default='bounds')), - 'fmt key to specify the ticks of the colorbar'], - 'plotter.plot2d.cticklabels': [ - None, validate_ticklabels, - 'fmt key to specify the ticklabels of the colorbar'], - 'plotter.plot2d.extend': [ - 'neither', validate_extend, - 'fmt key to specify the style of the colorbar on minimum and maximum'], - 'plotter.plot2d.bounds': [ - 'rounded', BoundsValidator(BoundsType, 'bounds', mpl.colors.Normalize), - 'fmt key to specify bounds and norm of the colorbar'], - 'plotter.plot2d.levels': [ - None, BoundsValidator(BoundsType), - 'fmt key to specify the levels for a contour plot'], - # TODO: Implement opacity - # 'plotter.plot2d.opacity': [None, try_and_error(validate_none, - # validate_opacity)], - 'plotter.plot2d.datagrid': [ - None, try_and_error(validate_none, validate_dict, validate_str), - 'fmt key to plot the lines of the data grid'], - 'plotter.plot2d.mask_datagrid': [ - True, validate_bool, - 'fmt key to mask cells with NaN when plotting the data grid'], - - # VectorPlot - 'plotter.vector.plot': [ - 'quiver', try_and_error(validate_none, ValidateInStrings( - '2d plot', ['quiver', 'stream'], True)), - 'fmt key for the plot type of vector plots'], - 'plotter.vector.arrowsize': [ - None, try_and_error(validate_none, validate_float), - 'fmt key for the size of the arrows on vector plots'], - 'plotter.vector.arrowstyle': [ - '-|>', ValidateInStrings('arrowstyle', ArrowStyle._style_list), - 'fmt key for the style of the arrows on stream plots'], - 'plotter.vector.density': [ - 1.0, try_and_error(validate_float, ValidateList(float, 2)), - 'fmt key for the density of arrows on a vector plot'], - 'plotter.vector.linewidth': [ - None, LineWidthValidator('linewidth', ['absolute', 'u', 'v'], True), - 'fmt key for the linewidths of the arrows'], - 'plotter.vector.color': [ - 'k', try_and_error(validate_float, validate_color, ValidateInStrings( - 'color', ['absolute', 'u', 'v'], True)), - 'fmt key for the colors of the arrows'], - - # default texts - 'texts.labels': [{'tinfo': '%H:%M', - 'dtinfo': '%B %d, %Y. %H:%M', - 'dinfo': '%B %d, %Y', - 'desc': '%(long_name)s [%(units)s]', - 'sdesc': '%(name)s [%(units)s]'}, validate_dict, - 'labels that shall be replaced in TextBase formatoptions', - ' (e.g. the title formatoption) when inserted within ' - 'curly braces ({}))'], - 'texts.default_position': [(1., 1.), ValidateList(float, 2), - 'default position for the text fmt key'], - 'texts.delimiter': [', ', validate_str, - 'default delimiter to separate netCDF meta attributes ' - 'when displayed on the plot'], - - # ------------------------------------------------------------------------- - # ---------------------------- Miscallaneous ------------------------------ - # ------------------------------------------------------------------------- - - # color lists for user-defined colormaps (see for example - # psy_simple.colors._cmapnames) - 'colors.cmaps': [ - {}, validate_cmaps, - 'User defined color lists that shall be accessible through the ' - ':meth:`psyplot.plotter.colors.get_cmap` function'], - - 'widgets.colors.cmaps': [ - ["viridis", "Reds", "Blues", "Greens", "binary", "RdBu", "coolwarm", - "red_white_blue", "winter", "jet", "white_blue_red", "gist_ncar", - "gist_earth", "Paired", "gnuplot", "gnuplot2"], - validate_stringlist, - 'Colormaps that should be listed in the context menu of the cmap ' - 'button'], - - 'ticks.which': ['major', ValidateInStrings( - 'ticks.which', ['major', 'minor'], True), - 'default tick that is used when using a x- or y-tick formatoption'], - }) - - -# add combinedplotter strings for vectorplot -_subd = SubDict(rcParams.defaultParams, ['plotter.vector.', 'plotter.plot2d.']) -for _key in ['plot', 'cbar', 'cmap', 'bounds', 'cticksize', 'cbarspacing', - 'ctickweight', 'ctickprops', 'clabel', 'cticks', 'cticklabels', - 'clabelsize', 'clabelprops', 'clabelweight']: - rcParams.defaultParams['plotter.combinedsimple.v%s' % _key] = _subd[_key] -rcParams.defaultParams['plotter.combinedsimple.plot'] = rcParams.defaultParams[ - 'plotter.plot2d.plot'] -del _key, _subd - - -rcParams.update_from_defaultParams() diff --git a/psy_simple/widgets/__init__.py b/psy_simple/widgets/__init__.py deleted file mode 100644 index 73151b18..00000000 --- a/psy_simple/widgets/__init__.py +++ /dev/null @@ -1,61 +0,0 @@ -"""Module for PyQt4/PyQt5 widgets for modifying the formatoptions - -This module contains widgets that are inserted in the psyplot GUI. Submodules -are - -* :mod:`psy_simple.widgets.texts`: A module for the modification of labels -""" - -# Disclaimer -# ---------- -# -# Copyright (C) 2021 Helmholtz-Zentrum Hereon -# Copyright (C) 2020-2021 Helmholtz-Zentrum Geesthacht -# Copyright (C) 2016-2021 University of Lausanne -# -# This file is part of psy-simple and is released under the GNU LGPL-3.O license. -# See COPYING and COPYING.LESSER in the root of the repository for full -# licensing details. -# -# This program is free software: you can redistribute it and/or modify -# it under the terms of the GNU Lesser General Public License version 3.0 as -# published by the Free Software Foundation. -# -# 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 LGPL-3.0 license for more details. -# -# You should have received a copy of the GNU LGPL-3.0 license -# along with this program. If not, see . - -import os.path as osp -from functools import partial -from PyQt5 import QtWidgets - - -def get_icon(fname, ending='.png'): - return osp.join(osp.dirname(__file__), 'icons', fname + ending) - - -class Switch2FmtButton(QtWidgets.QToolButton): - """A button that contains a menu to switch to other formatoptions""" - - def __init__(self, parent, *fmtos): - """ - Parameters - ---------- - parent: psyplot_gui.fmt_widget.FormatoptionWidget - The formatoption widget that contains the button - ``*fmtos`` - Instances of the :class:`psyplot.plotter.Formatoption` for which - the links should be created - """ - super().__init__(parent=parent) - self.setText('fmt') - self.setPopupMode(QtWidgets.QToolButton.InstantPopup) - menu = QtWidgets.QMenu() - for fmto in fmtos: - name = parent.get_name(fmto) - menu.addAction(name, partial(parent.set_fmto, name)) - self.setMenu(menu) diff --git a/psy_simple/widgets/colors.py b/psy_simple/widgets/colors.py deleted file mode 100644 index 5c2d5dd4..00000000 --- a/psy_simple/widgets/colors.py +++ /dev/null @@ -1,1101 +0,0 @@ -"""Module for color specific widgets - -This module corresponds to the :mod:`psy_simple.colors` module as a version for -the usage in the psyplot GUI. -""" - -# Disclaimer -# ---------- -# -# Copyright (C) 2021 Helmholtz-Zentrum Hereon -# Copyright (C) 2020-2021 Helmholtz-Zentrum Geesthacht -# Copyright (C) 2016-2021 University of Lausanne -# -# This file is part of psy-simple and is released under the GNU LGPL-3.O license. -# See COPYING and COPYING.LESSER in the root of the repository for full -# licensing details. -# -# This program is free software: you can redistribute it and/or modify -# it under the terms of the GNU Lesser General Public License version 3.0 as -# published by the Free Software Foundation. -# -# 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 LGPL-3.0 license for more details. -# -# You should have received a copy of the GNU LGPL-3.0 license -# along with this program. If not, see . - -import six -import os.path as osp -from itertools import chain -from functools import partial -import contextlib -from psyplot.data import safe_list, rcParams -from psy_simple.widgets import Switch2FmtButton, get_icon -import psy_simple.colors as psc -from psy_simple.plugin import BoundsType, CTicksType -from psyplot.docstring import docstrings -import numpy as np -import xarray as xr -import matplotlib as mpl -import matplotlib.colors as mcol -from PyQt5 import QtWidgets, QtCore, QtGui -from PyQt5.QtCore import Qt - - -mpl_version = tuple(map(int, mpl.__version__.split('.')[:2])) - - -docstrings.delete_params('show_colormaps.parameters', 'show', 'use_qt') - - -class ColormapModel(QtCore.QAbstractTableModel): - """A model for displaying colormaps""" - - @docstrings.get_sections(base='ColormapModel') - @docstrings.with_indent(8) - def __init__(self, names=[], N=10, *args, **kwargs): - """ - Parameters - ---------- - %(show_colormaps.parameters.no_show|use_qt)s - - Other Parameters - ---------------- - ``*args, **kwargs`` - Anything else that is passed to the QAbstractTableModel - """ - super(ColormapModel, self).__init__(*args, **kwargs) - names = psc._get_cmaps(names) - self.set_colors(N, names) - - def set_colors(self, N=None, names=None): - self.names = names = names or self.names - self.N = N = N or self.N - - colors = np.zeros((len(names), N, 4)) - a = np.linspace(0, 1, N) - for i, cmap in enumerate(map(lambda name: psc.get_cmap(name, N), - names)): - colors[i, :, :] = cmap(a) - - self.color_da = xr.DataArray( - colors, coords={'cmap': list(map(str, names))}, - dims=('cmap', 'color', 'rgba')) - - def rowCount(self, index=QtCore.QModelIndex()): - return self.color_da.shape[0] - - def columnCount(self, index=QtCore.QModelIndex()): - return self.color_da.shape[1] - - def data(self, index, role=Qt.DisplayRole): - """Cell content""" - if not index.isValid(): - return None - if role == Qt.DisplayRole or role == Qt.EditRole: - return ' ' - if role == Qt.BackgroundColorRole: - color = self.color_da[index.row(), index.column()].values - return QtGui.QColor.fromRgbF(*color) - return None - - def headerData(self, section, orientation, role=Qt.DisplayRole): - """Set header data""" - if role != Qt.DisplayRole: - return None - if orientation == Qt.Vertical: - return six.text_type(self.color_da.cmap[section].values) - return super(ColormapModel, self).headerData(section, orientation, - role) - - def reset(self): - self.beginResetModel() - self.endResetModel() - - -class ColormapTable(QtWidgets.QTableView): - """A table for displaying colormaps""" - - @docstrings.with_indent(8) - def __init__(self, names=[], N=10, editable=True, *args, **kwargs): - """ - Parameters - ---------- - %(ColormapModel.parameters)s - - Other Parameters - ---------------- - ``*args, **kwargs`` - Anything else that is passed to the QtWidgets.QTableView - """ - super(ColormapTable, self).__init__(*args, **kwargs) - self.setModel(ColormapModel(names, N)) - if editable: - self.doubleClicked.connect(self.change_color) - self.setSelectionMode(QtWidgets.QTableView.SingleSelection) - self.setSelectionBehavior(QtWidgets.QTableView.SelectRows) - - def setModel(self, model): - super(ColormapTable, self).setModel(model) - self.orig_color_da = model.color_da.copy(True) - - def change_color(self, index): - model = self.model() - current = model.data(index, Qt.BackgroundColorRole) - if current is None: - return - color = QtWidgets.QColorDialog.getColor(current, parent=self) - if not color.isValid(): - return - model.color_da[index.row(), index.column(), :] = list(color.getRgbF()) - indices = self.selectedIndexes() - model.reset() - self.selectRow(indices[0].row()) - - def rowCount(self): - return self.model().rowCount() - - def columnCount(self): - return self.model().columnCount() - - @property - def chosen_colormap(self): - indexes = self.selectedIndexes() - if not indexes: - return - row = indexes[0].row() - model = self.model() - name = six.text_type(self.orig_color_da.cmap[row].values) - colors = model.color_da[row].values - orig_colors = self.orig_color_da[row].values - if np.allclose(colors, orig_colors): - return model.names[row] - return mcol.LinearSegmentedColormap.from_list( - name, colors, N=self.columnCount()) - - -class ColormapDialog(QtWidgets.QDialog): - """A widget for selecting a colormap""" - - @docstrings.with_indent(8) - def __init__(self, names=[], N=10, editable=True, *args, **kwargs): - """ - Parameters - ---------- - %(ColormapModel.parameters)s - - Other Parameters - ---------------- - ``*args, **kwargs`` - Anything else that is passed to the ColormapDialog - """ - super(QtWidgets.QDialog, self).__init__(*args, **kwargs) - vbox = QtWidgets.QVBoxLayout() - self.table = ColormapTable(names=names, N=N, editable=editable) - if editable: - vbox.addWidget(QtWidgets.QLabel("Double-click a color to edit")) - vbox.addWidget(self.table) - self.setLayout(vbox) - col_width = self.table.columnWidth(0) - header_width = self.table.verticalHeader().width() - row_height = self.table.rowHeight(0) - available = QtWidgets.QDesktopWidget().availableGeometry() - height = int(min(row_height * (self.table.rowCount() + 1), - 2. * available.height() / 3.)) - width = int(min(header_width + col_width * N + 0.5 * col_width, - 2. * available.width() / 3.)) - self.resize(QtCore.QSize(width, height)) - - @classmethod - @docstrings.with_indent(8) - def get_colormap(cls, names=[], N=10, *args, **kwargs): - """Open a :class:`ColormapDialog` and get a colormap - - Parameters - ---------- - %(ColormapModel.parameters)s - - Other Parameters - ---------------- - ``*args, **kwargs`` - Anything else that is passed to the ColormapDialog - - Returns - ------- - str or matplotlib.colors.Colormap - Either the name of a standard colormap available via - :func:`psy_simple.colors.get_cmap` or a colormap - """ - names = safe_list(names) - obj = cls(names, N, *args, **kwargs) - vbox = obj.layout() - buttons = QtWidgets.QDialogButtonBox( - QtWidgets.QDialogButtonBox.Ok | QtWidgets.QDialogButtonBox.Cancel, parent=obj) - buttons.button(QtWidgets.QDialogButtonBox.Ok).setEnabled(False) - vbox.addWidget(buttons) - buttons.accepted.connect(obj.accept) - buttons.rejected.connect(obj.reject) - - obj.table.selectionModel().selectionChanged.connect( - lambda indices: buttons.button(QtWidgets.QDialogButtonBox.Ok).setEnabled( - bool(indices))) - accepted = obj.exec_() - if accepted: - return obj.table.chosen_colormap - - docstrings.delete_params('show_colormaps.parameters', 'use_qt') - - @classmethod - @docstrings.with_indent(8) - def show_colormap(cls, names=[], N=10, show=True, *args, **kwargs): - """Show a colormap dialog - - Parameters - ---------- - %(show_colormaps.parameters.no_use_qt)s""" - names = safe_list(names) - obj = cls(names, N, *args, **kwargs) - vbox = obj.layout() - buttons = QtWidgets.QDialogButtonBox(QtWidgets.QDialogButtonBox.Close, parent=obj) - buttons.rejected.connect(obj.close) - vbox.addWidget(buttons) - if show: - obj.show() - return obj - - -def create_cmap_thumb(cmap, output=None): - from matplotlib.figure import Figure - from matplotlib.cm import ScalarMappable - - fig = Figure(figsize=(4., 0.2)) - cax = fig.add_axes([0, 0, 1, 1]) - _cmap = psc.get_cmap(cmap) - mappable = ScalarMappable(cmap=_cmap) - mappable.set_array([]) - fig.colorbar(mappable, cmap=_cmap, cax=cax, orientation='horizontal') - if output: - fig.savefig(output, dpi=72) - return fig - - -class HighlightWidget(QtWidgets.QWidget): - - def set_highlighted(self, b): - self.setBackgroundRole(QtGui.QPalette.Highlight if b else - QtGui.QPalette.Window) - self.setAutoFillBackground(b) - - def enterEvent(self, event): - self.set_highlighted(True) - - def leaveEvent(self, event): - self.set_highlighted(False) - - -class CmapButton(QtWidgets.QToolButton): - """A button with a dropdown menu to select colormaps""" - - # a signal that is triggered if the colormap has been changed - colormap_changed = QtCore.pyqtSignal([str], [mcol.Colormap]) - - def __init__(self, cmaps=None, current=None, *args, **kwargs): - super().__init__(*args, **kwargs) - - if cmaps is None: - cmaps = list(rcParams['widgets.colors.cmaps']) - - self.cmaps = cmaps - - self.setText(current or cmaps[0]) - self.cmap_menu = self.setup_cmap_menu() - self.setMenu(self.cmap_menu) - - max_width = max(map(self.fontMetrics().width, cmaps)) * 2 - self.setMinimumWidth(max_width) - self.setPopupMode(QtWidgets.QToolButton.InstantPopup) - - def setup_cmap_menu(self): - menu = QtWidgets.QMenu() - for cmap in self.cmaps: - icon = get_icon(osp.join('cmaps', cmap)) - if osp.exists(icon): - action = QtWidgets.QWidgetAction(menu) - w = HighlightWidget() - hbox = QtWidgets.QVBoxLayout() - label = QtWidgets.QLabel() - label.setPixmap(QtGui.QPixmap(icon)) - hbox.addWidget(label) - cmap_label = QtWidgets.QLabel(cmap) - hbox.addWidget(cmap_label) - w.setLayout(hbox) - action.setDefaultWidget(w) - action.triggered.connect(partial(self.set_cmap, cmap)) - menu.addAction(action) - else: - menu.addAction(cmap, partial(self.set_cmap, cmap)) - return menu - - def set_cmap(self, cmap): - if isinstance(cmap, str): - self.setText(str(cmap)) - self.colormap_changed[str].emit(cmap) - else: - self.setText('Custom') - self.colormap_changed[mcol.Colormap].emit(cmap) - - def open_cmap_dialog(self, N=10): - cmap = ColormapDialog.get_colormap(N=N) - if cmap is not None: - self.set_cmap(cmap) - - -class ColorLabel(QtWidgets.QTableWidget): - """A QTableWidget with one cell and no headers to just display a color""" - - #: a signal that is emitted with an rgba color if the chosen color changes - color_changed = QtCore.pyqtSignal(QtGui.QColor) - - #: QtCore.QColor. The current color that is displayed - color = None - - def __init__(self, color='w', *args, **kwargs): - """The color to display - - Parameters - ---------- - color: object - Either a QtGui.QColor object or a color that can be converted - to RGBA using the :func:`matplotlib.colors.to_rgba` function""" - super(ColorLabel, self).__init__(*args, **kwargs) - self.setColumnCount(1) - self.setRowCount(1) - self.setVerticalScrollBarPolicy(Qt.ScrollBarAlwaysOff) - self.setHorizontalScrollBarPolicy(Qt.ScrollBarAlwaysOff) - self.horizontalHeader().setHidden(True) - self.horizontalHeader().setSectionResizeMode( - QtWidgets.QHeaderView.Stretch) - self.verticalHeader().setHidden(True) - self.verticalHeader().setSectionResizeMode(QtWidgets.QHeaderView.Stretch) - self.setEditTriggers(QtWidgets.QTableWidget.NoEditTriggers) - self.setSelectionMode(QtWidgets.QTableWidget.NoSelection) - self.itemClicked.connect(self.select_color) - self.color_item = QtWidgets.QTableWidgetItem() - self.setItem(0, 0, self.color_item) - self.adjust_height() - self.set_color(color) - self.orig_color = self.color - - self.setMaximumWidth(80) - - def select_color(self, *args): - """Select a color using :meth:`PyQt5.QtWidgets.QColorDialog.getColor` - """ - color = QtWidgets.QColorDialog.getColor( - self.color_item.background().color()) - if color.isValid(): - self.set_color(color) - - def set_color(self, color): - """Set the color of the label - - This method sets the given `color` as background color for the cell - and emits the :attr:`color_changed` signal - - Parameters - ---------- - color: object - Either a QtGui.QColor object or a color that can be converted - to RGBA using the :func:`matplotlib.colors.to_rgba` function""" - color = self._set_color(color) - self.color_changed.emit(color) - - def setEnabled(self, b): - if not b: - orig_color = self.color - self._set_color('0.75') - self.color = orig_color - else: - self._set_color(self.color) - super().setEnabled(b) - - def _set_color(self, color): - if not isinstance(color, QtGui.QColor): - color = QtGui.QColor( - *map(int, np.round(np.array(mcol.to_rgba(color)) * 255))) - self.color_item.setBackground(color) - self.color = color - return color - - def adjust_height(self): - """Adjust the height to match the row height""" - h = self.rowHeight(0) * self.rowCount() - self.setMaximumHeight(h) - self.setMinimumHeight(h) - - def sizeHint(self): - """Reimplemented to use the rowHeight as height""" - s = super(ColorLabel, self).sizeHint() - return QtCore.QSize(s.width(), self.rowHeight(0) * self.rowCount()) - - -class BackGroundColorWidget(QtWidgets.QWidget): - """The widget to select the axes background color""" - - def __init__(self, parent, fmto, project): - super().__init__() - ax = fmto.ax - self.cb_enable = QtWidgets.QCheckBox('transparent') - self.color_label = ColorLabel(ax.patch.get_facecolor()) - self.editor = parent - - self.cb_enable.setChecked(fmto.value is None) - - self.toggle_color_button() - - self.color_label.color_changed.connect(self.set_color) - - self.cb_enable.stateChanged.connect(self.toggle_color_button) - self.cb_enable.stateChanged.connect(self.set_transparent) - - layout = QtWidgets.QHBoxLayout() - layout.addWidget(QtWidgets.QLabel('Select color:')) - layout.addWidget(self.color_label) - layout.addWidget(self.cb_enable) - layout.addStretch(0) - self.setLayout(layout) - - def set_transparent(self): - if self.cb_enable.isChecked(): - self.editor.set_obj(None) - else: - self.set_color(self.color_label.color) - - def toggle_color_button(self): - self.color_label.setEnabled(not self.cb_enable.isChecked()) - - def set_color(self, color): - if isinstance(color, QtGui.QColor): - color = list(color.getRgbF()) - self.editor.set_obj(color) - - -class CMapFmtWidget(QtWidgets.QWidget): - """The widget for modifying the :class:`psy_simple.plotters.CMap` fmt""" - - def __init__(self, parent, fmto, project, properties=True): - QtWidgets.QWidget.__init__(self, parent) - hbox = QtWidgets.QHBoxLayout() - - self.editor = parent - - # add a select colormap button - self.btn_choose = button = CmapButton() - button.colormap_changed.connect(self.set_obj) - button.colormap_changed[mcol.Colormap].connect(self.set_obj) - self.btn_choose.cmap_menu.addSeparator() - self.btn_choose.cmap_menu.addAction( - 'More...', partial(self.choose_cmap, None)) - - if isinstance(fmto.value, str): - self.btn_choose.setText(fmto.value) - else: - self.btn_choose.setText("Custom") - - hbox.addWidget(button) - - # add a show colormap button - self.btn_show = button = QtWidgets.QPushButton('Edit...') - button.clicked.connect(self.edit_cmap) - hbox.addWidget(button) - - # add a checkbox to invert the colormap - self.cb_invert = QtWidgets.QCheckBox("Inverted") - self.cb_invert.setEnabled(isinstance(fmto.value, str)) - if isinstance(fmto.value, str): - self.cb_invert.setChecked(fmto.value.endswith('_r')) - self.cb_invert.stateChanged.connect(self.invert_cmap) - hbox.addWidget(self.cb_invert) - - hbox.addStretch(0) - - if properties: - hbox.addWidget(Switch2FmtButton(parent, fmto.bounds, fmto.cbar)) - - self.setLayout(hbox) - - def set_obj(self, obj): - self.editor.set_obj(obj) - self.invert_cmap() - - def invert_cmap(self): - try: - value = self.editor.get_obj() - except Exception: - return - if isinstance(value, str): - self.cb_invert.setEnabled(True) - if self.cb_invert.isChecked() and not value.endswith('_r'): - self.editor.set_obj(value + '_r') - elif value.endswith('_r'): - self.editor.set_obj(value[:-2]) - else: - self.refresh_cb_invert(value) - - def refresh_cb_invert(self, obj): - try: - self.cb_invert.blockSignals(True) - if isinstance(obj, str): - self.cb_invert.setEnabled(True) - self.cb_invert.setChecked(obj.endswith('_r')) - else: - self.cb_invert.setEnabled(False) - self.cb_invert.setChecked(False) - finally: - self.cb_invert.blockSignals(False) - - def choose_cmap(self, cmap=None): - if cmap is None: - editor = self.editor - N = getattr(editor.fmto.bounds.norm, 'Ncmap', 10) - self.btn_choose.open_cmap_dialog(N) - else: - self.set_obj(cmap) - - def edit_cmap(self): - editor = self.editor - cmap = editor.get_obj() - if cmap is not None: - cmap = ColormapDialog.get_colormap( - cmap, N=getattr(editor.fmto.bounds.norm, 'Ncmap', 10), - parent=self) - if cmap is not None: - editor.set_obj(cmap) - - -class DataTicksCalculatorFmtWidget(QtWidgets.QWidget): - """Fmt widget for :class:`psy_simple.plotters.DataTicksCalculator` - - This widget contains a combo box with the different options from the - :attr:`psy_simple.plotters.DataTicksCalculator.calc_funcs`, a spin box - for the number of increments and two text widgets for minimum and maximum - percentile""" - - def __init__(self, parent, method=None, methods_type=BoundsType): - self.methods_type = methods_type - QtWidgets.QWidget.__init__(self, parent) - - self.method = method - - hbox = QtWidgets.QHBoxLayout() - - self.sb_N = QtWidgets.QSpinBox() - self.sb_N.setSpecialValueText('auto') - self.sb_N.setMinimum(0) - hbox.addWidget(self.sb_N) - - self.txt_min_pctl = QtWidgets.QLineEdit() - self.txt_min_pctl.setValidator(QtGui.QDoubleValidator(0., 100., 10)) - - - hbox.addWidget(QtWidgets.QLabel('Min.:')) - - self.combo_min = QtWidgets.QComboBox() - self.combo_min.addItems(['absolute', 'percentile']) - hbox.addWidget(self.combo_min) - - hbox.addWidget(self.txt_min_pctl) - - self.txt_max_pctl = QtWidgets.QLineEdit() - self.txt_max_pctl.setValidator(QtGui.QDoubleValidator(0., 100., 10)) - hbox.addWidget(QtWidgets.QLabel('Max.:')) - - self.combo_max = QtWidgets.QComboBox() - self.combo_max.addItems(['absolute', 'percentile']) - hbox.addWidget(self.combo_max) - - hbox.addWidget(self.txt_max_pctl) - - self.sb_N.valueChanged.connect(self.set_obj) - self.combo_min.currentIndexChanged.connect(self.set_obj) - self.combo_max.currentIndexChanged.connect(self.set_obj) - self.txt_min_pctl.textChanged.connect(self.set_obj) - self.txt_max_pctl.textChanged.connect(self.set_obj) - - self.setLayout(hbox) - - def set_obj(self): - obj = { - 'method': self.method, - 'N': self.sb_N.value() or None, - } - if self.txt_min_pctl.text().strip(): - key = 'vmin' if self.combo_min.currentText() == 'absolute' else \ - 'percmin' - obj[key] = float(self.txt_min_pctl.text().strip()) - if self.txt_max_pctl.text().strip(): - key = 'vmax' if self.combo_max.currentText() == 'absolute' else \ - 'percmax' - obj[key] = float(self.txt_max_pctl.text().strip()) - val = list(self.methods_type(**obj)) - try: - val[0] = val[0].name - except AttributeError: - pass - self.parent().set_obj(val) - - def refresh(self, method, fmto): - value = fmto.value - if value is None: - value = self.methods_type(method) - try: - value = self.methods_type(*value) - except (ValueError, TypeError): - pass - else: - self.sb_N.setValue(value.N or 0) - - bounds_val = value.method.name in ['bounds', 'midbounds'] - self.txt_min_pctl.setEnabled(not bounds_val) - self.txt_max_pctl.setEnabled(not bounds_val) - self.combo_min.setEnabled(not bounds_val) - self.combo_max.setEnabled(not bounds_val) - - decimals = None - if value.vmin is not None and value.vmax is not None: - decimals = self.get_decimals(value.vmin, value.vmax) - if value.vmin is not None: - if decimals is None: - decimals = -np.floor(np.log10(value.vmin)) + 4 - self.txt_min_pctl.setText(str(np.round(value.vmin, decimals))) - self.combo_min.setCurrentText('absolute') - elif value.percmin != 0: - self.txt_min_pctl.setText('%1.6g' % value.percmin) - self.combo_min.setCurrentText('percentile') - - if value.vmax is not None: - if decimals is None: - decimals = -np.floor(np.log10(value.vmax)) + 4 - self.txt_max_pctl.setText(str(np.round(value.vmax, decimals))) - self.combo_max.setCurrentText('absolute') - elif value.percmax != 100: - self.txt_max_pctl.setText('%1.6g' % value.percmax) - self.combo_max.setCurrentText('percentile') - - @staticmethod - def get_decimals(vmin, vmax): - if vmin == vmax: - decimals = 4 - else: - decimals = -np.floor(np.log10(abs(vmax - vmin))) + 4 - return int(decimals) - - -class ArrayFmtWidget(QtWidgets.QWidget): - """Fmt widget for :class:`psy_simple.plotters.DataTicksCalculator` - - This formatoption widgets contains 3 line edits, one for the minimum, one - for the maximum and one for the step size. And a spin box for the number - of increments""" - - def __init__(self, parent, array=None): - QtWidgets.QWidget.__init__(self, parent) - - self.txt_min = QtWidgets.QLineEdit() - self.txt_min.setValidator(QtGui.QDoubleValidator()) - self.txt_max = QtWidgets.QLineEdit() - self.txt_max.setValidator(QtGui.QDoubleValidator()) - self.txt_step = QtWidgets.QLineEdit() - self.txt_step.setValidator(QtGui.QDoubleValidator(1e-10, 1e10, 10)) - self.sb_nsteps = QtWidgets.QSpinBox() - self.step_inc_combo = combo = QtWidgets.QComboBox() - combo.addItems(['Step', '# Steps']) - - if array is not None: - vmin, vmax = array.min(), array.max() - decimals = self.get_decimals(vmin, vmax) - - self.txt_min.setText(f'%1.{decimals}g' % vmin) - self.txt_max.setText(f'%1.{decimals}g' % vmax) - steps = np.diff(array) - if len(steps) == 1 or np.diff(steps).max() < 1e-5: - self.txt_step.setText(f'%1.{decimals}g' % steps[0]) - combo.setCurrentIndex(0) - else: - combo.setCurrentIndex(1) - self.sb_nsteps.setValue(len(array)) - - self.toggle_txt_step(combo.currentText()) - - hbox = QtWidgets.QHBoxLayout() - hbox.addWidget(QtWidgets.QLabel('Min.')) - hbox.addWidget(self.txt_min) - hbox.addWidget(QtWidgets.QLabel('Max.')) - hbox.addWidget(self.txt_max) - hbox.addWidget(combo) - hbox.addWidget(self.txt_step) - hbox.addWidget(self.sb_nsteps) - self.setLayout(hbox) - - for w in [self.txt_min, self.txt_max, self.txt_step]: - w.textChanged.connect(self.set_array) - self.sb_nsteps.valueChanged.connect(self.set_array) - - combo.currentTextChanged.connect(self.toggle_txt_step) - - def toggle_txt_step(self, s): - show_step = s == 'Step' - self.txt_step.setVisible(show_step) - self.sb_nsteps.setVisible(not show_step) - self.txt_step.setEnabled(show_step) - self.sb_nsteps.setEnabled(not show_step) - self.set_array() - - @staticmethod - def get_decimals(vmin, vmax): - if vmin == vmax: - decimals = 4 - else: - decimals = -np.floor(np.log10(abs(vmax - vmin))) + 4 - return int(decimals) - - def set_array(self, *args, **kwargs): - try: - vmin = float(self.txt_min.text()) - except (ValueError, TypeError): - return - try: - vmax = float(self.txt_max.text()) - except (ValueError, TypeError): - return - if self.txt_step.isEnabled(): - try: - step = float(self.txt_step.text().strip()) - except (ValueError, TypeError): - return - arr = np.arange(vmin, vmax + 0.05 * step, step) - else: - arr = np.linspace(vmin, vmax, self.sb_nsteps.value()) - self.parent().set_obj( - np.round(arr, self.get_decimals(vmin, vmax)).tolist()) - - def set_obj(self): - self.set_array() - - -class NormalizationWidget(QtWidgets.QWidget): - """A simple widget representing a boundary norm""" - - def __init__(self, parent, norm): - QtWidgets.QWidget.__init__(self, parent) - self.norm = norm - - validator = QtGui.QDoubleValidator() - self.txt_min = QtWidgets.QLineEdit() - self.txt_min.setValidator(validator) - self.txt_max = QtWidgets.QLineEdit() - self.txt_max.setValidator(validator) - - self.lbl_linthresh = QtWidgets.QLabel('linthresh:') - self.txt_linthresh = QtWidgets.QLineEdit() # linthresh for SymLogNorm - self.txt_linthresh.setValidator(validator) - self.txt_linthresh.setToolTip( - 'The threshold for linear scaling. Within this distance from 0, ' - 'the scaling will be linear, not logarithmic.') - - self.lbl_gamma = QtWidgets.QLabel('gamma:') - self.txt_gamma = QtWidgets.QLineEdit() # gamma for PowerNorm - self.txt_gamma.setValidator(validator) - self.txt_gamma.setToolTip('The power value for the PowerNorm') - - self.fill_from_norm() - - hbox = QtWidgets.QHBoxLayout() - hbox.addWidget(QtWidgets.QLabel('Min.:')) - hbox.addWidget(self.txt_min) - hbox.addWidget(QtWidgets.QLabel('Max.:')) - hbox.addWidget(self.txt_max) - hbox.addWidget(self.lbl_linthresh) - hbox.addWidget(self.txt_linthresh) - hbox.addWidget(self.lbl_gamma) - hbox.addWidget(self.txt_gamma) - self.setLayout(hbox) - - self.txt_min.textChanged.connect(self.set_obj) - self.txt_max.textChanged.connect(self.set_obj) - self.txt_linthresh.textChanged.connect(self.set_obj) - self.txt_gamma.textChanged.connect(self.set_obj) - - def fill_from_norm(self): - norm = self.norm - if norm.vmin is not None: - self.txt_min.setText('%1.6g' % norm.vmin) - if norm.vmax is not None: - self.txt_max.setText('%1.6g' % norm.vmax) - if isinstance(self.norm, mcol.SymLogNorm): - self.txt_linthresh.setVisible(True) - self.txt_linthresh.setEnabled(True) - self.lbl_linthresh.setVisible(True) - self.txt_linthresh.setText('%1.6g' % norm.linthresh) - else: - self.txt_linthresh.setVisible(False) - self.txt_linthresh.setEnabled(False) - self.lbl_linthresh.setVisible(False) - if isinstance(norm, mcol.PowerNorm): - self.txt_gamma.setVisible(True) - self.txt_gamma.setEnabled(True) - self.lbl_gamma.setVisible(True) - self.txt_gamma.setText('%1.6g' % norm.gamma) - else: - self.txt_gamma.setVisible(False) - self.txt_gamma.setEnabled(False) - self.lbl_gamma.setVisible(False) - - def set_obj(self): - cls = self.norm.__class__ - kws = {} - if issubclass(cls, mcol.PowerNorm): - args = [float(self.txt_gamma.text().strip() or 1.0)] - elif issubclass(cls, mcol.SymLogNorm): - args = [float(self.txt_linthresh.text().strip() or 1e-3)] - if mpl_version >= (3, 2): - kws["base"] = 10 - else: - args = [] - vmin = vmax = None - if self.txt_min.text().strip(): - vmin = float(self.txt_min.text().strip()) - if self.txt_max.text().strip(): - vmax = float(self.txt_max.text().strip()) - try: - norm = cls(*args, vmin=vmin, vmax=vmax, **kws) - except Exception: - pass - else: - self.parent().set_obj(norm) - - -class BoundsFmtWidget(QtWidgets.QWidget): - """The widget for modifying the :class:`psy_simple.plotters.Bounds` fmt""" - - _array_widget = None - - _auto_array_widget = None - - _norm_widget = None - - current_widget = None - - methods_type = BoundsType - - norm_map = { - 'No normalization': mcol.Normalize, - 'log': mcol.LogNorm, - 'symlog': mcol.SymLogNorm, - 'power-law': mcol.PowerNorm, - } - - default_args = { - 'symlog': [1e-3], # linthresh - 'power-law': [1.0] # gamma - } - - default_kws = { - "symlog": {"base": 10} if mpl_version >= (3, 2) else {} - } - - methods = ['Discrete', 'Continuous'] - - def __init__(self, parent, fmto, project, properties=True): - QtWidgets.QWidget.__init__(self, parent) - self._editor = parent - hbox = QtWidgets.QHBoxLayout() - - self.type_combo = QtWidgets.QComboBox(self) - self.type_combo.addItems(self.methods) - - self.method_combo = QtWidgets.QComboBox(self) - - self.discrete_items = sorted(fmto.calc_funcs) + ['Custom'] - - hbox.addWidget(self.type_combo) - hbox.addWidget(self.method_combo) - hbox.addStretch(0) - - self.type_combo.currentTextChanged.connect(self.refresh_methods) - self.method_combo.currentTextChanged.connect( - self.refresh_current_widget) - - # add a button to select other formatoptions - if properties: - hbox.addWidget(Switch2FmtButton(parent, fmto.cmap, fmto.cbar)) - self.setLayout(hbox) - - self.set_value(fmto.value) - - def set_value(self, value): - with self.block_widgets(self.method_combo, self.type_combo): - if value is None: - self.type_combo.setCurrentText('Continuous') - self.refresh_methods('Continuous') - self.method_combo.setCurrentText('No normalization') - elif isinstance(value, mcol.Normalize) and not hasattr( - value, 'boundaries'): - self.type_combo.setCurrentText('Continuous') - self.refresh_methods('Continuous') - - if isinstance(value, mcol.LogNorm): - self.method_combo.setCurrentText('log') - elif isinstance(value, mcol.SymLogNorm): - self.method_combo.setCurrentText('symlog') - elif isinstance(value, mcol.PowerNorm): - self.method_combo.setCurrentText('power-law') - else: - self.method_combo.setCurrentText('Custom') - else: - self.type_combo.setCurrentText('Discrete') - self.refresh_methods('Discrete') - if not isinstance(value, mcol.Normalize) and isinstance( - value[0], six.string_types): - self.method_combo.setCurrentText(value[0]) - else: - self.method_combo.setCurrentText('Custom') - - self.refresh_methods(self.type_combo.currentText()) - - @contextlib.contextmanager - def block_widgets(self, *widgets): - for w in widgets: - w.blockSignals(True) - yield - for w in widgets: - w.blockSignals(False) - - def refresh_methods(self, text): - current = self.method_combo.currentText() - with self.block_widgets(self.method_combo): - self.method_combo.clear() - if text == 'Discrete': - items = self.discrete_items - self.method_combo.addItems(items) - if current in items: - self.method_combo.setCurrentText(current) - elif current == 'No normalization' and 'rounded' in items: - self.method_combo.setCurrentText('rounded') - else: - self.method_combo.addItems(list(self.norm_map)) - if current in self.norm_map: - self.method_combo.setCurrentText(current) - else: - self.method_combo.setCurrentText('No normalization') - - self.refresh_current_widget() - - def refresh_current_widget(self): - if self.current_widget is not None: - self.current_widget.setVisible(False) - if self.type_combo.currentText() == 'Continuous': - s = self.method_combo.currentText() - norm = self.norm_map[s](*self.default_args.get(s, []), - **self.default_kws.get(s, {})) - self.current_widget = self.get_norm_widget(norm) - else: - if self.method_combo.currentText() != 'Custom': - self.current_widget = self.get_auto_discrete_array_widget() - else: - self.current_widget = self.get_discrete_array_widget() - if self.current_widget is not None: - self.current_widget.setVisible(True) - self.current_widget.set_obj() - - def get_auto_discrete_array_widget(self): - method = self.method_combo.currentText() - if self._auto_array_widget is not None: - self._auto_array_widget.method = method - else: - self._auto_array_widget = DataTicksCalculatorFmtWidget( - self._editor, method, self.methods_type) - self.layout().insertWidget(3, self._auto_array_widget) - - fmto = self._editor.fmto - self._auto_array_widget.refresh( - self.method_combo.currentText(), fmto) - return self._auto_array_widget - - def get_discrete_array_widget(self): - if self._array_widget is not None: - return self._array_widget - fmto = self._editor.fmto - try: - arr = fmto.norm.boundaries - except AttributeError: - arr = fmto.calc_funcs['rounded']() - self._array_widget = ArrayFmtWidget(self._editor, arr) - self.layout().insertWidget(3, self._array_widget) - return self._array_widget - - def get_norm_widget(self, norm): - if self._norm_widget is not None: - if norm.__class__ is not self._norm_widget.norm.__class__: - # don't use isinstance here because of mcol.Normalize - self._norm_widget.norm = norm - self._norm_widget.fill_from_norm() - return self._norm_widget - self._norm_widget = NormalizationWidget(self._editor, norm) - self.layout().insertWidget(3, self._norm_widget) - return self._norm_widget - - def set_obj(self, obj): - self._editor.set_obj(obj) - - -class CTicksFmtWidget(BoundsFmtWidget): - """The formatoptions widget for the colorbar ticks.""" - - methods = ['Discrete', 'Auto'] - - norm_map = {} - - methods_type = CTicksType - - auto_val = None - - def set_value(self, value): - if value is self.auto_val: - with self.block_widgets(self.method_combo, self.type_combo): - self.type_combo.setCurrentText('Auto') - self.refresh_methods('Auto') - else: - super().set_value(value) - - def refresh_methods(self, text): - if text == 'Auto': - with self.block_widgets(self.method_combo): - self.method_combo.clear() - self.set_obj(self.auto_val) - self.refresh_current_widget() - else: - super().refresh_methods(text) - - def refresh_current_widget(self): - w = self.current_widget - auto_ticks = self.type_combo.currentText() == 'Auto' - if auto_ticks and w is not None: - w.setVisible(False) - self.current_widget = None - if not auto_ticks: - super().refresh_current_widget() - - -if __name__ == '__main__': - # build colormap thumbnails - import matplotlib.pyplot as plt - available_cmaps = set( - chain(plt.cm.cmap_d, psc._cmapnames, rcParams['colors.cmaps'])) - N = len(available_cmaps) - for i, cmap in enumerate(available_cmaps, 1): - print("%i of %i: Generating thumb %s" % (i, N, cmap)) - create_cmap_thumb(cmap, get_icon(osp.join('cmaps', cmap))) \ No newline at end of file diff --git a/psy_simple/widgets/icons/bold.png b/psy_simple/widgets/icons/bold.png deleted file mode 100644 index 41bf54c4..00000000 Binary files a/psy_simple/widgets/icons/bold.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/Accent.png b/psy_simple/widgets/icons/cmaps/Accent.png deleted file mode 100644 index b58f05d0..00000000 Binary files a/psy_simple/widgets/icons/cmaps/Accent.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/Accent_r.png b/psy_simple/widgets/icons/cmaps/Accent_r.png deleted file mode 100644 index f75cd0a8..00000000 Binary files a/psy_simple/widgets/icons/cmaps/Accent_r.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/Blues.png b/psy_simple/widgets/icons/cmaps/Blues.png deleted file mode 100644 index 2c3e0511..00000000 Binary files a/psy_simple/widgets/icons/cmaps/Blues.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/Blues_r.png b/psy_simple/widgets/icons/cmaps/Blues_r.png deleted file mode 100644 index 6ab33947..00000000 Binary files a/psy_simple/widgets/icons/cmaps/Blues_r.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/BrBG.png b/psy_simple/widgets/icons/cmaps/BrBG.png deleted file mode 100644 index 4e54e6c2..00000000 Binary files a/psy_simple/widgets/icons/cmaps/BrBG.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/BrBG_r.png b/psy_simple/widgets/icons/cmaps/BrBG_r.png deleted file mode 100644 index 61ab40f1..00000000 Binary files a/psy_simple/widgets/icons/cmaps/BrBG_r.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/BuGn.png b/psy_simple/widgets/icons/cmaps/BuGn.png deleted file mode 100644 index 27ccebcf..00000000 Binary files a/psy_simple/widgets/icons/cmaps/BuGn.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/BuGn_r.png b/psy_simple/widgets/icons/cmaps/BuGn_r.png deleted file mode 100644 index a21fbb5f..00000000 Binary files a/psy_simple/widgets/icons/cmaps/BuGn_r.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/BuPu.png b/psy_simple/widgets/icons/cmaps/BuPu.png deleted file mode 100644 index 0a7ec589..00000000 Binary files a/psy_simple/widgets/icons/cmaps/BuPu.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/BuPu_r.png b/psy_simple/widgets/icons/cmaps/BuPu_r.png deleted file mode 100644 index 58ecd876..00000000 Binary files a/psy_simple/widgets/icons/cmaps/BuPu_r.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/CMRmap.png b/psy_simple/widgets/icons/cmaps/CMRmap.png deleted file mode 100644 index 135b47ae..00000000 Binary files a/psy_simple/widgets/icons/cmaps/CMRmap.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/CMRmap_r.png b/psy_simple/widgets/icons/cmaps/CMRmap_r.png deleted file mode 100644 index adc9843d..00000000 Binary files a/psy_simple/widgets/icons/cmaps/CMRmap_r.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/Dark2.png b/psy_simple/widgets/icons/cmaps/Dark2.png deleted file mode 100644 index b93379bd..00000000 Binary files a/psy_simple/widgets/icons/cmaps/Dark2.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/Dark2_r.png b/psy_simple/widgets/icons/cmaps/Dark2_r.png deleted file mode 100644 index cc73a5e1..00000000 Binary files a/psy_simple/widgets/icons/cmaps/Dark2_r.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/GnBu.png b/psy_simple/widgets/icons/cmaps/GnBu.png deleted file mode 100644 index 4db9c1fc..00000000 Binary files a/psy_simple/widgets/icons/cmaps/GnBu.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/GnBu_r.png b/psy_simple/widgets/icons/cmaps/GnBu_r.png deleted file mode 100644 index 67717164..00000000 Binary files a/psy_simple/widgets/icons/cmaps/GnBu_r.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/Greens.png b/psy_simple/widgets/icons/cmaps/Greens.png deleted file mode 100644 index 81dd361c..00000000 Binary files a/psy_simple/widgets/icons/cmaps/Greens.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/Greens_r.png b/psy_simple/widgets/icons/cmaps/Greens_r.png deleted file mode 100644 index b86428cd..00000000 Binary files a/psy_simple/widgets/icons/cmaps/Greens_r.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/Greys.png b/psy_simple/widgets/icons/cmaps/Greys.png deleted file mode 100644 index e3b91494..00000000 Binary files a/psy_simple/widgets/icons/cmaps/Greys.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/Greys_r.png b/psy_simple/widgets/icons/cmaps/Greys_r.png deleted file mode 100644 index d4b5dcad..00000000 Binary files a/psy_simple/widgets/icons/cmaps/Greys_r.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/OrRd.png b/psy_simple/widgets/icons/cmaps/OrRd.png deleted file mode 100644 index b92473aa..00000000 Binary files a/psy_simple/widgets/icons/cmaps/OrRd.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/OrRd_r.png b/psy_simple/widgets/icons/cmaps/OrRd_r.png deleted file mode 100644 index 0770caf8..00000000 Binary files a/psy_simple/widgets/icons/cmaps/OrRd_r.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/Oranges.png b/psy_simple/widgets/icons/cmaps/Oranges.png deleted file mode 100644 index ead1e973..00000000 Binary files a/psy_simple/widgets/icons/cmaps/Oranges.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/Oranges_r.png b/psy_simple/widgets/icons/cmaps/Oranges_r.png deleted file mode 100644 index 802c48b9..00000000 Binary files a/psy_simple/widgets/icons/cmaps/Oranges_r.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/PRGn.png b/psy_simple/widgets/icons/cmaps/PRGn.png deleted file mode 100644 index ad3bd9aa..00000000 Binary files a/psy_simple/widgets/icons/cmaps/PRGn.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/PRGn_r.png b/psy_simple/widgets/icons/cmaps/PRGn_r.png deleted file mode 100644 index 3c334214..00000000 Binary files a/psy_simple/widgets/icons/cmaps/PRGn_r.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/Paired.png b/psy_simple/widgets/icons/cmaps/Paired.png deleted file mode 100644 index ff1091fb..00000000 Binary files a/psy_simple/widgets/icons/cmaps/Paired.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/Paired_r.png b/psy_simple/widgets/icons/cmaps/Paired_r.png deleted file mode 100644 index 9895a877..00000000 Binary files a/psy_simple/widgets/icons/cmaps/Paired_r.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/Pastel1.png b/psy_simple/widgets/icons/cmaps/Pastel1.png deleted file mode 100644 index 8bc0e44f..00000000 Binary files a/psy_simple/widgets/icons/cmaps/Pastel1.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/Pastel1_r.png b/psy_simple/widgets/icons/cmaps/Pastel1_r.png deleted file mode 100644 index 31c5bb00..00000000 Binary files a/psy_simple/widgets/icons/cmaps/Pastel1_r.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/Pastel2.png b/psy_simple/widgets/icons/cmaps/Pastel2.png deleted file mode 100644 index f2645104..00000000 Binary files a/psy_simple/widgets/icons/cmaps/Pastel2.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/Pastel2_r.png b/psy_simple/widgets/icons/cmaps/Pastel2_r.png deleted file mode 100644 index 03f84985..00000000 Binary files a/psy_simple/widgets/icons/cmaps/Pastel2_r.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/PiYG.png b/psy_simple/widgets/icons/cmaps/PiYG.png deleted file mode 100644 index 59cc545f..00000000 Binary files a/psy_simple/widgets/icons/cmaps/PiYG.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/PiYG_r.png b/psy_simple/widgets/icons/cmaps/PiYG_r.png deleted file mode 100644 index 9f20504f..00000000 Binary files a/psy_simple/widgets/icons/cmaps/PiYG_r.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/PuBu.png b/psy_simple/widgets/icons/cmaps/PuBu.png deleted file mode 100644 index a75715ea..00000000 Binary files a/psy_simple/widgets/icons/cmaps/PuBu.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/PuBuGn.png b/psy_simple/widgets/icons/cmaps/PuBuGn.png deleted file mode 100644 index 9a2c4fd6..00000000 Binary files a/psy_simple/widgets/icons/cmaps/PuBuGn.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/PuBuGn_r.png b/psy_simple/widgets/icons/cmaps/PuBuGn_r.png deleted file mode 100644 index b7fb3d55..00000000 Binary files a/psy_simple/widgets/icons/cmaps/PuBuGn_r.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/PuBu_r.png b/psy_simple/widgets/icons/cmaps/PuBu_r.png deleted file mode 100644 index c00ad391..00000000 Binary files a/psy_simple/widgets/icons/cmaps/PuBu_r.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/PuOr.png b/psy_simple/widgets/icons/cmaps/PuOr.png deleted file mode 100644 index af6f28d5..00000000 Binary files a/psy_simple/widgets/icons/cmaps/PuOr.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/PuOr_r.png b/psy_simple/widgets/icons/cmaps/PuOr_r.png deleted file mode 100644 index 1e80daad..00000000 Binary files a/psy_simple/widgets/icons/cmaps/PuOr_r.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/PuRd.png b/psy_simple/widgets/icons/cmaps/PuRd.png deleted file mode 100644 index e29f01d4..00000000 Binary files a/psy_simple/widgets/icons/cmaps/PuRd.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/PuRd_r.png b/psy_simple/widgets/icons/cmaps/PuRd_r.png deleted file mode 100644 index 0232e56c..00000000 Binary files a/psy_simple/widgets/icons/cmaps/PuRd_r.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/Purples.png b/psy_simple/widgets/icons/cmaps/Purples.png deleted file mode 100644 index 5fa19e9c..00000000 Binary files a/psy_simple/widgets/icons/cmaps/Purples.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/Purples_r.png b/psy_simple/widgets/icons/cmaps/Purples_r.png deleted file mode 100644 index 28801c5d..00000000 Binary files a/psy_simple/widgets/icons/cmaps/Purples_r.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/RdBu.png b/psy_simple/widgets/icons/cmaps/RdBu.png deleted file mode 100644 index f0440a37..00000000 Binary files a/psy_simple/widgets/icons/cmaps/RdBu.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/RdBu_r.png b/psy_simple/widgets/icons/cmaps/RdBu_r.png deleted file mode 100644 index 1006ed51..00000000 Binary files a/psy_simple/widgets/icons/cmaps/RdBu_r.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/RdGy.png b/psy_simple/widgets/icons/cmaps/RdGy.png deleted file mode 100644 index 3976325e..00000000 Binary files a/psy_simple/widgets/icons/cmaps/RdGy.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/RdGy_r.png b/psy_simple/widgets/icons/cmaps/RdGy_r.png deleted file mode 100644 index 9d1378ab..00000000 Binary files a/psy_simple/widgets/icons/cmaps/RdGy_r.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/RdPu.png b/psy_simple/widgets/icons/cmaps/RdPu.png deleted file mode 100644 index df6f259f..00000000 Binary files a/psy_simple/widgets/icons/cmaps/RdPu.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/RdPu_r.png b/psy_simple/widgets/icons/cmaps/RdPu_r.png deleted file mode 100644 index 64d801c9..00000000 Binary files a/psy_simple/widgets/icons/cmaps/RdPu_r.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/RdYlBu.png b/psy_simple/widgets/icons/cmaps/RdYlBu.png deleted file mode 100644 index f6a2a52e..00000000 Binary files a/psy_simple/widgets/icons/cmaps/RdYlBu.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/RdYlBu_r.png b/psy_simple/widgets/icons/cmaps/RdYlBu_r.png deleted file mode 100644 index 08a65c5e..00000000 Binary files a/psy_simple/widgets/icons/cmaps/RdYlBu_r.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/RdYlGn.png b/psy_simple/widgets/icons/cmaps/RdYlGn.png deleted file mode 100644 index cb6d699f..00000000 Binary files a/psy_simple/widgets/icons/cmaps/RdYlGn.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/RdYlGn_r.png b/psy_simple/widgets/icons/cmaps/RdYlGn_r.png deleted file mode 100644 index c618e0cd..00000000 Binary files a/psy_simple/widgets/icons/cmaps/RdYlGn_r.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/Reds.png b/psy_simple/widgets/icons/cmaps/Reds.png deleted file mode 100644 index 43122e0b..00000000 Binary files a/psy_simple/widgets/icons/cmaps/Reds.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/Reds_r.png b/psy_simple/widgets/icons/cmaps/Reds_r.png deleted file mode 100644 index 5416f57d..00000000 Binary files a/psy_simple/widgets/icons/cmaps/Reds_r.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/Set1.png b/psy_simple/widgets/icons/cmaps/Set1.png deleted file mode 100644 index 67c1a723..00000000 Binary files a/psy_simple/widgets/icons/cmaps/Set1.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/Set1_r.png b/psy_simple/widgets/icons/cmaps/Set1_r.png deleted file mode 100644 index 7bbc7c56..00000000 Binary files a/psy_simple/widgets/icons/cmaps/Set1_r.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/Set2.png b/psy_simple/widgets/icons/cmaps/Set2.png deleted file mode 100644 index ff9eebad..00000000 Binary files a/psy_simple/widgets/icons/cmaps/Set2.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/Set2_r.png b/psy_simple/widgets/icons/cmaps/Set2_r.png deleted file mode 100644 index 8839849f..00000000 Binary files a/psy_simple/widgets/icons/cmaps/Set2_r.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/Set3.png b/psy_simple/widgets/icons/cmaps/Set3.png deleted file mode 100644 index 604c5a1a..00000000 Binary files a/psy_simple/widgets/icons/cmaps/Set3.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/Set3_r.png b/psy_simple/widgets/icons/cmaps/Set3_r.png deleted file mode 100644 index e28a50d2..00000000 Binary files a/psy_simple/widgets/icons/cmaps/Set3_r.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/Spectral.png b/psy_simple/widgets/icons/cmaps/Spectral.png deleted file mode 100644 index 49dede85..00000000 Binary files a/psy_simple/widgets/icons/cmaps/Spectral.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/Spectral_r.png b/psy_simple/widgets/icons/cmaps/Spectral_r.png deleted file mode 100644 index bf3cd0ce..00000000 Binary files a/psy_simple/widgets/icons/cmaps/Spectral_r.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/Wistia.png b/psy_simple/widgets/icons/cmaps/Wistia.png deleted file mode 100644 index c54de851..00000000 Binary files a/psy_simple/widgets/icons/cmaps/Wistia.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/Wistia_r.png b/psy_simple/widgets/icons/cmaps/Wistia_r.png deleted file mode 100644 index ff92c1a1..00000000 Binary files a/psy_simple/widgets/icons/cmaps/Wistia_r.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/YlGn.png b/psy_simple/widgets/icons/cmaps/YlGn.png deleted file mode 100644 index da82617e..00000000 Binary files a/psy_simple/widgets/icons/cmaps/YlGn.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/YlGnBu.png b/psy_simple/widgets/icons/cmaps/YlGnBu.png deleted file mode 100644 index 7ca153e2..00000000 Binary files a/psy_simple/widgets/icons/cmaps/YlGnBu.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/YlGnBu_r.png b/psy_simple/widgets/icons/cmaps/YlGnBu_r.png deleted file mode 100644 index 88d226bc..00000000 Binary files a/psy_simple/widgets/icons/cmaps/YlGnBu_r.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/YlGn_r.png b/psy_simple/widgets/icons/cmaps/YlGn_r.png deleted file mode 100644 index bc213892..00000000 Binary files a/psy_simple/widgets/icons/cmaps/YlGn_r.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/YlOrBr.png b/psy_simple/widgets/icons/cmaps/YlOrBr.png deleted file mode 100644 index cbec203f..00000000 Binary files a/psy_simple/widgets/icons/cmaps/YlOrBr.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/YlOrBr_r.png b/psy_simple/widgets/icons/cmaps/YlOrBr_r.png deleted file mode 100644 index f153be97..00000000 Binary files a/psy_simple/widgets/icons/cmaps/YlOrBr_r.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/YlOrRd.png b/psy_simple/widgets/icons/cmaps/YlOrRd.png deleted file mode 100644 index 1642ff13..00000000 Binary files a/psy_simple/widgets/icons/cmaps/YlOrRd.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/YlOrRd_r.png b/psy_simple/widgets/icons/cmaps/YlOrRd_r.png deleted file mode 100644 index 8830b059..00000000 Binary files a/psy_simple/widgets/icons/cmaps/YlOrRd_r.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/afmhot.png b/psy_simple/widgets/icons/cmaps/afmhot.png deleted file mode 100644 index 5f87976f..00000000 Binary files a/psy_simple/widgets/icons/cmaps/afmhot.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/afmhot_r.png b/psy_simple/widgets/icons/cmaps/afmhot_r.png deleted file mode 100644 index 5d2bc4c1..00000000 Binary files a/psy_simple/widgets/icons/cmaps/afmhot_r.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/autumn.png b/psy_simple/widgets/icons/cmaps/autumn.png deleted file mode 100644 index 0cba9e0f..00000000 Binary files a/psy_simple/widgets/icons/cmaps/autumn.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/autumn_r.png b/psy_simple/widgets/icons/cmaps/autumn_r.png deleted file mode 100644 index f1cfadd3..00000000 Binary files a/psy_simple/widgets/icons/cmaps/autumn_r.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/binary.png b/psy_simple/widgets/icons/cmaps/binary.png deleted file mode 100644 index 16407008..00000000 Binary files a/psy_simple/widgets/icons/cmaps/binary.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/binary_r.png b/psy_simple/widgets/icons/cmaps/binary_r.png deleted file mode 100644 index 43f96856..00000000 Binary files a/psy_simple/widgets/icons/cmaps/binary_r.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/blue_white_red.png b/psy_simple/widgets/icons/cmaps/blue_white_red.png deleted file mode 100644 index 03b54cbf..00000000 Binary files a/psy_simple/widgets/icons/cmaps/blue_white_red.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/blue_white_red_r.png b/psy_simple/widgets/icons/cmaps/blue_white_red_r.png deleted file mode 100644 index 1de791e5..00000000 Binary files a/psy_simple/widgets/icons/cmaps/blue_white_red_r.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/bone.png b/psy_simple/widgets/icons/cmaps/bone.png deleted file mode 100644 index 92a2adef..00000000 Binary files a/psy_simple/widgets/icons/cmaps/bone.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/bone_r.png b/psy_simple/widgets/icons/cmaps/bone_r.png deleted file mode 100644 index 53d458d1..00000000 Binary files a/psy_simple/widgets/icons/cmaps/bone_r.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/brg.png b/psy_simple/widgets/icons/cmaps/brg.png deleted file mode 100644 index 55c7fecb..00000000 Binary files a/psy_simple/widgets/icons/cmaps/brg.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/brg_r.png b/psy_simple/widgets/icons/cmaps/brg_r.png deleted file mode 100644 index 86941929..00000000 Binary files a/psy_simple/widgets/icons/cmaps/brg_r.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/bwr.png b/psy_simple/widgets/icons/cmaps/bwr.png deleted file mode 100644 index 4b9b4ff1..00000000 Binary files a/psy_simple/widgets/icons/cmaps/bwr.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/bwr_r.png b/psy_simple/widgets/icons/cmaps/bwr_r.png deleted file mode 100644 index 9fa791d1..00000000 Binary files a/psy_simple/widgets/icons/cmaps/bwr_r.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/cividis.png b/psy_simple/widgets/icons/cmaps/cividis.png deleted file mode 100644 index f63fe23c..00000000 Binary files a/psy_simple/widgets/icons/cmaps/cividis.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/cividis_r.png b/psy_simple/widgets/icons/cmaps/cividis_r.png deleted file mode 100644 index b9e46932..00000000 Binary files a/psy_simple/widgets/icons/cmaps/cividis_r.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/cool.png b/psy_simple/widgets/icons/cmaps/cool.png deleted file mode 100644 index 6b5879a9..00000000 Binary files a/psy_simple/widgets/icons/cmaps/cool.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/cool_r.png b/psy_simple/widgets/icons/cmaps/cool_r.png deleted file mode 100644 index e45c6e4f..00000000 Binary files a/psy_simple/widgets/icons/cmaps/cool_r.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/coolwarm.png b/psy_simple/widgets/icons/cmaps/coolwarm.png deleted file mode 100644 index 1b7c710a..00000000 Binary files a/psy_simple/widgets/icons/cmaps/coolwarm.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/coolwarm_r.png b/psy_simple/widgets/icons/cmaps/coolwarm_r.png deleted file mode 100644 index 903b8d67..00000000 Binary files a/psy_simple/widgets/icons/cmaps/coolwarm_r.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/copper.png b/psy_simple/widgets/icons/cmaps/copper.png deleted file mode 100644 index dab4d650..00000000 Binary files a/psy_simple/widgets/icons/cmaps/copper.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/copper_r.png b/psy_simple/widgets/icons/cmaps/copper_r.png deleted file mode 100644 index 7a8972b6..00000000 Binary files a/psy_simple/widgets/icons/cmaps/copper_r.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/cubehelix.png b/psy_simple/widgets/icons/cmaps/cubehelix.png deleted file mode 100644 index d0102d7d..00000000 Binary files a/psy_simple/widgets/icons/cmaps/cubehelix.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/cubehelix_r.png b/psy_simple/widgets/icons/cmaps/cubehelix_r.png deleted file mode 100644 index 9139aa74..00000000 Binary files a/psy_simple/widgets/icons/cmaps/cubehelix_r.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/flag.png b/psy_simple/widgets/icons/cmaps/flag.png deleted file mode 100644 index aa339f88..00000000 Binary files a/psy_simple/widgets/icons/cmaps/flag.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/flag_r.png b/psy_simple/widgets/icons/cmaps/flag_r.png deleted file mode 100644 index 9b76a37a..00000000 Binary files a/psy_simple/widgets/icons/cmaps/flag_r.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/gist_earth.png b/psy_simple/widgets/icons/cmaps/gist_earth.png deleted file mode 100644 index fd0a18a2..00000000 Binary files a/psy_simple/widgets/icons/cmaps/gist_earth.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/gist_earth_r.png b/psy_simple/widgets/icons/cmaps/gist_earth_r.png deleted file mode 100644 index 90ca5099..00000000 Binary files a/psy_simple/widgets/icons/cmaps/gist_earth_r.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/gist_gray.png b/psy_simple/widgets/icons/cmaps/gist_gray.png deleted file mode 100644 index 43f96856..00000000 Binary files a/psy_simple/widgets/icons/cmaps/gist_gray.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/gist_gray_r.png b/psy_simple/widgets/icons/cmaps/gist_gray_r.png deleted file mode 100644 index 16407008..00000000 Binary files a/psy_simple/widgets/icons/cmaps/gist_gray_r.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/gist_heat.png b/psy_simple/widgets/icons/cmaps/gist_heat.png deleted file mode 100644 index f740e567..00000000 Binary files a/psy_simple/widgets/icons/cmaps/gist_heat.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/gist_heat_r.png b/psy_simple/widgets/icons/cmaps/gist_heat_r.png deleted file mode 100644 index 3b3f1ee2..00000000 Binary files a/psy_simple/widgets/icons/cmaps/gist_heat_r.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/gist_ncar.png b/psy_simple/widgets/icons/cmaps/gist_ncar.png deleted file mode 100644 index 80fada97..00000000 Binary files a/psy_simple/widgets/icons/cmaps/gist_ncar.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/gist_ncar_r.png b/psy_simple/widgets/icons/cmaps/gist_ncar_r.png deleted file mode 100644 index 1016f0b5..00000000 Binary files a/psy_simple/widgets/icons/cmaps/gist_ncar_r.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/gist_rainbow.png b/psy_simple/widgets/icons/cmaps/gist_rainbow.png deleted file mode 100644 index 8633ab86..00000000 Binary files a/psy_simple/widgets/icons/cmaps/gist_rainbow.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/gist_rainbow_r.png b/psy_simple/widgets/icons/cmaps/gist_rainbow_r.png deleted file mode 100644 index 0e51440b..00000000 Binary files a/psy_simple/widgets/icons/cmaps/gist_rainbow_r.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/gist_stern.png b/psy_simple/widgets/icons/cmaps/gist_stern.png deleted file mode 100644 index f4ec86db..00000000 Binary files a/psy_simple/widgets/icons/cmaps/gist_stern.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/gist_stern_r.png b/psy_simple/widgets/icons/cmaps/gist_stern_r.png deleted file mode 100644 index b2628e12..00000000 Binary files a/psy_simple/widgets/icons/cmaps/gist_stern_r.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/gist_yarg.png b/psy_simple/widgets/icons/cmaps/gist_yarg.png deleted file mode 100644 index 16407008..00000000 Binary files a/psy_simple/widgets/icons/cmaps/gist_yarg.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/gist_yarg_r.png b/psy_simple/widgets/icons/cmaps/gist_yarg_r.png deleted file mode 100644 index 43f96856..00000000 Binary files a/psy_simple/widgets/icons/cmaps/gist_yarg_r.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/gnuplot.png b/psy_simple/widgets/icons/cmaps/gnuplot.png deleted file mode 100644 index 8529c3cc..00000000 Binary files a/psy_simple/widgets/icons/cmaps/gnuplot.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/gnuplot2.png b/psy_simple/widgets/icons/cmaps/gnuplot2.png deleted file mode 100644 index 682dd631..00000000 Binary files a/psy_simple/widgets/icons/cmaps/gnuplot2.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/gnuplot2_r.png b/psy_simple/widgets/icons/cmaps/gnuplot2_r.png deleted file mode 100644 index 6897d82a..00000000 Binary files a/psy_simple/widgets/icons/cmaps/gnuplot2_r.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/gnuplot_r.png b/psy_simple/widgets/icons/cmaps/gnuplot_r.png deleted file mode 100644 index 06d9bf3f..00000000 Binary files a/psy_simple/widgets/icons/cmaps/gnuplot_r.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/gray.png b/psy_simple/widgets/icons/cmaps/gray.png deleted file mode 100644 index 43f96856..00000000 Binary files a/psy_simple/widgets/icons/cmaps/gray.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/gray_r.png b/psy_simple/widgets/icons/cmaps/gray_r.png deleted file mode 100644 index 16407008..00000000 Binary files a/psy_simple/widgets/icons/cmaps/gray_r.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/hot.png b/psy_simple/widgets/icons/cmaps/hot.png deleted file mode 100644 index 9de19654..00000000 Binary files a/psy_simple/widgets/icons/cmaps/hot.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/hot_r.png b/psy_simple/widgets/icons/cmaps/hot_r.png deleted file mode 100644 index 81a7c782..00000000 Binary files a/psy_simple/widgets/icons/cmaps/hot_r.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/hsv.png b/psy_simple/widgets/icons/cmaps/hsv.png deleted file mode 100644 index c6867fa6..00000000 Binary files a/psy_simple/widgets/icons/cmaps/hsv.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/hsv_r.png b/psy_simple/widgets/icons/cmaps/hsv_r.png deleted file mode 100644 index 90948ca2..00000000 Binary files a/psy_simple/widgets/icons/cmaps/hsv_r.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/inferno.png b/psy_simple/widgets/icons/cmaps/inferno.png deleted file mode 100644 index 3b6b40ce..00000000 Binary files a/psy_simple/widgets/icons/cmaps/inferno.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/inferno_r.png b/psy_simple/widgets/icons/cmaps/inferno_r.png deleted file mode 100644 index 5217e263..00000000 Binary files a/psy_simple/widgets/icons/cmaps/inferno_r.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/jet.png b/psy_simple/widgets/icons/cmaps/jet.png deleted file mode 100644 index d4a3ee2f..00000000 Binary files a/psy_simple/widgets/icons/cmaps/jet.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/jet_r.png b/psy_simple/widgets/icons/cmaps/jet_r.png deleted file mode 100644 index 3bfdb17f..00000000 Binary files a/psy_simple/widgets/icons/cmaps/jet_r.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/magma.png b/psy_simple/widgets/icons/cmaps/magma.png deleted file mode 100644 index ffaf5538..00000000 Binary files a/psy_simple/widgets/icons/cmaps/magma.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/magma_r.png b/psy_simple/widgets/icons/cmaps/magma_r.png deleted file mode 100644 index 369b219e..00000000 Binary files a/psy_simple/widgets/icons/cmaps/magma_r.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/nipy_spectral.png b/psy_simple/widgets/icons/cmaps/nipy_spectral.png deleted file mode 100644 index fe267699..00000000 Binary files a/psy_simple/widgets/icons/cmaps/nipy_spectral.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/nipy_spectral_r.png b/psy_simple/widgets/icons/cmaps/nipy_spectral_r.png deleted file mode 100644 index 2a1a0cf8..00000000 Binary files a/psy_simple/widgets/icons/cmaps/nipy_spectral_r.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/ocean.png b/psy_simple/widgets/icons/cmaps/ocean.png deleted file mode 100644 index 69d76a92..00000000 Binary files a/psy_simple/widgets/icons/cmaps/ocean.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/ocean_r.png b/psy_simple/widgets/icons/cmaps/ocean_r.png deleted file mode 100644 index c78672b7..00000000 Binary files a/psy_simple/widgets/icons/cmaps/ocean_r.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/pink.png b/psy_simple/widgets/icons/cmaps/pink.png deleted file mode 100644 index 3cfb3207..00000000 Binary files a/psy_simple/widgets/icons/cmaps/pink.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/pink_r.png b/psy_simple/widgets/icons/cmaps/pink_r.png deleted file mode 100644 index 9b55ae62..00000000 Binary files a/psy_simple/widgets/icons/cmaps/pink_r.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/plasma.png b/psy_simple/widgets/icons/cmaps/plasma.png deleted file mode 100644 index f48967a1..00000000 Binary files a/psy_simple/widgets/icons/cmaps/plasma.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/plasma_r.png b/psy_simple/widgets/icons/cmaps/plasma_r.png deleted file mode 100644 index 023255a7..00000000 Binary files a/psy_simple/widgets/icons/cmaps/plasma_r.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/prism.png b/psy_simple/widgets/icons/cmaps/prism.png deleted file mode 100644 index a25b801f..00000000 Binary files a/psy_simple/widgets/icons/cmaps/prism.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/prism_r.png b/psy_simple/widgets/icons/cmaps/prism_r.png deleted file mode 100644 index d5745276..00000000 Binary files a/psy_simple/widgets/icons/cmaps/prism_r.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/rainbow.png b/psy_simple/widgets/icons/cmaps/rainbow.png deleted file mode 100644 index 3289cd0c..00000000 Binary files a/psy_simple/widgets/icons/cmaps/rainbow.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/rainbow_r.png b/psy_simple/widgets/icons/cmaps/rainbow_r.png deleted file mode 100644 index d5e21a6c..00000000 Binary files a/psy_simple/widgets/icons/cmaps/rainbow_r.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/red_white_blue.png b/psy_simple/widgets/icons/cmaps/red_white_blue.png deleted file mode 100644 index 1de791e5..00000000 Binary files a/psy_simple/widgets/icons/cmaps/red_white_blue.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/red_white_blue_r.png b/psy_simple/widgets/icons/cmaps/red_white_blue_r.png deleted file mode 100644 index 03b54cbf..00000000 Binary files a/psy_simple/widgets/icons/cmaps/red_white_blue_r.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/rwb.png b/psy_simple/widgets/icons/cmaps/rwb.png deleted file mode 100644 index ce016a1b..00000000 Binary files a/psy_simple/widgets/icons/cmaps/rwb.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/rwb_r.png b/psy_simple/widgets/icons/cmaps/rwb_r.png deleted file mode 100644 index 6962628d..00000000 Binary files a/psy_simple/widgets/icons/cmaps/rwb_r.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/seismic.png b/psy_simple/widgets/icons/cmaps/seismic.png deleted file mode 100644 index 2a694008..00000000 Binary files a/psy_simple/widgets/icons/cmaps/seismic.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/seismic_r.png b/psy_simple/widgets/icons/cmaps/seismic_r.png deleted file mode 100644 index 71953d4a..00000000 Binary files a/psy_simple/widgets/icons/cmaps/seismic_r.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/spring.png b/psy_simple/widgets/icons/cmaps/spring.png deleted file mode 100644 index 33fac3cc..00000000 Binary files a/psy_simple/widgets/icons/cmaps/spring.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/spring_r.png b/psy_simple/widgets/icons/cmaps/spring_r.png deleted file mode 100644 index 674cf182..00000000 Binary files a/psy_simple/widgets/icons/cmaps/spring_r.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/summer.png b/psy_simple/widgets/icons/cmaps/summer.png deleted file mode 100644 index 0f37ed75..00000000 Binary files a/psy_simple/widgets/icons/cmaps/summer.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/summer_r.png b/psy_simple/widgets/icons/cmaps/summer_r.png deleted file mode 100644 index f3ac4713..00000000 Binary files a/psy_simple/widgets/icons/cmaps/summer_r.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/tab10.png b/psy_simple/widgets/icons/cmaps/tab10.png deleted file mode 100644 index 642b55b8..00000000 Binary files a/psy_simple/widgets/icons/cmaps/tab10.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/tab10_r.png b/psy_simple/widgets/icons/cmaps/tab10_r.png deleted file mode 100644 index ae00e6ba..00000000 Binary files a/psy_simple/widgets/icons/cmaps/tab10_r.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/tab20.png b/psy_simple/widgets/icons/cmaps/tab20.png deleted file mode 100644 index 28c03c8c..00000000 Binary files a/psy_simple/widgets/icons/cmaps/tab20.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/tab20_r.png b/psy_simple/widgets/icons/cmaps/tab20_r.png deleted file mode 100644 index a5ff2992..00000000 Binary files a/psy_simple/widgets/icons/cmaps/tab20_r.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/tab20b.png b/psy_simple/widgets/icons/cmaps/tab20b.png deleted file mode 100644 index 0e981390..00000000 Binary files a/psy_simple/widgets/icons/cmaps/tab20b.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/tab20b_r.png b/psy_simple/widgets/icons/cmaps/tab20b_r.png deleted file mode 100644 index 1a52c547..00000000 Binary files a/psy_simple/widgets/icons/cmaps/tab20b_r.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/tab20c.png b/psy_simple/widgets/icons/cmaps/tab20c.png deleted file mode 100644 index bff5b8be..00000000 Binary files a/psy_simple/widgets/icons/cmaps/tab20c.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/tab20c_r.png b/psy_simple/widgets/icons/cmaps/tab20c_r.png deleted file mode 100644 index dcdeb709..00000000 Binary files a/psy_simple/widgets/icons/cmaps/tab20c_r.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/terrain.png b/psy_simple/widgets/icons/cmaps/terrain.png deleted file mode 100644 index 9a68f395..00000000 Binary files a/psy_simple/widgets/icons/cmaps/terrain.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/terrain_r.png b/psy_simple/widgets/icons/cmaps/terrain_r.png deleted file mode 100644 index 6a1e4ca6..00000000 Binary files a/psy_simple/widgets/icons/cmaps/terrain_r.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/twilight.png b/psy_simple/widgets/icons/cmaps/twilight.png deleted file mode 100644 index 803daf9e..00000000 Binary files a/psy_simple/widgets/icons/cmaps/twilight.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/twilight_r.png b/psy_simple/widgets/icons/cmaps/twilight_r.png deleted file mode 100644 index 1b4911b2..00000000 Binary files a/psy_simple/widgets/icons/cmaps/twilight_r.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/twilight_shifted.png b/psy_simple/widgets/icons/cmaps/twilight_shifted.png deleted file mode 100644 index ad2f7297..00000000 Binary files a/psy_simple/widgets/icons/cmaps/twilight_shifted.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/twilight_shifted_r.png b/psy_simple/widgets/icons/cmaps/twilight_shifted_r.png deleted file mode 100644 index d3b11377..00000000 Binary files a/psy_simple/widgets/icons/cmaps/twilight_shifted_r.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/viridis.png b/psy_simple/widgets/icons/cmaps/viridis.png deleted file mode 100644 index 68b03fb9..00000000 Binary files a/psy_simple/widgets/icons/cmaps/viridis.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/viridis_r.png b/psy_simple/widgets/icons/cmaps/viridis_r.png deleted file mode 100644 index 246f6f9d..00000000 Binary files a/psy_simple/widgets/icons/cmaps/viridis_r.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/w_Blues.png b/psy_simple/widgets/icons/cmaps/w_Blues.png deleted file mode 100644 index c6b01954..00000000 Binary files a/psy_simple/widgets/icons/cmaps/w_Blues.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/w_Greens.png b/psy_simple/widgets/icons/cmaps/w_Greens.png deleted file mode 100644 index 3b818b35..00000000 Binary files a/psy_simple/widgets/icons/cmaps/w_Greens.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/w_RdBu.png b/psy_simple/widgets/icons/cmaps/w_RdBu.png deleted file mode 100644 index 3a6ee898..00000000 Binary files a/psy_simple/widgets/icons/cmaps/w_RdBu.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/w_RdBu_r.png b/psy_simple/widgets/icons/cmaps/w_RdBu_r.png deleted file mode 100644 index 4cd01f61..00000000 Binary files a/psy_simple/widgets/icons/cmaps/w_RdBu_r.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/w_Reds.png b/psy_simple/widgets/icons/cmaps/w_Reds.png deleted file mode 100644 index 2d3a2c7d..00000000 Binary files a/psy_simple/widgets/icons/cmaps/w_Reds.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/wbr.png b/psy_simple/widgets/icons/cmaps/wbr.png deleted file mode 100644 index 14cb8857..00000000 Binary files a/psy_simple/widgets/icons/cmaps/wbr.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/wbr_r.png b/psy_simple/widgets/icons/cmaps/wbr_r.png deleted file mode 100644 index 6ed1d3e1..00000000 Binary files a/psy_simple/widgets/icons/cmaps/wbr_r.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/white_blue_red.png b/psy_simple/widgets/icons/cmaps/white_blue_red.png deleted file mode 100644 index fb779fce..00000000 Binary files a/psy_simple/widgets/icons/cmaps/white_blue_red.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/white_blue_red_r.png b/psy_simple/widgets/icons/cmaps/white_blue_red_r.png deleted file mode 100644 index 43ac2ee8..00000000 Binary files a/psy_simple/widgets/icons/cmaps/white_blue_red_r.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/white_red_blue.png b/psy_simple/widgets/icons/cmaps/white_red_blue.png deleted file mode 100644 index 2d4d7600..00000000 Binary files a/psy_simple/widgets/icons/cmaps/white_red_blue.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/white_red_blue_r.png b/psy_simple/widgets/icons/cmaps/white_red_blue_r.png deleted file mode 100644 index 41b9a4cf..00000000 Binary files a/psy_simple/widgets/icons/cmaps/white_red_blue_r.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/winter.png b/psy_simple/widgets/icons/cmaps/winter.png deleted file mode 100644 index 8da07ea5..00000000 Binary files a/psy_simple/widgets/icons/cmaps/winter.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/winter_r.png b/psy_simple/widgets/icons/cmaps/winter_r.png deleted file mode 100644 index fe1b61eb..00000000 Binary files a/psy_simple/widgets/icons/cmaps/winter_r.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/wrb.png b/psy_simple/widgets/icons/cmaps/wrb.png deleted file mode 100644 index 63049da1..00000000 Binary files a/psy_simple/widgets/icons/cmaps/wrb.png and /dev/null differ diff --git a/psy_simple/widgets/icons/cmaps/wrb_r.png b/psy_simple/widgets/icons/cmaps/wrb_r.png deleted file mode 100644 index 01b0b1f5..00000000 Binary files a/psy_simple/widgets/icons/cmaps/wrb_r.png and /dev/null differ diff --git a/psy_simple/widgets/icons/font_color.png b/psy_simple/widgets/icons/font_color.png deleted file mode 100644 index e413cda4..00000000 Binary files a/psy_simple/widgets/icons/font_color.png and /dev/null differ diff --git a/psy_simple/widgets/icons/italic.png b/psy_simple/widgets/icons/italic.png deleted file mode 100644 index 9ffe9ee6..00000000 Binary files a/psy_simple/widgets/icons/italic.png and /dev/null differ diff --git a/psy_simple/widgets/texts.py b/psy_simple/widgets/texts.py deleted file mode 100644 index 2dabce33..00000000 --- a/psy_simple/widgets/texts.py +++ /dev/null @@ -1,475 +0,0 @@ -# -*- coding: utf-8 -*- -"""Psyplot GUI widgets for modifying label formatoptions - -This module contains PyQt widgets that can be used to modify label -formatoptions (e.g. title, xlabel, titleprops, etc.) in the psyplot GUI. -""" - -# Disclaimer -# ---------- -# -# Copyright (C) 2021 Helmholtz-Zentrum Hereon -# Copyright (C) 2020-2021 Helmholtz-Zentrum Geesthacht -# Copyright (C) 2016-2021 University of Lausanne -# -# This file is part of psy-simple and is released under the GNU LGPL-3.O license. -# See COPYING and COPYING.LESSER in the root of the repository for full -# licensing details. -# -# This program is free software: you can redistribute it and/or modify -# it under the terms of the GNU Lesser General Public License version 3.0 as -# published by the Free Software Foundation. -# -# 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 LGPL-3.0 license for more details. -# -# You should have received a copy of the GNU LGPL-3.0 license -# along with this program. If not, see . - -from psyplot_gui.compat.qtcompat import ( - QWidget, QComboBox, QHBoxLayout, QPushButton, QLabel, QtGui, with_qt5, - QToolButton, QIcon, Qt) -from psy_simple.widgets import get_icon, Switch2FmtButton -from warnings import warn -import matplotlib as mpl -import matplotlib.colors as mcol -from psyplot.compat.pycompat import OrderedDict -from psyplot.docstring import docstrings -from psyplot import utils -from functools import partial - - -if with_qt5: - from PyQt5.QtWidgets import QSpinBox, QFontDialog, QColorDialog -else: - from PyQt4.QtGui import QSpinBox, QFontDialog, QColorDialog - - -if with_qt5: - weights_mpl2qt = OrderedDict([ - ('ultralight', QtGui.QFont.ExtraLight), - ('light', QtGui.QFont.Light), - ('normal', QtGui.QFont.Normal), - ('regular', QtGui.QFont.Normal), - ('book', QtGui.QFont.Normal), - ('medium', QtGui.QFont.Medium), - ('roman', QtGui.QFont.Medium), - ('semibold', QtGui.QFont.DemiBold), - ('demibold', QtGui.QFont.DemiBold), - ('demi', QtGui.QFont.DemiBold), - ('bold', QtGui.QFont.Bold), - ('heavy', QtGui.QFont.Bold), - ('extra bold', QtGui.QFont.ExtraBold), - ('black', QtGui.QFont.Black), - ]) -else: - weights_mpl2qt = OrderedDict([ - ('ultralight', QtGui.QFont.Light), - ('light', QtGui.QFont.Light), - ('normal', QtGui.QFont.Normal), - ('regular', QtGui.QFont.Normal), - ('book', QtGui.QFont.Normal), - ('medium', QtGui.QFont.Normal), - ('roman', QtGui.QFont.Normal), - ('semibold', QtGui.QFont.DemiBold), - ('demibold', QtGui.QFont.DemiBold), - ('demi', QtGui.QFont.DemiBold), - ('bold', QtGui.QFont.Bold), - ('heavy', QtGui.QFont.Bold), - ('extra bold', QtGui.QFont.Black), - ('black', QtGui.QFont.Black), - ]) - - -weights_qt2mpl = OrderedDict( - map(reversed, utils.unique_everseen(weights_mpl2qt.items(), - key=lambda t: t[1]))) - - -def mpl_weight2qt(weight): - """Convert a weight from matplotlib definition to a Qt weight - - Parameters - ---------- - weight: int or string - Either an integer between 1 and 1000 or a string out of - :attr:`weights_mpl2qt` - - Returns - ------- - int - One type of the PyQt5.QtGui.QFont.Weight""" - try: - weight = weights_mpl2qt[weight] - except KeyError: - try: - weight = float(weight) / 10 - except (ValueError, TypeError): - weight = QtGui.QFont.Normal - else: - try: - weight = min(filter(lambda w: w >= weight, weights_qt2mpl), - key=lambda w: abs(w - weight)) - except ValueError: - weight = QtGui.QFont.Normal - return weight - - -class DictCombo(QComboBox): - """A combobox that inserts keys into the formatoption""" - - def __init__(self, attrs, fmt_widget, modulo_style=True): - QComboBox.__init__(self) - self.fmt_widget = fmt_widget - self.addItems( - [''] + - [(key + ': ' + str(val))[:40] for key, val in attrs.items()]) - func = self.insert_modulo if modulo_style else self.insert_bracketed - self.currentTextChanged.connect(func) - - def insert_modulo(self, s): - self.fmt_widget.insert_obj( - ('%(' + s.split(':')[0] + ')s') if s else '') - - def insert_bracketed(self, s): - self.fmt_widget.insert_obj( - ('{' + s.split(':')[0] + '}') if s else '') - - -class LabelWidget(QWidget): - """A widget to modify a text label (title, xlabel, etc.) - - This widget contains one combobox for the ``'labels'`` key in the - :attr:`psyplot.rcParams` dictionary, and a second combobox for the - enhanced attributes of the corresponding formatoption object `fmto`. - - Additionally, it provides buttons to switch to the formatoption options - of the corresponding fontsize, fontweight and fontproperties of this - label""" - - @docstrings.get_sections(base='LabelWidget') - def __init__(self, parent, fmto, project, properties=True): - """ - Parameters - ---------- - parent: psyplot_gui.fmt_widget.FormatoptionWidget - The formatoption widget where this widget is inserted - fmto: psyplot.plotter.Formatoption - The formatoption that is represented by this widget - project: psyplot.project.Project - The current psyplot subproject""" - QWidget.__init__(self, parent) - hbox = QHBoxLayout() - - # Create a combo box for the rcParams 'labels' key - label_combo = DictCombo(fmto.rc['labels'], parent, modulo_style=False) - hbox.addWidget(label_combo) - - # Create a combo for the :attr:`enhanced_attrs` - attrs = OrderedDict(sorted(utils.join_dicts( - [getattr(plotter, fmto.key).enhanced_attrs - for plotter in project.plotters], - delimiter=', ').items())) - attr_combo = DictCombo(attrs, parent) - hbox.addWidget(attr_combo) - - fmtos = [ - # add a button to change to the properties formatoption - getattr(fmto.plotter, fmto.key + 'props', None), - getattr(fmto.plotter, fmto.key + 'size', None), - getattr(fmto.plotter, fmto.key + 'weight', None) - ] - fmtos = list(filter(None, fmtos)) - if fmtos and properties: - hbox.addWidget(Switch2FmtButton(parent, *fmtos)) - - self.setLayout(hbox) - - -docstrings.keep_params('LabelWidget.parameters', 'parent', 'fmto') - - -class FontWeightWidget(QWidget): - """A widget for modifying the fontweight of a label""" - - @docstrings.get_sections(base='FontWeightWidget') - @docstrings.with_indent(8) - def __init__(self, parent, fmto, artist=None, base=None): - """ - Parameters - ---------- - %(LabelWidget.parameters.parent|fmto)s - artist: matplotlib.text.Text - The text instance this formatoption is modifying - base: psyplot.plotter.Formatoption - The original formatoption of the label the given `fmto` belongs to - """ - QWidget.__init__(self, parent) - hbox = QHBoxLayout() - hbox.addWidget(QLabel('Font weights:')) - if artist is None: - weight = 'normal' - else: - weight = artist.get_weight() - - self.spin_box = spin_box = QSpinBox(self) - spin_box.setRange(1, 1000) - try: - weight = int(weight) - except ValueError: - spin_box.setValue(mpl_weight2qt(weight) * 10) - else: - spin_box.setValue(weight) - spin_box.valueChanged.connect(parent.set_obj) - hbox.addWidget(spin_box) - - combo = QComboBox() - combo.addItems(list(weights_mpl2qt)) - if weight in weights_mpl2qt: - combo.setCurrentText(weight) - else: - combo.setCurrentText(weights_qt2mpl[mpl_weight2qt(weight)]) - combo.currentTextChanged.connect(parent.set_obj) - hbox.addWidget(combo) - - # add a button to change to the properties formatoption - if base is not None: - fmtos = [ - base, - getattr(fmto.plotter, base.key + 'props', None), - getattr(fmto.plotter, base.key + 'size', None), - ] - fmtos = list(filter(None, fmtos)) - hbox.addWidget(Switch2FmtButton(parent, *fmtos)) - - self.setLayout(hbox) - - -class FontSizeWidget(QWidget): - """A widget for modifying the fontsize of a label""" - - @docstrings.with_indent(8) - def __init__(self, parent, fmto, artist=None, base=None): - """ - Parameters - ---------- - %(FontWeightWidget.parameters)s - """ - QWidget.__init__(self, parent) - hbox = QHBoxLayout() - hbox.addWidget(QLabel('Font sizes:')) - - self.spin_box = spin_box = QSpinBox(self) - spin_box.setRange(1, int(1e9)) - if artist is not None: - spin_box.setValue(int(artist.get_size())) - - spin_box.valueChanged.connect(parent.set_obj) - hbox.addWidget(spin_box) - - combo = QComboBox() - combo.addItems(['xx-small', 'x-small', 'small', 'medium', 'large', - 'x-large', 'xx-large']) - combo.currentTextChanged.connect(parent.set_obj) - hbox.addWidget(combo) - - # add a button to change to the properties formatoption - if base is not None: - fmtos = [ - base, - getattr(fmto.plotter, base.key + 'props', None), - getattr(fmto.plotter, base.key + 'weight', None), - ] - fmtos = list(filter(None, fmtos)) - hbox.addWidget(Switch2FmtButton(parent, *fmtos)) - - self.setLayout(hbox) - - -class FontPropertiesWidget(QWidget): - """A widget for modifying the font properties or a label""" - - #: The current QFont of the artist - current_font = None - - @docstrings.with_indent(8) - def __init__(self, parent, fmto, artist=None, base=None): - """ - Parameters - ---------- - %(FontWeightWidget.parameters)s - """ - QWidget.__init__(self, parent) - hbox = QHBoxLayout() - if artist is not None: - self.current_font = self.artist_to_qfont(artist) - self.current_color = QtGui.QColor.fromRgbF( - *mcol.to_rgba(artist.get_color())) - else: - self.current_color = QtGui.QColor(Qt.black) - self.fmto_name = fmto.name or fmto.key - - # choose font button - button = QPushButton('Choose font') - button.clicked.connect(partial(self.choose_font, None)) - hbox.addWidget(button) - - # font size spin box - self.spin_box = spin_box = QSpinBox(self) - spin_box.setRange(1, int(1e9)) - if artist is not None: - spin_box.setValue(int(artist.get_size())) - spin_box.valueChanged.connect(self.modify_size) - hbox.addWidget(spin_box) - - # font color button - self.btn_font_color = button = QToolButton(self) - button.setIcon(QIcon(get_icon('font_color'))) - button.clicked.connect(partial(self.choose_color, None)) - hbox.addWidget(button) - - # bold button - self.btn_bold = button = QToolButton(self) - button.setIcon(QIcon(get_icon('bold'))) - button.clicked.connect(self.toggle_bold) - button.setCheckable(True) - if artist is not None: - button.setChecked(self.current_font.weight() > 50) - hbox.addWidget(button) - - # italic button - self.btn_italic = button = QToolButton(self) - button.setIcon(QIcon(get_icon('italic'))) - button.clicked.connect(self.toggle_italic) - button.setCheckable(True) - if artist is not None: - button.setChecked(self.current_font.italic()) - hbox.addWidget(button) - - if base is not None: - # add a button to change to the base formatoption - fmtos = [ - base, - getattr(fmto.plotter, base.key + 'size', None), - getattr(fmto.plotter, base.key + 'weight', None), - ] - fmtos = list(filter(None, fmtos)) - hbox.addWidget(Switch2FmtButton(parent, *fmtos)) - - self.setLayout(hbox) - - @staticmethod - def artist_to_qfont(artist): - """Convert a :class:`matplotlib.text.Text` artist to a QFont object - - Parameters - ---------- - artist: matplotlib.text.Text - The text artist, e.g. an axes title - - Returns - ------- - PyQt5.QtGui.QFont - The QFont object""" - size = int(artist.get_size()) - weight = mpl_weight2qt(artist.get_weight()) - italic = artist.get_style() == 'italic' - for family in artist.get_family(): - if family in ['sans-serif', 'cursive', 'monospace', 'serif']: - for name in mpl.rcParams['font.' + family]: - font = QtGui.QFont(name, size, weight, italic) - if font.exactMatch(): - break - else: - font = QtGui.QFont(family, size, weight, italic) - return font - - @staticmethod - def qfont_to_artist_props(font): - properties = { - 'family': font.family(), - 'size': font.pointSize(), - 'weight': weights_qt2mpl[font.weight()], - 'style': 'italic' if font.italic() else 'normal'} - if font.underline(): - warn("Underline is ignored! Use LaTeX syntax: $\\underline{text}$!" - ) - if font.strikeOut(): - warn("StrikeOut is ignored! Use LaTeX syntax: $\\sout{text}$!") - return properties - - def modify_size(self, val): - properties = self.load_properties() - properties['fontsize' if 'fontsize' in properties else 'size'] = val - self.current_font.setPointSize(val) - self.parent().set_obj(properties) - - def toggle_bold(self): - properties = self.load_properties() - bold = self.btn_bold.isChecked() - properties['weight'] = 'bold' if bold else 'normal' - self.current_font.setBold(bold) - self.parent().set_obj(properties) - - def toggle_italic(self): - properties = self.load_properties() - italic = self.btn_italic.isChecked() - properties['style'] = 'italic' if italic else 'normal' - self.current_font.setItalic(italic) - self.parent().set_obj(properties) - - def load_properties(self): - return dict(self.parent().get_obj() or {}) - - def choose_font(self, font=None): - """Choose a font for the label through a dialog""" - fmt_widget = self.parent() - if font is None: - if self.current_font: - font, ok = QFontDialog.getFont( - self.current_font, fmt_widget, - 'Select %s font' % self.fmto_name, - QFontDialog.DontUseNativeDialog) - else: - font, ok = QFontDialog.getFont(fmt_widget) - if not ok: - return - self.current_font = font - properties = self.load_properties() - properties.update(self.qfont_to_artist_props(font)) - fmt_widget.set_obj(properties) - self.refresh() - - def refresh(self): - """Refresh the widgets from the current font""" - font = self.current_font - - # refresh btn_bold - self.btn_bold.blockSignals(True) - self.btn_bold.setChecked(font.weight() > 50) - self.btn_bold.blockSignals(False) - - # refresh btn_italic - self.btn_italic.blockSignals(True) - self.btn_italic.setChecked(font.italic()) - self.btn_italic.blockSignals(False) - - # refresh font size - self.spin_box.blockSignals(True) - self.spin_box.setValue(font.pointSize()) - self.spin_box.blockSignals(False) - - def choose_color(self, color=None): - fmt_widget = self.parent() - if color is None: - color = QColorDialog.getColor( - self.current_color, fmt_widget, - 'Select %s color' % self.fmto_name) - if not color.isValid(): - return - self.current_color = color - properties = self.load_properties() - properties['color'] = color.getRgbF() - fmt_widget.set_obj(properties) diff --git a/readthedocs.yml b/readthedocs.yml deleted file mode 100644 index 7ab69921..00000000 --- a/readthedocs.yml +++ /dev/null @@ -1,13 +0,0 @@ -version: 2 - -# Build all formats -formats: all -conda: - environment: docs/environment.yml -python: - version: 3.7 - install: - - method: pip - path: . -submodules: - exclude: all diff --git a/requirements.txt b/requirements.txt deleted file mode 100644 index c0d2c8f0..00000000 --- a/requirements.txt +++ /dev/null @@ -1,11 +0,0 @@ -# Matplotlib -# https://github.com/matplotlib/matplotlib/blob/master/CHANGELOG -matplotlib==3.1.3 # rq.filter: >=1.4 - -# xarray -# https://github.com/pydata/xarray/blob/stable/doc/whats-new.rst -xarray==0.15.0 # rq.filter: >=0.7.0 - -# seaborn -# http://seaborn.pydata.org/whatsnew.html -seaborn==0.10.0 # rq.filter: >= 0.7 diff --git a/setup.cfg b/setup.cfg deleted file mode 100644 index d92bd1c2..00000000 --- a/setup.cfg +++ /dev/null @@ -1,9 +0,0 @@ -[versioneer] -VCS = git -style = pep440 -versionfile_source = psy_simple/_version.py -versionfile_build = psy_simple/_version.py -tag_prefix = v -parentdir_prefix = psy-simple- - - diff --git a/setup.py b/setup.py deleted file mode 100644 index 0ceef95c..00000000 --- a/setup.py +++ /dev/null @@ -1,109 +0,0 @@ -"""Setup script for the psy-simple package.""" - -# Disclaimer -# ---------- -# -# Copyright (C) 2021 Helmholtz-Zentrum Hereon -# Copyright (C) 2020-2021 Helmholtz-Zentrum Geesthacht -# Copyright (C) 2016-2021 University of Lausanne -# -# This file is part of psy-simple and is released under the GNU LGPL-3.O license. -# See COPYING and COPYING.LESSER in the root of the repository for full -# licensing details. -# -# This program is free software: you can redistribute it and/or modify -# it under the terms of the GNU Lesser General Public License version 3.0 as -# published by the Free Software Foundation. -# -# 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 LGPL-3.0 license for more details. -# -# You should have received a copy of the GNU LGPL-3.0 license -# along with this program. If not, see . - -import os -import os.path as osp -from setuptools import setup, find_packages -from setuptools.command.test import test as TestCommand -import sys - - -if os.getenv("READTHEDOCS") == "True": - # to make versioneer working, we need to unshallow this repo - # because RTD does a checkout with --depth 50 - import subprocess as spr - rootdir = osp.dirname(__file__) - spr.call(["git", "-C", rootdir, "fetch", "--unshallow", "origin"]) - - -import versioneer - - -def readme(): - with open('README.rst') as f: - return f.read() - - -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) - -cmdclass = versioneer.get_cmdclass({'test': PyTest}) - -setup(name='psy-simple', - version=versioneer.get_version(), - description='Psyplot plugin for simple visualization tasks', - long_description=readme(), - long_description_content_type="text/x-rst", - classifiers=[ - 'Development Status :: 5 - Production/Stable', - 'Intended Audience :: Developers', - 'Topic :: Scientific/Engineering :: Visualization', - 'Topic :: Scientific/Engineering :: GIS', - 'Topic :: Scientific/Engineering', - 'License :: OSI Approved :: GNU Lesser General Public License v3 (LGPLv3)', - 'Programming Language :: Python :: 3', - 'Programming Language :: Python :: 3 :: Only', - 'Programming Language :: Python :: 3.7', - 'Programming Language :: Python :: 3.8', - 'Programming Language :: Python :: 3.9', - 'Operating System :: OS Independent', - ], - keywords='visualization netcdf raster cartopy earth-sciences psyplot', - url='https://github.com/psyplot/psy-simple', - author='Philipp S. Sommer', - author_email='philipp.sommer@hereon.de', - license="LGPL-3.0-only", - packages=find_packages(exclude=['docs', 'tests*', 'examples']), - install_requires=[ - 'psyplot>=1.3.0', - 'matplotlib>=2.0', - ], - package_data={'psy_simple': [ - osp.join('psy_simple', 'widgets', 'icons', '*.png'), - osp.join('psy_simple', 'widgets', 'icons', 'cmaps', '*.png'), - ]}, - project_urls={ - 'Documentation': 'https://psyplot.github.io/psy-simple', - 'Source': 'https://github.com/psyplot/psy-simple', - 'Tracker': 'https://github.com/psyplot/psy-simple/issues', - }, - python_requires=">=3.7", - include_package_data=True, - tests_require=['pytest'], - cmdclass=cmdclass, - entry_points={'psyplot': ['plugin=psy_simple.plugin', - 'patches=psy_simple.plugin:patches']}, - zip_safe=False) diff --git a/tests/_base_testing.py b/tests/_base_testing.py deleted file mode 100644 index 5ca2775b..00000000 --- a/tests/_base_testing.py +++ /dev/null @@ -1,149 +0,0 @@ -"""Base test setup for the psy-simple test suite.""" - -# Disclaimer -# ---------- -# -# Copyright (C) 2021 Helmholtz-Zentrum Hereon -# Copyright (C) 2020-2021 Helmholtz-Zentrum Geesthacht -# Copyright (C) 2016-2021 University of Lausanne -# -# This file is part of psy-simple and is released under the GNU LGPL-3.O license. -# See COPYING and COPYING.LESSER in the root of the repository for full -# licensing details. -# -# This program is free software: you can redistribute it and/or modify -# it under the terms of the GNU Lesser General Public License version 3.0 as -# published by the Free Software Foundation. -# -# 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 LGPL-3.0 license for more details. -# -# You should have received a copy of the GNU LGPL-3.0 license -# along with this program. If not, see . - -import os -import six -import sys -import shutil -import subprocess as spr -import tempfile -from unittest import TestCase -import numpy as np - -test_dir = os.path.dirname(__file__) - -ref_dir = os.getenv( - "PSYPLOT_REFERENCES", os.path.join(test_dir, "reference_figures") -) -output_dir = os.getenv( - "PSYPLOT_TESTFIGURES", os.path.join(test_dir, "test_figures") -) - -# check if the seaborn version is smaller than 0.8 (without actually importing -# it), due to https://github.com/mwaskom/seaborn/issues/966 -# If so, disable the import of it when import psyplot.project -try: - sns_version = spr.check_output( - [sys.executable, '-c', 'import seaborn; print(seaborn.__version__)']) -except spr.CalledProcessError: # seaborn is not installed - sns_version = None -else: - sns_version = sns_version.decode('utf-8') - - -class PsyPlotTestCase(TestCase): - """Base class for testing the psyplot package. It only provides some - useful methods to compare figures""" - - longMessage = True - - plot_type = None - - grid_type = None - - ncfile = os.path.join(test_dir, 'test-t2m-u-v.nc') - - @classmethod - def tearDownClass(cls): - import psyplot - from psyplot.config.rcsetup import defaultParams - psyplot.rcParams.update( - **{key: val[0] for key, val in defaultParams.items()}) - - @classmethod - def create_dirs(cls): - if not os.path.exists(ref_dir): - os.makedirs(ref_dir) - if not os.path.exists(output_dir): - os.makedirs(output_dir) - cls.odir = output_dir - - def get_ref_file(self, identifier): - """ - Gives the name of the reference file for a test - - This staticmethod gives combines the given `plot_type`, `identifier` - and `grid_type` to form the name of a reference figure - - Parameters - ---------- - identifier: str - The unique identifier for the plot (usually the formatoption name) - - Returns - ------- - str - The basename of the reference file""" - identifiers = ['test'] - if self.plot_type is not None: - identifiers.append(self.plot_type) - identifiers.append(identifier) - if self.grid_type is not None: - identifiers.append(self.grid_type) - return "_".join(identifiers) + '.png' - - def compare_figures(self, fname, tol=5, **kwargs): - """Saves and compares the figure to the reference figure with the same - name""" - import matplotlib.pyplot as plt - from matplotlib.testing.compare import compare_images - plt.savefig(os.path.join(self.odir, fname), **kwargs) - results = compare_images( - os.path.join(ref_dir, fname), os.path.join(self.odir, fname), - tol=tol) - self.assertIsNone(results, msg=results) - - def assertAlmostArrayEqual(self, actual, desired, rtol=1e-07, atol=0, - msg=None, **kwargs): - """Asserts that the two given arrays are almost the same - - This method uses the :func:`numpy.testing.assert_allclose` function - to compare the two given arrays. - - Parameters - ---------- - actual : array_like - Array obtained. - desired : array_like - Array desired. - rtol : float, optional - Relative tolerance. - atol : float, optional - Absolute tolerance. - equal_nan : bool, optional. - If True, NaNs will compare equal. - err_msg : str, optional - The error message to be printed in case of failure. - verbose : bool, optional - If True, the conflicting values are appended to the error message. - """ - try: - np.testing.assert_allclose(actual, desired, rtol=rtol, atol=atol, - err_msg=msg or '', **kwargs) - except AssertionError as e: - if six.PY2: - self.fail(e.message) - else: - self.fail(str(e)) diff --git a/tests/circumpolar_test.nc b/tests/circumpolar_test.nc deleted file mode 100644 index 158aee5d..00000000 Binary files a/tests/circumpolar_test.nc and /dev/null differ diff --git a/tests/conftest.py b/tests/conftest.py deleted file mode 100644 index 9bc8f92d..00000000 --- a/tests/conftest.py +++ /dev/null @@ -1,36 +0,0 @@ -"""pytest configuration module for psy-simple.""" - -# Disclaimer -# ---------- -# -# Copyright (C) 2021 Helmholtz-Zentrum Hereon -# Copyright (C) 2020-2021 Helmholtz-Zentrum Geesthacht -# Copyright (C) 2016-2021 University of Lausanne -# -# This file is part of psy-simple and is released under the GNU LGPL-3.O license. -# See COPYING and COPYING.LESSER in the root of the repository for full -# licensing details. -# -# This program is free software: you can redistribute it and/or modify -# it under the terms of the GNU Lesser General Public License version 3.0 as -# published by the Free Software Foundation. -# -# 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 LGPL-3.0 license for more details. -# -# You should have received a copy of the GNU LGPL-3.0 license -# along with this program. If not, see . - -def pytest_addoption(parser): - group = parser.getgroup("psyplot", "psyplot specific options") - group.addoption( - '--ref', help='Create reference figures instead of running the tests', - action='store_true') - - -def pytest_configure(config): - if config.getoption('ref'): - import unittest - unittest.TestLoader.testMethodPrefix = 'ref' diff --git a/tests/icon_edge_test.nc b/tests/icon_edge_test.nc deleted file mode 100644 index d946e040..00000000 Binary files a/tests/icon_edge_test.nc and /dev/null differ diff --git a/tests/icon_test.nc b/tests/icon_test.nc deleted file mode 100644 index f1f7e060..00000000 Binary files a/tests/icon_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 0b0ff18f..00000000 Binary files a/tests/rotated-pole-test.nc and /dev/null differ diff --git a/tests/simple_triangular_grid_si0.nc b/tests/simple_triangular_grid_si0.nc deleted file mode 100644 index 6614f1a5..00000000 Binary files a/tests/simple_triangular_grid_si0.nc and /dev/null differ diff --git a/tests/test_barplot.py b/tests/test_barplot.py deleted file mode 100755 index 765d4b41..00000000 --- a/tests/test_barplot.py +++ /dev/null @@ -1,172 +0,0 @@ -"""Test module of the :mod:`psy_simple.plotters` module.""" - -# Disclaimer -# ---------- -# -# Copyright (C) 2021 Helmholtz-Zentrum Hereon -# Copyright (C) 2020-2021 Helmholtz-Zentrum Geesthacht -# Copyright (C) 2016-2021 University of Lausanne -# -# This file is part of psy-simple and is released under the GNU LGPL-3.O license. -# See COPYING and COPYING.LESSER in the root of the repository for full -# licensing details. -# -# This program is free software: you can redistribute it and/or modify -# it under the terms of the GNU Lesser General Public License version 3.0 as -# published by the Free Software Foundation. -# -# 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 LGPL-3.0 license for more details. -# -# You should have received a copy of the GNU LGPL-3.0 license -# along with this program. If not, see . - -import os -import unittest -import numpy as np -import matplotlib.colors as mcol - -from psyplot import InteractiveList, open_dataset -from psy_simple.plotters import BarPlotter -import psyplot.project as psy - -import _base_testing as bt -import test_lineplot as tl - - -class BarPlotterTest(tl.LinePlotterTest): - """Test class for :class:`psy_simple.plotters.BarPlotter`""" - - plot_type = "bar" - - @classmethod - def setUpClass(cls): - cls.ds = open_dataset(cls.ncfile) - cls.data = InteractiveList.from_dataset( - cls.ds, y=[0, 1], z=0, t=0, name=cls.var, auto_update=True - ) - cls.plotter = BarPlotter(cls.data) - cls.create_dirs() - - def plot(self, **kwargs): - name = kwargs.pop("name", self.var) - return psy.plot.barplot( - self.ncfile, name=name, t=0, z=0, y=[0, 1], **kwargs - ) - - @unittest.skip("No need for figure creation") - def ref_xticks(self, close=True): - pass - - @unittest.skip("No need for figure creation") - def ref_plot_area(self, close=True): - pass - - @unittest.skip("No need for figure creation") - def ref_plot_areax(self, close=True): - pass - - @unittest.skip("No need for figure creation") - def ref_plot_None(self, *args): - pass - - @unittest.skip("No need for figure creation") - def ref_plot_stacked(self, close=True): - pass - - @unittest.skip("No need for figure creation") - def ref_plot_stacked_transposed(self, close=True): - pass - - @unittest.skip("No need for figure creation") - def test_plot_area(self, *args): - pass - - @unittest.skip("No need for figure creation") - def test_plot_areax(self, *args): - pass - - @unittest.skip("No need for figure creation") - def test_plot_None(self, *args): - pass - - @unittest.skip("No need for figure creation") - def test_plot_stacked(self, close=True): - pass - - @unittest.skip("No need for figure creation") - def test_plot_stacked_transposed(self, close=True): - pass - - def ref_plot(self, close=True): - """Create the reference figure for the stacked plot""" - sp = self.plot(plot="stacked") - sp.export(os.path.join(bt.ref_dir, self.get_ref_file("stacked"))) - sp2 = self.plot(plot="stacked", transpose=True) - sp2.export( - os.path.join(bt.ref_dir, self.get_ref_file("stacked_transposed")) - ) - if close: - sp.close(True, True, True) - sp2.close(True, True, True) - - def test_plot(self, *args): - """Test the stacked plot""" - self.update(plot="stacked") - self.compare_figures(next(iter(args), self.get_ref_file("stacked"))) - self.update(plot="stacked", transpose=True) - self.compare_figures( - next(iter(args), self.get_ref_file("stacked_transposed")) - ) - - def test_xticks(self, *args): - self._test_DtTicksBase() - - def _test_DtTicksBase(self, *args): - data = InteractiveList.from_dataset( - self.data[0].psy.base, - y=[0, 1], - z=0, - x=0, - name=self.var, - auto_update=True, - ) - plotter = self.plotter.__class__(data) - ax = plotter.ax - plotter.update(xticklabels="%m") - self.assertListEqual( - ax.get_xticks().astype(int).tolist(), list(range(5)) - ) - - def test_color(self): - colors = ["y", "g"][: len(self.data)] - current_colors = [ - c[0].get_facecolor() for c in self.plotter.ax.containers - ] - self.update(color=colors) - - self.assertEqual( - [c[0].get_facecolor() for c in self.plotter.ax.containers], - list(map(mcol.colorConverter.to_rgba, colors)), - ) - self.update(color=None) - self.assertEqual( - [c[0].get_facecolor() for c in self.plotter.ax.containers], - current_colors, - ) - - def test_ylim(self): - """Test ylim formatoption""" - curr_lim = self.plotter.ax.get_ylim() - self.update(ylim=(-1, 300)) - self.assertEqual(self.plotter.ax.get_ylim(), (-1, 300)) - self.update(ylim=(-1, "rounded")) - self.assertEqual(self.plotter.ax.get_ylim(), (-1, curr_lim[1])) - self.update(ylim=(0, ["minmax", 75])) - data = self.data.to_dataframe() - arr = data[data.notnull()].values - self.assertAlmostArrayEqual( - self.plotter.ax.get_ylim(), [0, np.percentile(arr, 75)] - ) diff --git a/tests/test_barplot_data.py b/tests/test_barplot_data.py deleted file mode 100755 index 4f6c58a3..00000000 --- a/tests/test_barplot_data.py +++ /dev/null @@ -1,72 +0,0 @@ -"""Test module of the :mod:`psy_simple.plotters` module.""" - -# Disclaimer -# ---------- -# -# Copyright (C) 2021 Helmholtz-Zentrum Hereon -# Copyright (C) 2020-2021 Helmholtz-Zentrum Geesthacht -# Copyright (C) 2016-2021 University of Lausanne -# -# This file is part of psy-simple and is released under the GNU LGPL-3.O license. -# See COPYING and COPYING.LESSER in the root of the repository for full -# licensing details. -# -# This program is free software: you can redistribute it and/or modify -# it under the terms of the GNU Lesser General Public License version 3.0 as -# published by the Free Software Foundation. -# -# 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 LGPL-3.0 license for more details. -# -# You should have received a copy of the GNU LGPL-3.0 license -# along with this program. If not, see . - -import os -from psy_simple.plotters import BarPlotter -import psyplot.project as psy -import test_lineplot as tl -import test_barplot as tb -import _base_testing as bt -from psyplot import rcParams - - -class BarPlotterDataTest(tb.BarPlotterTest): - """TestCase of :class:`psy_simple.plotters.BarPlotter` with widhts=='data' - """ - - plot_type = "bar_data" - - @classmethod - def setUpClass(cls): - plotter = BarPlotter() - rcParams[plotter.widths.default_key] = "data" - super().setUpClass() - - def test_ylim(self): - """Test ylim formatoption""" - tl.LinePlotterTest.test_ylim(self) - - def _test_DtTicksBase(self, *args): - tl.LinePlotterTest._test_DtTicksBase(self, *args) - - def ref_xticks(self, close=True): - """Create reference file for xticks formatoption - - Create reference file for - :attr:`~psy_simple.plotters.BarPlotter.xticks` - formatoption""" - sp = psy.plot.barplot( - self.ncfile, - name=self.var, - lon=0, - lev=0, - lat=[0, 1], - xticklabels={"major": "%m", "minor": "%d"}, - xtickprops={"pad": 7.0}, - xticks={"minor": "week", "major": "month"}, - ) - sp.export(os.path.join(bt.ref_dir, self.get_ref_file("xticks"))) - if close: - sp.close(True, True) diff --git a/tests/test_barplot_single.py b/tests/test_barplot_single.py deleted file mode 100755 index 08ad09ee..00000000 --- a/tests/test_barplot_single.py +++ /dev/null @@ -1,67 +0,0 @@ -"""Test module of the :mod:`psy_simple.plotters` module.""" - -# Disclaimer -# ---------- -# -# Copyright (C) 2021 Helmholtz-Zentrum Hereon -# Copyright (C) 2020-2021 Helmholtz-Zentrum Geesthacht -# Copyright (C) 2016-2021 University of Lausanne -# -# This file is part of psy-simple and is released under the GNU LGPL-3.O license. -# See COPYING and COPYING.LESSER in the root of the repository for full -# licensing details. -# -# This program is free software: you can redistribute it and/or modify -# it under the terms of the GNU Lesser General Public License version 3.0 as -# published by the Free Software Foundation. -# -# 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 LGPL-3.0 license for more details. -# -# You should have received a copy of the GNU LGPL-3.0 license -# along with this program. If not, see . - -import unittest - -from psy_simple.plotters import BarPlotter -import psyplot.project as psy -import test_barplot as tb -from psyplot import InteractiveList, open_dataset - - -class SingleBarPlotterTest(tb.BarPlotterTest): - """Test of :class:`psy_simple.plotters.ViolinPlotter` with a single array - instead of an InteractiveList""" - - plot_type = "singlebar" - - @classmethod - def setUpClass(cls): - cls.ds = open_dataset(cls.ncfile) - cls.data = InteractiveList.from_dataset( - cls.ds, y=0, z=0, t=0, name=cls.var, auto_update=True - ) - cls.data[0].psy.arr_name = "arr0" - cls.data.psy.arr_name = "arr0" - cls.plotter = BarPlotter(cls.data[0]) - cls.create_dirs() - - @classmethod - def tearDown(cls): - cls.data[0].psy.update(t=0, todefault=True, replot=True) - - def plot(self, **kwargs): - name = kwargs.pop("name", self.var) - return psy.plot.barplot( - self.ncfile, name=name, t=0, z=0, y=0, **kwargs - ) - - @unittest.skip("""Not possible for single array""") - def test_plot(self, *args): - pass - - @unittest.skip("Appending not possible for single line") - def test_append_data(self): - pass diff --git a/tests/test_base.py b/tests/test_base.py deleted file mode 100755 index b46926db..00000000 --- a/tests/test_base.py +++ /dev/null @@ -1,194 +0,0 @@ -"""Test module of the :mod:`psyplot.plotter.baseplotter` module.""" - -# Disclaimer -# ---------- -# -# Copyright (C) 2021 Helmholtz-Zentrum Hereon -# Copyright (C) 2020-2021 Helmholtz-Zentrum Geesthacht -# Copyright (C) 2016-2021 University of Lausanne -# -# This file is part of psy-simple and is released under the GNU LGPL-3.O license. -# See COPYING and COPYING.LESSER in the root of the repository for full -# licensing details. -# -# This program is free software: you can redistribute it and/or modify -# it under the terms of the GNU Lesser General Public License version 3.0 as -# published by the Free Software Foundation. -# -# 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 LGPL-3.0 license for more details. -# -# You should have received a copy of the GNU LGPL-3.0 license -# along with this program. If not, see . - -from itertools import chain -import unittest -import _base_testing as bt -import matplotlib as mpl -import numpy as np -import matplotlib.pyplot as plt -import matplotlib.colors as mcol -import psyplot -from psy_simple.base import BasePlotter -from psyplot import InteractiveList, open_dataset - - -if mpl.__version__ >= '1.5' and mpl.__version__ < '2.1': - from matplotlib.font_manager import weight_dict - bold = weight_dict['bold'] -else: - bold = 'bold' - - -class BasePlotterTest(bt.PsyPlotTestCase): - """Test :class:`psyplot.plotter.baseplotter.BasePlotter` class""" - - var = 't2m' - - masking_val = 250 - - @classmethod - def setUpClass(cls): - cls.ds = open_dataset(cls.ncfile) - cls.data = InteractiveList.from_dataset( - cls.ds, y=[0, 1], z=0, t=0, name=cls.var, auto_update=True) - cls.plotter = BasePlotter(cls.data) - - @classmethod - def tearDownClass(cls): - super(BasePlotterTest, cls).tearDownClass() - cls.ds.close() - plt.close(cls.plotter.ax.get_figure().number) - - def tearDown(self): - self.data.psy.update(t=0, todefault=True, replot=True) - - def update(self, *args, **kwargs): - """Update the plotter of this instance""" - self.plotter.update(*args, **kwargs) - - def _label_test(self, key, label_func, has_time=True): - kwargs = { - key: "Test plot at %Y-%m-%d, {tinfo} o'clock of %(long_name)s"} - self.update(**kwargs) - t_str = '1979-01-31, 18:00' if has_time else '%Y-%m-%d, %H:%M' - self.assertEqual( - u"Test plot at %s o'clock of %s" % ( - t_str, self.data.attrs.get('long_name', 'Temperature')), - label_func().get_text()) - self.data.psy.update(t=1) - t_str = '1979-02-28, 18:00' if has_time else '%Y-%m-%d, %H:%M' - self.assertEqual( - u"Test plot at %s o'clock of %s" % ( - t_str, self.data.attrs.get('long_name', 'Temperature')), - label_func().get_text()) - self.data.psy.update(t=0) - - def test_title(self): - """Test title, titlesize, titleweight, titleprops formatoptions""" - def get_title(): - return self.plotter.ax.title - self._label_test('title', get_title) - self.update(titlesize=22, titleweight='bold', - titleprops={'ha': 'left'}) - self.assertEqual(get_title().get_size(), 22) - self.assertEqual(get_title().get_weight(), bold) - self.assertEqual(get_title().get_ha(), 'left') - - def test_background(self): - self.update(background='0.5') - bc = mcol.to_rgba(self.plotter.ax.patch.get_facecolor()) - self.assertEqual(bc, (0.5, 0.5, 0.5, 1.0)) - - def test_figtitle(self): - """Test figtitle, figtitlesize, figtitleweight, figtitleprops - formatoptions""" - def get_figtitle(): - fig = plt.gcf() - for text in fig.texts: - if text.get_position() == (0.5, 0.98): - return text - self._label_test('figtitle', get_figtitle) - self.update(figtitlesize=22, figtitleweight='bold', - figtitleprops={'ha': 'left'}) - self.assertEqual(get_figtitle().get_size(), 22) - self.assertEqual(get_figtitle().get_weight(), bold) - self.assertEqual(get_figtitle().get_ha(), 'left') - - def test_text(self): - """Test text formatoption""" - def get_default_text(): - for text in chain(*self.plotter.text._texts.values()): - if text.get_position() == tuple(psyplot.rcParams[ - 'texts.default_position']): - return text - self._label_test('text', get_default_text) - self.update( - text=(0.5, 0.5, '%(name)s', 'fig', {'fontsize': 16})) - for t in self.plotter.text._texts['fig']: - if t.get_position() == (0.5, 0.5): - text = t - break - else: - text = False - self.assertTrue(text is not False) - if not text: - return - self.assertEqual(text.get_text(), getattr(self.data, 'name', self.var)) - self.assertEqual(text.get_fontsize(), 16) - - def test_maskgreater(self): - """Test maskgreater formatoption""" - self.update(maskgreater=self.masking_val) - for arr in self.plotter.maskgreater.iter_data: - self.assertLessEqual(arr.max().values, self.masking_val) - - def test_maskgeq(self): - """Test maskgeq formatoption""" - self.update(maskgeq=self.masking_val) - for arr in self.plotter.maskgeq.iter_data: - self.assertLessEqual(arr.max().values, self.masking_val) - - def test_maskless(self): - """Test maskless formatoption""" - self.update(maskless=self.masking_val) - for arr in self.plotter.maskless.iter_data: - self.assertGreaterEqual(arr.min().values, self.masking_val) - - def test_maskleq(self): - """Test maskleq formatoption""" - self.update(maskleq=self.masking_val) - for arr in self.plotter.maskleq.iter_data: - self.assertGreaterEqual(arr.min().values, self.masking_val) - - def test_maskbetween(self): - """Test maskbetween formatoption""" - self.update(maskbetween=[self.masking_val, self.masking_val + 1]) - for arr in self.plotter.maskbetween.iter_data: - data = arr.values[~np.isnan(arr.values)] - self.assertLessEqual(data[data < self.masking_val + 1].max(), - self.masking_val) - self.assertGreaterEqual(data[data > self.masking_val].max(), - self.masking_val + 1) - - -class TestBase2D(object): - """Test :class:`psyplot.plotter.baseplotter.BasePlotter` class without time - and vertical dimension""" - - def _label_test(self, key, label_func, has_time=False): - return super(TestBase2D, self)._label_test( - key, label_func, has_time=has_time) - - -class BasePlotterTest2D(TestBase2D, BasePlotterTest): - """Test :class:`psyplot.plotter.baseplotter.BasePlotter` class without time - and vertical dimension""" - - var = 't2m_2d' - - -if __name__ == '__main__': - unittest.main() diff --git a/tests/test_colors.py b/tests/test_colors.py deleted file mode 100644 index 318ccfaf..00000000 --- a/tests/test_colors.py +++ /dev/null @@ -1,79 +0,0 @@ -"""Test the :mod:`psy_simple.colors` module.""" - -# Disclaimer -# ---------- -# -# Copyright (C) 2021 Helmholtz-Zentrum Hereon -# Copyright (C) 2020-2021 Helmholtz-Zentrum Geesthacht -# Copyright (C) 2016-2021 University of Lausanne -# -# This file is part of psy-simple and is released under the GNU LGPL-3.O license. -# See COPYING and COPYING.LESSER in the root of the repository for full -# licensing details. -# -# This program is free software: you can redistribute it and/or modify -# it under the terms of the GNU Lesser General Public License version 3.0 as -# published by the Free Software Foundation. -# -# 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 LGPL-3.0 license for more details. -# -# You should have received a copy of the GNU LGPL-3.0 license -# along with this program. If not, see . - -import six -import unittest -import _base_testing as bt -import matplotlib.pyplot as plt -import psy_simple.colors as psyc - - -class TestShowColormaps(unittest.TestCase): - """Test the :func:`psy_simple.colors.show_colormaps` function""" - - def setUp(self): - plt.close('all') - - def tearDown(self): - plt.close('all') - - def test_all(self): - """Test the display of all colormaps""" - fig = psyc.show_colormaps(use_qt=False) - self.assertEqual(fig.number, 1) - self.assertGreater(len(fig.axes), 15) - - def test_some(self): - """Test the display of a selection of colormaps""" - cmap = plt.get_cmap('Reds') - fig = psyc.show_colormaps(['jet', cmap, 'red_white_blue'], - use_qt=False) - self.assertEqual(fig.number, 1) - self.assertEqual(len(fig.axes), 3) - - @unittest.skipIf( - six.PY2 or (bt.sns_version is not None and bt.sns_version < '0.8'), - 'Not implemented TestCase method' if six.PY2 else "Crashed by seaborn") - def test_warning_similar(self): - """Test the display of a warning of a slightly misspelled cmap""" - with self.assertWarnsRegex(UserWarning, 'Similar colormaps'): - fig = psyc.show_colormaps('jett', use_qt=False) - self.assertEqual(fig.number, 1) - self.assertEqual(len(fig.axes), 0) - - @unittest.skipIf( - six.PY2 or (bt.sns_version is not None and bt.sns_version < '0.8'), - 'Not implemented TestCase method' if six.PY2 else "Crashed by seaborn") - def test_warning_unknown(self): - """Test the display of a warning of a completely unknown cmap""" - with self.assertWarnsRegex(UserWarning, - 'Run function without arguments'): - fig = psyc.show_colormaps('asdfkj', use_qt=False) - self.assertEqual(fig.number, 1) - self.assertEqual(len(fig.axes), 0) - - -if __name__ == '__main__': - unittest.main() diff --git a/tests/test_combined.py b/tests/test_combined.py deleted file mode 100644 index fcde6fa4..00000000 --- a/tests/test_combined.py +++ /dev/null @@ -1,422 +0,0 @@ -"""Test module for the CombinedSimplePlotter.""" - -# Disclaimer -# ---------- -# -# Copyright (C) 2021 Helmholtz-Zentrum Hereon -# Copyright (C) 2020-2021 Helmholtz-Zentrum Geesthacht -# Copyright (C) 2016-2021 University of Lausanne -# -# This file is part of psy-simple and is released under the GNU LGPL-3.O license. -# See COPYING and COPYING.LESSER in the root of the repository for full -# licensing details. -# -# This program is free software: you can redistribute it and/or modify -# it under the terms of the GNU Lesser General Public License version 3.0 as -# published by the Free Software Foundation. -# -# 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 LGPL-3.0 license for more details. -# -# You should have received a copy of the GNU LGPL-3.0 license -# along with this program. If not, see . - -import os -import re -import six - -from functools import wraps -from itertools import chain -import unittest -import numpy as np - -from psyplot import ArrayList, open_dataset, rcParams -from psyplot.utils import _TempBool -from psy_simple.plotters import CombinedSimplePlotter -import psyplot.project as psy - -import test_base as tb -import test_vector as tv -import test_plot2d as t2d -import _base_testing as bt - - -bold = tb.bold - - -def _do_from_both(func): - """Call the given `func` only from :class:`t2d.Simple2DPlotterTest` and - :class:`tv.SimpleVectorPlotterTest`""" - func.__doc__ = getattr(tv.SimpleVectorPlotterTest, func.__name__).__doc__ - - @wraps(func) - def wrapper(self, *args, **kwargs): - getattr(t2d.Simple2DPlotterTest, func.__name__)(self, *args, **kwargs) - if hasattr(self, "plotter"): - self.plotter.update(todefault=True) - with self.vector_mode: - getattr(tv.SimpleVectorPlotterTest, func.__name__)( - self, *args, **kwargs - ) - - return wrapper - - -def _in_vector_mode(func): - """Call the given `func` only from :class:`tv.SimpleVectorPlotterTest`""" - func.__doc__ = getattr(tv.SimpleVectorPlotterTest, func.__name__).__doc__ - - @wraps(func) - def wrapper(self, *args, **kwargs): - with self.vector_mode: - getattr(tv.SimpleVectorPlotterTest, func.__name__)( - self, *args, **kwargs - ) - - return wrapper - - -class _CombinedPlotterData(object): - """Descriptor that returns the data""" - - # Note: We choose to use a descriptor rather than a usual property because - # it shall also work for class objects and not only instances - - def __get__(self, instance, owner): - if instance is None: - return owner._data - if instance.vector_mode: - return instance._data[1] - return instance._data[0] - - def __set__(self, instance, value): - instance._data = value - - -class CombinedSimplePlotterTest(tv.SimpleVectorPlotterTest): - """Test case for vector plot of - :class:`psy_simple.plotters.CombinedSimplePlotter`""" - - plot_type = "simplecombined" - - data = _CombinedPlotterData() - - var = ["t2m", ["u", "v"]] - - @property - def vector_mode(self): - """:class:`bool` indicating whether a vector specific formatoption is - tested or not""" - try: - return self._vector_mode - except AttributeError: - self._vector_mode = _TempBool(False) - return self._vector_mode - - @vector_mode.setter - def vector_mode(self, value): - self.vector_mode.value = bool(value) - - def compare_figures(self, fname, **kwargs): - kwargs.setdefault("tol", 10) - return super(CombinedSimplePlotterTest, self).compare_figures( - fname, **kwargs - ) - - @classmethod - def setUpClass(cls): - cls.ds = open_dataset(cls.ncfile) - plotter = CombinedSimplePlotter() - rcParams[plotter.vcmap.default_key] = "winter" - cls._data = ArrayList.from_dataset( - cls.ds, - t=0, - z=0, - name=[cls.var], - auto_update=True, - prefer_list=True, - )[0] - for i in range(len(cls.data)): - cls._data[i] = cls._data[i].psy.sel( - lon=slice(0, 69.0), lat=slice(81.0, 34.0) - ) - cls._data.attrs["long_name"] = "Temperature" - cls._data.attrs["name"] = "t2m" - cls.plotter = CombinedSimplePlotter(cls.data) - cls.create_dirs() - cls._color_fmts = cls.plotter.fmt_groups["colors"] - - # there is an issue with the colorbar that the size of the axes changes - # slightly after replotting. Therefore we force a replot here - cls.plotter.update(color="absolute") - cls.plotter.update(todefault=True, replot=True) - - def tearDown(self): - self._data.psy.update(t=0, todefault=True, replot=True) - - def plot(self, **kwargs): - color_fmts = psy.plot.vector.plotter_cls().fmt_groups["colors"] - fix_colorbar = not color_fmts.intersection(kwargs) - ds = psy.open_dataset(self.ncfile) - kwargs.setdefault("t", ds.time.values[0]) - kwargs.setdefault("z", ds.lev.values[0]) - kwargs.setdefault("x", slice(0, 69.0)) - kwargs.setdefault("y", slice(81.0, 34.0)) - kwargs.setdefault("method", "sel") - kwargs.setdefault("color", "absolute") - if self.vector_mode: - kwargs = self._rename_fmts(kwargs) - sp = psy.plot.combined(ds, name=[self.var], **kwargs) - if not self.vector_mode or fix_colorbar: - # if we have no color formatoptions, we have to consider that - # the position of the plot may have slighty changed - sp.update( - todefault=True, - replot=True, - **dict(item for item in kwargs.items() if item[0] != "color") - ) - return sp - - def _rename_fmts(self, kwargs): - def check_key(key): - if not any(re.match("v" + key, fmt) for fmt in vcolor_fmts): - return key - else: - return "v" + key - - vcolor_fmts = { - fmt - for fmt in chain( - psy.plot.combined.plotter_cls().fmt_groups["colors"], - ["ctick|clabel"], - ) - if fmt.startswith("v") - } - return {check_key(key): val for key, val in kwargs.items()} - - def update(self, *args, **kwargs): - if self.vector_mode and ( - self._color_fmts.intersection(kwargs) - or any(re.match("ctick|clabel", fmt) for fmt in kwargs) - ): - kwargs.setdefault("color", "absolute") - kwargs = self._rename_fmts(kwargs) - super(tv.SimpleVectorPlotterTest, self).update(*args, **kwargs) - - def get_ref_file(self, identifier): - if self.vector_mode: - identifier += "_vector" - return super(CombinedSimplePlotterTest, self).get_ref_file(identifier) - - @property - def _minmax_cticks(self): - if not self.vector_mode: - return np.round( - np.linspace( - self.plotter.plot_data[0].values.min(), - self.plotter.plot_data[0].values.max(), - 11, - endpoint=True, - ), - decimals=2, - ).tolist() - speed = ( - self.plotter.plot_data[1].values[0] ** 2 - + self.plotter.plot_data[1].values[1] ** 2 - ) ** 0.5 - return np.round( - np.linspace(speed.min(), speed.max(), 11, endpoint=True), - decimals=2, - ).tolist() - - @_do_from_both - def ref_cbar(self, close=True): - pass - - def ref_cbarspacing(self, close=True): - """Create reference file for cbarspacing formatoption""" - kwargs = dict( - bounds=list(range(245, 255)) - + np.linspace(255, 280, 6, endpoint=True).tolist() - + list(range(281, 290)) - ) - sp = self.plot(cbarspacing="proportional", cticks="rounded", **kwargs) - sp.export(os.path.join(bt.ref_dir, self.get_ref_file("cbarspacing"))) - with self.vector_mode: - tv.SimpleVectorPlotterTest.ref_cbarspacing(self, close=close) - if close: - sp.close(True, True) - - @_do_from_both - def ref_cmap(self, close=True): - pass - - def ref_miss_color(self, close=True): - t2d.Simple2DPlotterTest.ref_miss_color(self, close) - - @_in_vector_mode - def ref_arrowsize(self, *args, **kwargs): - pass - - def _label_test(self, key, label_func, has_time=True): - kwargs = { - key: "Test plot at %Y-%m-%d, {tinfo} o'clock of %(long_name)s" - } - self.update(**kwargs) - t_str = "1979-01-31, 18:00" if has_time else "%Y-%m-%d, %H:%M" - self.assertEqual( - u"Test plot at %s o'clock of %s" - % (t_str, self.data.attrs.get("long_name", "Temperature")), - label_func().get_text(), - ) - self._data.psy.update(t=1) - t_str = "1979-02-28, 18:00" if has_time else "%Y-%m-%d, %H:%M" - self.assertEqual( - u"Test plot at %s o'clock of %s" - % (t_str, self.data.attrs.get("long_name", "Temperature")), - label_func().get_text(), - ) - self._data.psy.update(t=0) - - def test_miss_color(self, *args, **kwargs): - t2d.Simple2DPlotterTest.test_miss_color(self, *args, **kwargs) - - @_do_from_both - def test_cbar(self, *args, **kwargs): - pass - - def test_cbarspacing(self, *args, **kwargs): - """Test cbarspacing formatoption""" - self.update( - cbarspacing="proportional", - cticks="rounded", - bounds=list(range(245, 255)) - + np.linspace(255, 280, 6, endpoint=True).tolist() - + list(range(281, 290)), - ) - self.compare_figures( - next(iter(args), self.get_ref_file("cbarspacing")) - ) - self.plotter.update(todefault=True) - with self.vector_mode: - tv.SimpleVectorPlotterTest.test_cbarspacing(self, *args, **kwargs) - - @_do_from_both - def test_cmap(self, *args, **kwargs): - pass - - @unittest.skipIf( - six.PY34, "The axes size changes using the arrowsize formatoption" - ) - @_in_vector_mode - def test_arrowsize(self): - pass - - def test_bounds(self): - """Test bounds formatoption""" - # test bounds of scalar field - self.assertEqual( - np.round(self.plotter.bounds.norm.boundaries, 2).tolist(), - np.linspace(250, 290, 11, endpoint=True).tolist(), - ) - self.update(bounds="minmax") - bounds = [ - 251.73, - 255.54, - 259.35, - 263.16, - 266.97, - 270.78, - 274.59, - 278.4, - 282.22, - 286.03, - 289.84, - ] - self.assertEqual( - np.round(self.plotter.bounds.norm.boundaries, 2).tolist(), bounds - ) - self.update(bounds=["rounded", 5, 5, 95]) - self.assertEqual( - np.round(self.plotter.bounds.norm.boundaries, 2).tolist(), - np.linspace(250, 290, 5, endpoint=True).tolist(), - ) - - # test vector bounds - self.update(color="absolute") - self.assertEqual( - np.round(self.plotter.vbounds.norm.boundaries, 2).tolist(), - np.linspace(0, 15, 11, endpoint=True).tolist(), - ) - self.update(vbounds="minmax") - bounds = [ - 0.36, - 1.4, - 2.45, - 3.49, - 4.54, - 5.59, - 6.63, - 7.68, - 8.72, - 9.77, - 10.81, - ] - self.assertEqual( - np.round(self.plotter.vbounds.norm.boundaries, 2).tolist(), bounds - ) - self.update(vbounds=["rounded", 5, 5, 95]) - self.assertEqual( - np.round(self.plotter.vbounds.norm.boundaries, 3).tolist(), - np.linspace(1.0, 8.5, 5, endpoint=True).tolist(), - ) - - def test_clabel(self): - def get_clabel(): - return self.plotter.vcbar.cbars["b"].ax.xaxis.get_label() - - t2d.Simple2DPlotterTest.test_clabel(self) - with self.vector_mode: - self.update(color="absolute") - self._label_test("vclabel", get_clabel) - label = get_clabel() - self.update( - vclabelsize=22, - vclabelweight="bold", - vclabelprops={"ha": "left"}, - ) - self.assertEqual(label.get_size(), 22) - self.assertEqual(label.get_weight(), bold) - self.assertEqual(label.get_ha(), "left") - - -class CombinedSimplePlotterTest2D(tb.TestBase2D, CombinedSimplePlotterTest): - """Test :class:`psy_simple.plotters.CombinedSimplePlotter` class without - time and vertical dimension""" - - var = ["t2m", ["u_2d", "v_2d"]] - - def _label_test(self, key, label_func, has_time=None): - if has_time is None: - has_time = not bool(self.vector_mode) - CombinedSimplePlotterTest._label_test( - self, key, label_func, has_time=has_time - ) - - -# skip the reference creation functions of the 2D Plotter tests -skip_msg = ( - "Reference figures for this class are created by the " - "CombinedSimplePlotterTest" -) - -for funcname in filter( - lambda s: s.startswith("ref"), dir(CombinedSimplePlotterTest2D) -): - setattr( - CombinedSimplePlotterTest2D, - funcname, - unittest.skip(skip_msg)(lambda self: None), - ) diff --git a/tests/test_combined_icon.py b/tests/test_combined_icon.py deleted file mode 100644 index 090d2e2a..00000000 --- a/tests/test_combined_icon.py +++ /dev/null @@ -1,174 +0,0 @@ -"""Test module for the combined simple plotter for the icon grid.""" - -# Disclaimer -# ---------- -# -# Copyright (C) 2021 Helmholtz-Zentrum Hereon -# Copyright (C) 2020-2021 Helmholtz-Zentrum Geesthacht -# Copyright (C) 2016-2021 University of Lausanne -# -# This file is part of psy-simple and is released under the GNU LGPL-3.O license. -# See COPYING and COPYING.LESSER in the root of the repository for full -# licensing details. -# -# This program is free software: you can redistribute it and/or modify -# it under the terms of the GNU Lesser General Public License version 3.0 as -# published by the Free Software Foundation. -# -# 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 LGPL-3.0 license for more details. -# -# You should have received a copy of the GNU LGPL-3.0 license -# along with this program. If not, see . - -import os -import unittest - - -import numpy as np - -from psyplot import ArrayList, open_dataset, rcParams -from psy_simple.plotters import CombinedSimplePlotter -import psyplot.project as psy - -import _base_testing as bt -from test_plot2d_icon import IconTestMixin -import test_combined as tc - - -class IconCombinedSimplePlotterTest( - IconTestMixin, tc.CombinedSimplePlotterTest -): - """Test :class:`psy_simple.plotters.CombinedSimplePlotter` class for icon - grid - """ - - grid_type = "icon" - - ncfile = os.path.join(bt.test_dir, "icon_test.nc") - - @classmethod - def setUpClass(cls): - cls.ds = open_dataset(cls.ncfile) - plotter = CombinedSimplePlotter() - rcParams[plotter.vcmap.default_key] = "winter" - cls._data = ArrayList.from_dataset( - cls.ds, t=0, z=0, name=[cls.var], auto_update=True, prefer_list=True - )[0] - cls._data.attrs["long_name"] = "Temperature" - cls._data.attrs["name"] = "t2m" - cls.plotter = CombinedSimplePlotter(cls.data) - cls.create_dirs() - cls._color_fmts = cls.plotter.fmt_groups["colors"] - - # there is an issue with the colorbar that the size of the axes changes - # slightly after replotting. Therefore we force a replot here - cls.plotter.update(color="absolute") - cls.plotter.update(todefault=True, replot=True) - - def plot(self, **kwargs): - color_fmts = psy.plot.vector.plotter_cls().fmt_groups["colors"] - fix_colorbar = not color_fmts.intersection(kwargs) - ds = psy.open_dataset(self.ncfile) - kwargs.setdefault("color", "absolute") - if self.vector_mode: - kwargs = self._rename_fmts(kwargs) - sp = psy.plot.combined(ds, name=[self.var], **kwargs) - if not self.vector_mode or fix_colorbar: - # if we have no color formatoptions, we have to consider that - # the position of the plot may have slighty changed - sp.update( - todefault=True, - replot=True, - **dict(item for item in kwargs.items() if item[0] != "color") - ) - return sp - - @unittest.skip( - "Density for quiver plots of unstructered data is not " "supported!" - ) - def ref_density(self): - pass - - @unittest.skip( - "Density for quiver plots of unstructered data is not " "supported!" - ) - def test_density(self): - pass - - def test_bounds(self): - """Test bounds formatoption""" - # test bounds of scalar field - self.assertEqual( - np.round(self.plotter.bounds.norm.boundaries, 2).tolist(), - np.linspace(240, 310, 11, endpoint=True).tolist(), - ) - self.update(bounds="minmax") - bounds = [ - 243.76, - 250.04, - 256.31, - 262.58, - 268.85, - 275.12, - 281.39, - 287.66, - 293.94, - 300.21, - 306.48, - ] - self.assertEqual( - np.round(self.plotter.bounds.norm.boundaries, 2).tolist(), bounds - ) - self.update(bounds=["rounded", 5, 5, 95]) - self.assertEqual( - np.round(self.plotter.bounds.norm.boundaries, 2).tolist(), - np.linspace(255, 305, 5, endpoint=True).tolist(), - ) - - # test vector bounds - self.update(color="absolute") - self.assertEqual( - np.round(self.plotter.vbounds.norm.boundaries, 2).tolist(), - np.linspace(0, 15, 11, endpoint=True).tolist(), - ) - self.update(vbounds="minmax") - bounds = [ - 0.08, - 1.18, - 2.28, - 3.38, - 4.48, - 5.59, - 6.69, - 7.79, - 8.89, - 9.99, - 11.09, - ] - self.assertEqual( - np.round(self.plotter.vbounds.norm.boundaries, 2).tolist(), bounds - ) - self.update(vbounds=["rounded", 5, 5, 95]) - self.assertEqual( - np.round(self.plotter.vbounds.norm.boundaries, 2).tolist(), - np.round(np.linspace(0.5, 9.0, 5, endpoint=True), 2).tolist(), - ) - - @property - def _minmax_cticks(self): - if not self.vector_mode: - arr = self.plotter.plot_data[0].values - arr = arr[~np.isnan(arr)] - return np.round( - np.linspace(arr.min(), arr.max(), 11, endpoint=True), decimals=2 - ).tolist() - arr = self.plotter.plot_data[1].values - speed = (arr[0] ** 2 + arr[1] ** 2) ** 0.5 - speed = speed[~np.isnan(speed)] - return np.round( - np.linspace(speed.min(), speed.max(), 11, endpoint=True), decimals=2 - ).tolist() - diff --git a/tests/test_density.py b/tests/test_density.py deleted file mode 100644 index 76daed64..00000000 --- a/tests/test_density.py +++ /dev/null @@ -1,126 +0,0 @@ -"""Test module for the density plotter.""" - -# Disclaimer -# ---------- -# -# Copyright (C) 2021 Helmholtz-Zentrum Hereon -# Copyright (C) 2020-2021 Helmholtz-Zentrum Geesthacht -# Copyright (C) 2016-2021 University of Lausanne -# -# This file is part of psy-simple and is released under the GNU LGPL-3.O license. -# See COPYING and COPYING.LESSER in the root of the repository for full -# licensing details. -# -# This program is free software: you can redistribute it and/or modify -# it under the terms of the GNU Lesser General Public License version 3.0 as -# published by the Free Software Foundation. -# -# 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 LGPL-3.0 license for more details. -# -# You should have received a copy of the GNU LGPL-3.0 license -# along with this program. If not, see . - -import numpy as np -import pandas as pd -import xarray as xr - -import matplotlib.pyplot as plt - -from psy_simple.plotters import DensityPlotter - -import _base_testing as bt - - -class DensityPlotterTest(bt.PsyPlotTestCase): - """Test of the :class:`psy_simple.plotters.DensityPlotter` class""" - - @classmethod - def setUpClass(cls): - cls.data = cls.define_data() - cls.plotter = DensityPlotter(cls.data) - - @classmethod - def tearDownClass(cls): - super(DensityPlotterTest, cls).tearDownClass() - del cls.data - plt.close(cls.plotter.ax.get_figure().number) - - def tearDown(self): - self.plotter.update(todefault=True) - - @classmethod - def update(cls, **kwargs): - """Update the plotter of this test case""" - cls.plotter.update(**kwargs) - - @property - def plot_data(self): - return self.plotter.plot_data - - @classmethod - def define_data(cls, mean=[0, 0], cov=[[10, 0], [0, 10]]): - x, y = np.random.multivariate_normal(mean, cov, 5000).T - df = pd.DataFrame(y, columns=["y"], index=pd.Index(x, name="x")) - ds = xr.Dataset.from_dataframe(df) - ds["v"] = xr.Variable(("x",), x) - ret = xr.DataArray(ds.y) - ret.psy.init_accessor(base=ds) - return ret - - def test_bins(self): - """Test the bins formatoption""" - bins = [100, 10] - self.update(bins=bins) - self.assertEqual(len(self.plot_data.x), 100) - self.assertEqual(len(self.plot_data.y), 10) - - def test_xrange(self): - """Test the xrange formatoption""" - data = self.data - xrange = np.percentile(data.x.values, [25, 75]) - self.update(xrange=xrange) - self.assertGreaterEqual(self.plot_data.x.min(), xrange[0]) - self.assertLessEqual(self.plot_data.x.max(), xrange[1]) - - # now update to use the quantiles explicitely - self.update(xrange=(["minmax", 25], ["minmax", 75])) - self.assertGreaterEqual(self.plot_data.x.min(), xrange[0]) - self.assertLessEqual(self.plot_data.x.max(), xrange[1]) - - def test_yrange(self): - """Test the yrange formatoption""" - data = self.data - yrange = np.percentile(data.values, [25, 75]) - self.update(yrange=yrange) - self.assertGreaterEqual(self.plot_data.y.min(), yrange[0]) - self.assertLessEqual(self.plot_data.y.max(), yrange[1]) - - # now update to use the quantiles explicitely - self.update(yrange=(["minmax", 25], ["minmax", 75])) - self.assertGreaterEqual(self.plot_data.y.min(), yrange[0]) - self.assertLessEqual(self.plot_data.y.max(), yrange[1]) - - def test_normed(self): - """Test the normed formatoption""" - self.update(normed="counts") - data = self.plot_data - self.assertAlmostEqual(data.values.sum(), 1.0) - - self.update(normed="area") - data = self.plot_data - a0, a1 = data.x.values[:2] - b0, b1 = data.y.values[:2] - area = (a1 - a0) * (b1 - b0) - self.assertAlmostEqual((self.plot_data.values * area).sum(), 1.0) - - def test_coord(self): - """Test whether we can use an alternative coordinate""" - self.update(coord="v", xlabel="%(name)s") - self.assertEqual( - self.plotter.ax.get_xlabel(), - "v", - msg="Did not update to the right coordinate!", - ) diff --git a/tests/test_density_kde.py b/tests/test_density_kde.py deleted file mode 100644 index 0e067eed..00000000 --- a/tests/test_density_kde.py +++ /dev/null @@ -1,46 +0,0 @@ -"""Test module for the density plotter.""" - -# Disclaimer -# ---------- -# -# Copyright (C) 2021 Helmholtz-Zentrum Hereon -# Copyright (C) 2020-2021 Helmholtz-Zentrum Geesthacht -# Copyright (C) 2016-2021 University of Lausanne -# -# This file is part of psy-simple and is released under the GNU LGPL-3.O license. -# See COPYING and COPYING.LESSER in the root of the repository for full -# licensing details. -# -# This program is free software: you can redistribute it and/or modify -# it under the terms of the GNU Lesser General Public License version 3.0 as -# published by the Free Software Foundation. -# -# 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 LGPL-3.0 license for more details. -# -# You should have received a copy of the GNU LGPL-3.0 license -# along with this program. If not, see . - -import unittest - -from psyplot import rcParams -from psy_simple.plotters import DensityPlotter - -import test_density as td - - -class DensityPlotterTestKDE(td.DensityPlotterTest): - """Test of the :class:`psy_simple.plotters.DensityPlotter` class - with kde plot""" - - @classmethod - def setUpClass(cls): - plotter = DensityPlotter() - rcParams[plotter.density.default_key] = "kde" - super().setUpClass() - - @unittest.skip("Not implemented for KDE plots!") - def test_normed(self): - pass diff --git a/tests/test_fldmean.py b/tests/test_fldmean.py deleted file mode 100644 index 36bc43d0..00000000 --- a/tests/test_fldmean.py +++ /dev/null @@ -1,170 +0,0 @@ -"""Test module for the fldmean plotter.""" - -# Disclaimer -# ---------- -# -# Copyright (C) 2021 Helmholtz-Zentrum Hereon -# Copyright (C) 2020-2021 Helmholtz-Zentrum Geesthacht -# Copyright (C) 2016-2021 University of Lausanne -# -# This file is part of psy-simple and is released under the GNU LGPL-3.O license. -# See COPYING and COPYING.LESSER in the root of the repository for full -# licensing details. -# -# This program is free software: you can redistribute it and/or modify -# it under the terms of the GNU Lesser General Public License version 3.0 as -# published by the Free Software Foundation. -# -# 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 LGPL-3.0 license for more details. -# -# You should have received a copy of the GNU LGPL-3.0 license -# along with this program. If not, see . - -import unittest -from itertools import chain - -import numpy as np -import xarray as xr -import matplotlib.pyplot as plt - -from psyplot import InteractiveList, open_dataset -from psy_simple.plotters import FldmeanPlotter - -import psyplot.project as psy - -import test_base as tb -import test_lineplot as tl - - -bold = tb.bold - - -class FldmeanPlotterTest(tl.LinePlotterTest): - """Test of the :class:`psy_simple.plotters.FldmeanPlotter` class""" - - plot_type = 'fldmean' - - @classmethod - def setUpClass(cls): - cls.ds = open_dataset(cls.ncfile) - cls.data = InteractiveList.from_dataset( - cls.ds, t=[0, 1], name=cls.var, auto_update=True) - cls.plotter = FldmeanPlotter(cls.data) - cls.create_dirs() - - def plot(self, **kwargs): - name = kwargs.pop('name', self.var) - return psy.plot.fldmean( - self.ncfile, name=name, t=[0, 1], **kwargs) - - @classmethod - def tearDown(cls): - cls.data.psy.update(todefault=True, replot=True) - - def test_coord(self): - """Test whether we can use an alternative coordinate""" - coord = xr.DataArray(np.arange(len(self.data[0])), name='test', - dims=('test', )) - self.update(coord=coord, xlabel='%(name)s') - self.assertEqual(self.plotter.ax.get_xlabel(), 'test', - msg='Did not update to the right coordinate!') - - def _label_test(self, key, label_func, has_time=False): - kwargs = {key: "Test plot for %(name)s"} - self.update(**kwargs) - self.assertEqual( - label_func().get_text(), - u"Test plot for " + self.var) - - def test_legend(self, *args): - """Test legend and legendlabels formatoption""" - args = iter(args) - self.update(legend=False) - self.assertIsNone(self.plotter.ax.legend_) - self.update(legend={ - 'loc': 'upper center', 'bbox_to_anchor': (0.5, -0.05), 'ncol': 2}) - self.compare_figures(next(args, self.get_ref_file('legend'))) - self.update(legendlabels='%m') - self.assertAlmostArrayEqual( - [float(t.get_text()) for t in plt.gca().legend_.get_texts()], - [da.expand_dims('time').time.to_index().month[0] - for da in self.data]) - - def test_xticks(self): - """Test xticks, xticklabels, xtickprops formatoptions""" - self.update(xticks=['data', 2]) - ax = plt.gca() - if isinstance(self.data, InteractiveList): - data = self.data[0] - else: - data = self.data - - lev = data.lev.values[::-1] - - self.assertEqual(list(ax.get_xticks()), - list(lev[::2])) - self.update(xticks=['mid', 2]) - - self.assertEqual( - list(ax.get_xticks()), list( - (lev[:-1] + lev[1:]) / 2.)[::2]) - self.update(xticks='rounded') - self.assertEqual( - list(ax.get_xticks()), - np.linspace(20000.0, 100000.0, 11, endpoint=True).tolist()) - self.update(xticks='roundedsym') - self.assertEqual( - list(ax.get_xticks()), - np.linspace(-100000, 100000, 10, endpoint=True).tolist()) - self.update(xticks='minmax') - self.assertEqual( - list(ax.get_xticks()), np.linspace( - lev.min(), lev.max(), - 11, endpoint=True).tolist()) - self.update(xticks='sym') - self.assertEqual( - list(ax.get_xticks()), np.linspace( - -lev.max(), lev.max(), - 10, endpoint=True).tolist()) - - def test_ticksize(self): - """Tests ticksize formatoption""" - self.update(ticksize=24) - ax = self.plotter.ax - self.assertTrue(all(t.get_size() == 24 for t in chain( - ax.get_xticklabels(), ax.get_yticklabels()))) - self.update( - ticksize={'major': 12, 'minor': 10}, xtickprops={'pad': 7.0}) - self.assertTrue(all(t.get_size() == 12 for t in chain( - ax.get_xticklabels(), ax.get_yticklabels()))) - self.assertTrue(all( - t.get_size() == 10 for t in ax.get_xticklabels(minor=True))) - - def test_xlabel(self): - """Test xlabel formatoption""" - self.update(xlabel='{desc}') - label = self.plotter.ax.xaxis.get_label() - self.assertEqual(label.get_text(), 'pressure [Pa]') - self.update(labelsize=22, labelweight='bold', - labelprops={'ha': 'left'}) - self.assertEqual(label.get_size(), 22) - self.assertEqual(label.get_weight(), bold) - self.assertEqual(label.get_ha(), 'left') - - def test_ylim(self, test_pctls=False): - super(FldmeanPlotterTest, self).test_ylim(test_pctls) - - @unittest.skip('nan not supported for icon contour') - def test_mask_01_var(self): - pass - - @unittest.skip('nan not supported for icon contour') - def test_mask_02_da(self): - pass - - @unittest.skip('nan not supported for icon contour') - def test_mask_03_fname(self): - pass diff --git a/tests/test_fldmean_icon.py b/tests/test_fldmean_icon.py deleted file mode 100644 index e0a8e0f9..00000000 --- a/tests/test_fldmean_icon.py +++ /dev/null @@ -1,86 +0,0 @@ -"""Test module for the fldmean plotter for icon grids.""" - -# Disclaimer -# ---------- -# -# Copyright (C) 2021 Helmholtz-Zentrum Hereon -# Copyright (C) 2020-2021 Helmholtz-Zentrum Geesthacht -# Copyright (C) 2016-2021 University of Lausanne -# -# This file is part of psy-simple and is released under the GNU LGPL-3.O license. -# See COPYING and COPYING.LESSER in the root of the repository for full -# licensing details. -# -# This program is free software: you can redistribute it and/or modify -# it under the terms of the GNU Lesser General Public License version 3.0 as -# published by the Free Software Foundation. -# -# 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 LGPL-3.0 license for more details. -# -# You should have received a copy of the GNU LGPL-3.0 license -# along with this program. If not, see . - -import os -import unittest - -import matplotlib.pyplot as plt - -from psyplot import open_dataset, InteractiveList -from psy_simple.plotters import FldmeanPlotter -import psyplot.project as psy - -import _base_testing as bt - -try: - from cdo import Cdo - - Cdo() -except Exception: - with_cdo = False -else: - with_cdo = True - - -@unittest.skipIf(not with_cdo, "CDOs are required for unstructured grids.") -class IconFldmeanPlotterTest(bt.PsyPlotTestCase): - - plot_type = "fldmean" - - grid_type = "icon" - - ncfile = os.path.join(bt.test_dir, "icon_test.nc") - - var = "t2m" - - @classmethod - def setUpClass(cls): - cls.ds = open_dataset(cls.ncfile) - cls.data = InteractiveList.from_dataset( - cls.ds, z=[0, 1], name=cls.var, auto_update=True - ) - cls.plotter = FldmeanPlotter(cls.data) - cls.create_dirs() - - def ref_plot(self, close=True): - """Basic reference plot""" - sp = psy.plot.fldmean(self.ncfile, name=self.var, z=[0, 1]) - sp.export(os.path.join(bt.ref_dir, self.get_ref_file("basic"))) - if close: - sp.close(True, True) - - @classmethod - def tearDown(cls): - cls.data.psy.update(todefault=True, replot=True) - - @classmethod - def tearDownClass(cls): - super(IconFldmeanPlotterTest, cls).tearDownClass() - cls.ds.close() - plt.close(cls.plotter.ax.get_figure().number) - - def test_plot(self): - """Test whether it can be plotted""" - self.compare_figures(self.get_ref_file("basic")) diff --git a/tests/test_lineplot.py b/tests/test_lineplot.py deleted file mode 100755 index 02301132..00000000 --- a/tests/test_lineplot.py +++ /dev/null @@ -1,697 +0,0 @@ -"""Test module of the :mod:`psy_simple.plotters` module""" - -# Disclaimer -# ---------- -# -# Copyright (C) 2021 Helmholtz-Zentrum Hereon -# Copyright (C) 2020-2021 Helmholtz-Zentrum Geesthacht -# Copyright (C) 2016-2021 University of Lausanne -# -# This file is part of psy-simple and is released under the GNU LGPL-3.O license. -# See COPYING and COPYING.LESSER in the root of the repository for full -# licensing details. -# -# This program is free software: you can redistribute it and/or modify -# it under the terms of the GNU Lesser General Public License version 3.0 as -# published by the Free Software Foundation. -# -# 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 LGPL-3.0 license for more details. -# -# You should have received a copy of the GNU LGPL-3.0 license -# along with this program. If not, see . - -import os -import sys -import unittest -import tempfile -from itertools import chain - -import numpy as np -import matplotlib as mpl -import matplotlib.colors as mcol -import matplotlib.pyplot as plt - -from psyplot import open_dataset, InteractiveList -from psy_simple.plotters import LinePlotter, mpl_version -import psyplot.project as psy - -import test_base as tb -import _base_testing as bt - - -bold = tb.bold - - -class LinePlotterTest(tb.BasePlotterTest): - """Test class for :class:`psy_simple.plotters.LinePlotter`""" - - plot_type = "line" - - @classmethod - def setUpClass(cls): - cls.ds = open_dataset(cls.ncfile) - cls.data = InteractiveList.from_dataset( - cls.ds, y=[0, 1], z=0, t=0, name=cls.var, auto_update=True - ) - cls.plotter = LinePlotter(cls.data) - cls.create_dirs() - - def plot(self, **kwargs): - name = kwargs.pop("name", self.var) - return psy.plot.lineplot( - self.ncfile, name=name, t=0, z=0, y=[0, 1], **kwargs - ) - - @unittest.skipIf( - mpl_version == 3.3, - "Updating grids is known to malfunction for matplotlib 3.3!", - ) - def ref_grid(self, close=True): - """Create reference file for grid formatoption - - Create reference file for - :attr:`~psy_simple.plotters.LinePlotter.grid` - formatoption""" - sp = self.plot() - sp.update(grid=True) - sp.export(os.path.join(bt.ref_dir, self.get_ref_file("grid1"))) - sp.update(grid="b") - sp.export(os.path.join(bt.ref_dir, self.get_ref_file("grid2"))) - if close: - sp.close(True, True) - - def ref_transpose(self, close=True): - """Create reference file for transpose formatoption - - Create reference file for - :attr:`~psy_simple.plotters.LinePlotter.transpose` - formatoption""" - sp = self.plot() - sp.export(os.path.join(bt.ref_dir, self.get_ref_file("transpose1"))) - sp.update(transpose=True) - sp.export(os.path.join(bt.ref_dir, self.get_ref_file("transpose2"))) - if close: - sp.close(True, True) - - def ref_legend(self, close=True): - """Create reference file for legend formatoption - - Create reference file for - :attr:`~psy_simple.plotters.LinePlotter.legend` - formatoption""" - sp = self.plot( - legend={ - "loc": "upper center", - "bbox_to_anchor": (0.5, -0.05), - "ncol": 2, - } - ) - sp.export(os.path.join(bt.ref_dir, self.get_ref_file("legend"))) - if close: - sp.close(True, True) - - def ref_xticks(self, close=True): - """Create reference file for xticks formatoption - - Create reference file for - :attr:`~psy_simple.plotters.LinePlotter.xticks` - formatoption""" - sp = psy.plot.lineplot( - self.ncfile, - name=self.var, - lon=0, - lev=0, - lat=[0, 1], - xticklabels={"major": "%m", "minor": "%d"}, - xtickprops={"pad": 7.0}, - xticks={"minor": "week", "major": "month"}, - ) - sp.export(os.path.join(bt.ref_dir, self.get_ref_file("xticks"))) - if close: - sp.close(True, True) - - def ref_plot_area(self, close=True): - """Create reference file for plot formatoption with ``'area'``""" - sp = self.plot(plot="area") - sp.export(os.path.join(bt.ref_dir, self.get_ref_file("plot_area"))) - if close: - sp.close(True, True) - - def ref_plot_areax(self, close=True): - """Create reference file for plot formatoption with ``'areax'``""" - sp = self.plot(plot="areax", transpose=True) - sp.export(os.path.join(bt.ref_dir, self.get_ref_file("plot_areax"))) - if close: - sp.close(True, True) - - def ref_plot_None(self, close=True): - sp = self.plot(plot=["--", None]) - sp.export(os.path.join(bt.ref_dir, self.get_ref_file("plot_None"))) - if close: - sp.close(True, True) - - def ref_plot_stacked(self, close=True): - """Create reference file for plot formatoption with ``'areax'``""" - sp = self.plot(plot="stacked") - sp.export(os.path.join(bt.ref_dir, self.get_ref_file("plot_stacked"))) - if close: - sp.close(True, True) - - def ref_plot_stacked_transposed(self, close=True): - """Create reference file for plot formatoption with ``'areax'``""" - sp = self.plot(plot="stacked", transpose=True) - sp.export( - os.path.join( - bt.ref_dir, self.get_ref_file("plot_stacked_transposed") - ) - ) - if close: - sp.close(True, True) - - def test_plot_area(self, *args): - """Test plot formatoption with ``'areax'``""" - self.update(plot="area") - self.compare_figures(next(iter(args), self.get_ref_file("plot_area"))) - - def test_plot_areax(self, *args): - """Test plot formatoption with ``'areax'``""" - self.update(plot="areax", transpose=True) - self.compare_figures(next(iter(args), self.get_ref_file("plot_areax"))) - - def test_plot_None(self, *args): - """Test excluding one specific line""" - self.update(plot=["--", None]) - self.compare_figures(next(iter(args), self.get_ref_file("plot_None"))) - - def test_plot_stacked(self, *args): - """Test plot formatoption with ``'areax'``""" - self.update(plot="stacked") - self.compare_figures( - next(iter(args), self.get_ref_file("plot_stacked")) - ) - - def test_mask_01_var(self): - def get_data(data): - if isinstance(data, InteractiveList): - return data[0] - else: - return data - - data = get_data(self.data) - mask = data.copy(data=np.ones_like(data, dtype=bool)) - mask[..., 3] = False - data.psy.base["mask"] = mask - try: - self.update(mask="mask") - self.assertTrue( - np.all(get_data(self.plotter.plot_data).isnull()[..., 3]) - ) - finally: - del data.psy.base["mask"] - - def test_mask_02_da(self): - def get_data(data): - if isinstance(data, InteractiveList): - return data[0] - else: - return data - - data = get_data(self.data) - mask = data.copy(data=np.ones_like(data, dtype=bool)) - mask[..., 3] = False - self.update(mask=mask) - self.assertTrue( - np.all(get_data(self.plotter.plot_data).isnull()[..., 3]) - ) - - @unittest.skipIf(sys.platform == "win32", "Skipped due to tempfile issue.") - def test_mask_03_fname(self): - def get_data(data): - if isinstance(data, InteractiveList): - return data[0] - else: - return data - - data = get_data(self.data) - mask = data.copy(data=np.ones_like(data, dtype=bool)) - mask[..., 3] = False - with tempfile.TemporaryDirectory(prefix="psyplot_") as tmpdir: - maskfile = os.path.join(tmpdir, "mask.nc") - mask.drop_vars(set(mask.coords) - set(mask.dims)).to_netcdf( - maskfile - ) - self.update(mask=maskfile) - self.assertTrue( - np.all(get_data(self.plotter.plot_data).isnull()[..., 3]) - ) - - def test_append_data(self): - """Test appending new data to the list""" - - def get_color(artist): - try: - ret = artist.get_color() - except AttributeError: - try: - ret = artist.get_facecolor() - except AttributeError: - ret = artist[0].get_facecolor() - return mcol.to_rgba(ret) - - data = self.data - n = len(data) - self.assertEqual(len(self.plotter.plot_data), n) - old_c = mcol.to_rgba(self.plotter.color.colors[-1]) - self.assertEqual(get_color(self.plotter.plot._plot[-1]), old_c) - - try: - # append data - new = data[-1].psy.copy() - data.append(new, new_name=True) - self.assertEqual(len(data), n + 1) - self.plotter.update(replot=True) - self.assertEqual(len(self.plotter.plot_data), n + 1) - c = mcol.to_rgba(self.plotter.color.colors[-1]) - self.assertNotEqual(c, old_c) - self.assertEqual(get_color(self.plotter.plot._plot[-1]), c) - - # remove data again - data.pop(-1) - self.plotter.update(replot=True) - self.assertEqual(len(self.plotter.plot_data), n) - self.assertEqual(get_color(self.plotter.plot._plot[-1]), old_c) - - # append data again - data.append(new, new_name=True) - self.plotter.update(replot=True) - self.assertEqual(len(self.plotter.plot_data), n + 1) - self.assertEqual(get_color(self.plotter.plot._plot[-1]), c) - finally: - if len(data) > n: - data.pop(-1) - - def test_plot_stacked_transposed(self, *args): - """Test plot formatoption with ``'areax'``""" - self.update(plot="stacked", transpose=True) - self.compare_figures( - next(iter(args), self.get_ref_file("plot_stacked_transposed")) - ) - - def test_coord(self): - """Test whether we can use an alternative coordinate""" - self.update(coord="v", xlabel="%(name)s") - self.assertEqual( - self.plotter.ax.get_xlabel(), - "v", - msg="Did not update to the right coordinate!", - ) - - @unittest.skipIf( - mpl_version == 3.3, - "Updating grids is known to malfunction for matplotlib 3.3!", - ) - def test_grid(self, *args): - """Test grid formatoption""" - args = iter(args) - self.update(grid=True) - self.compare_figures(next(args, self.get_ref_file("grid1"))) - self.update(grid="b") - self.compare_figures(next(args, self.get_ref_file("grid2"))) - - def test_xlabel(self): - """Test xlabel formatoption""" - self.update(xlabel="{desc}") - label = self.plotter.ax.xaxis.get_label() - self.assertEqual(label.get_text(), "longitude [degrees_east]") - self.update( - labelsize=22, labelweight="bold", labelprops={"ha": "left"} - ) - self.assertEqual(label.get_size(), 22) - self.assertEqual(label.get_weight(), bold) - self.assertEqual(label.get_ha(), "left") - - def test_ylabel(self): - """Test ylabel formatoption""" - self.update(ylabel="{desc}") - label = self.plotter.ax.yaxis.get_label() - self.assertEqual(label.get_text(), "Temperature [K]") - self.update( - labelsize=22, labelweight="bold", labelprops={"ha": "left"} - ) - self.assertEqual(label.get_size(), 22) - self.assertEqual(label.get_weight(), bold) - self.assertEqual(label.get_ha(), "left") - - def test_xlim(self): - """Test xlim formatoption""" - curr_lim = self.plotter.ax.get_xlim() - self.update(xlim=(-1, 300)) - self.assertEqual(self.plotter.ax.get_xlim(), (-1, 300)) - self.update(xlim=(-1, "rounded")) - self.assertEqual(self.plotter.ax.get_xlim(), (-1, curr_lim[1])) - - def test_ylim(self, test_pctls=True): - """Test ylim formatoption""" - curr_lim = self.plotter.ax.get_ylim() - self.update(ylim=(-1, 300)) - self.assertEqual(self.plotter.ax.get_ylim(), (-1, 300)) - self.update(ylim=(-1, "rounded")) - self.assertEqual(self.plotter.ax.get_ylim(), (-1, curr_lim[1])) - if test_pctls: - self.update(ylim=(["minmax", 25], ["minmax", 75])) - data = self.data.to_dataframe() - arr = data[data.notnull()].values - self.assertAlmostArrayEqual( - self.plotter.ax.get_ylim(), - np.percentile(arr, [25, 75]).tolist(), - ) - - def test_sym_lims(self): - ax = self.plotter.ax - xrange = ax.get_xlim() - yrange = ax.get_ylim() - mins = [min(xrange[0], yrange[0]), min(xrange[1], yrange[1])] - maxs = [max(xrange[0], yrange[0]), max(xrange[1], yrange[1])] - - self.update(sym_lims="min") - self.assertEqual(ax.get_xlim()[0], mins[0]) - self.assertEqual(ax.get_xlim()[1], mins[1]) - self.assertEqual(ax.get_ylim()[0], mins[0]) - self.assertEqual(ax.get_ylim()[1], mins[1]) - - self.update(sym_lims="max") - self.assertEqual(ax.get_xlim()[0], maxs[0]) - self.assertEqual(ax.get_xlim()[1], maxs[1]) - self.assertEqual(ax.get_ylim()[0], maxs[0]) - self.assertEqual(ax.get_ylim()[1], maxs[1]) - - self.update(sym_lims=["min", "max"]) - self.assertEqual(ax.get_xlim()[0], mins[0]) - self.assertEqual(ax.get_xlim()[1], maxs[1]) - self.assertEqual(ax.get_ylim()[0], mins[0]) - self.assertEqual(ax.get_ylim()[1], maxs[1]) - - self.update(sym_lims=[None, "max"]) - self.assertEqual(ax.get_xlim()[0], xrange[0]) - self.assertEqual(ax.get_xlim()[1], maxs[1]) - self.assertEqual(ax.get_ylim()[0], yrange[0]) - self.assertEqual(ax.get_ylim()[1], maxs[1]) - - def test_color(self): - colors = ["y", "g"][: len(self.data)] - current_colors = [l.get_color() for l in self.plotter.ax.lines] - self.update(color=colors) - self.assertEqual( - [l.get_color() for l in self.plotter.ax.lines], colors - ) - self.update(color=None) - self.assertEqual( - [l.get_color() for l in self.plotter.ax.lines], current_colors - ) - - def test_transpose(self, *args): - """Test transpose formatoption""" - args = iter(args) - self.compare_figures(next(args, self.get_ref_file("transpose1"))) - self.update(transpose=True) - self.compare_figures(next(args, self.get_ref_file("transpose2"))) - - def test_legend(self, *args): - """Test legend and legendlabels formatoption""" - args = iter(args) - self.update(legend=False) - self.assertIsNone(self.plotter.ax.legend_) - self.update( - legend={ - "loc": "upper center", - "bbox_to_anchor": (0.5, -0.05), - "ncol": 2, - } - ) - self.compare_figures(next(args, self.get_ref_file("legend"))) - self.update(legendlabels="%(lat)s") - self.assertAlmostArrayEqual( - [float(t.get_text()) for t in plt.gca().legend_.get_texts()], - [da.lat.values for da in self.data], - ) - - def test_xticks(self, *args): - """Test xticks, xticklabels, xtickprops formatoptions""" - self._test_DataTicksCalculator() - self._test_DtTicksBase(*args) - - _max_rounded_ref = 400 - - def _test_DataTicksCalculator(self): - # testing of psy_simple.plotters.DataTicksCalculator - self.update(xticks=["data", 2]) - ax = plt.gca() - if isinstance(self.data, InteractiveList): - data = self.data[0] - else: - data = self.data - - lon = data.lon.values - - self.assertEqual(list(ax.get_xticks()), list(lon[::2])) - self.update(xticks=["mid", 2]) - - self.assertEqual( - list(ax.get_xticks()), list((lon[:-1] + lon[1:]) / 2.0)[::2] - ) - self.update(xticks="rounded") - self.assertEqual( - list(ax.get_xticks()), - np.linspace(0, self._max_rounded_ref, 11, endpoint=True).tolist(), - ) - self.update(xticks="roundedsym") - self.assertEqual( - list(ax.get_xticks()), - np.linspace( - -self._max_rounded_ref, - self._max_rounded_ref, - 10, - endpoint=True, - ).tolist(), - ) - self.update(xticks="minmax") - self.assertEqual( - list(ax.get_xticks()), - np.linspace(lon.min(), lon.max(), 11, endpoint=True).tolist(), - ) - self.update(xticks="sym") - self.assertEqual( - list(ax.get_xticks()), - np.linspace(-lon.max(), lon.max(), 10, endpoint=True).tolist(), - ) - - # apparently matplotlib changed how they numerically represent the - # date ticks. Therefore we enable multiple options. - ref_dt_vals = { - "month": [ - {3361.25, 3331.75, 3422.25, 3391.75}, - {722494.75, 722524.25, 722554.75, 722585.25}, - ], - "monthbegin": [ - {722450.75, 722481.75, 722509.75, 722540.75, 722570.75, 722601.75}, - {3438.75, 3407.75, 3377.75, 3346.75, 3318.75, 3287.75}, - ], - "monthend": [ - {722480.75, 722508.75, 722539.75, 722569.75, 722600.75}, - {3437.75, 3406.75, 3376.75, 3345.75, 3317.75}, - ], - "week": { - 722487.75, - 722494.75, - 722501.75, - 722508.75, - 722515.75, - 722522.75, - 722529.75, - 722536.75, - 722543.75, - 722550.75, - 722557.75, - 722564.75, - 722571.75, - 722578.75, - 722585.75, - 722592.75, - 722599.75, - }, - } - - def _test_DtTicksBase(self, *args): - # testing of psy_simple.plotters.DtTicksBase - args = iter(args) - data = InteractiveList.from_dataset( - self.data[0].psy.base, - y=[0, 1], - z=0, - x=0, - name=self.var, - auto_update=True, - ) - plotter = self.plotter.__class__(data) - ax = plotter.ax - xticks = {"major": ax.get_xticks(), "minor": ax.get_xticks(minor=True)} - plotter.update(xticks="month") - self.assertIn(set(ax.get_xticks()), self.ref_dt_vals["month"]) - plotter.update(xticks="monthbegin") - self.assertIn(set(ax.get_xticks()), self.ref_dt_vals["monthbegin"]) - plotter.update(xticks="monthend") - self.assertIn(set(ax.get_xticks()), self.ref_dt_vals["monthend"]) - plotter.update(xticks="month", xticklabels="%m") - # sometimes the labels are only set after drawing - if ax.get_xticklabels()[0].get_text(): - self.assertEqual( - [int(t.get_text()) for t in ax.get_xticklabels()[:]], - list(range(2, 6)), - ) - plotter.update( - xticks={"minor": "week"}, - xticklabels={"minor": "%d"}, - xtickprops={"pad": 7.0}, - ) - ticks = np.asarray(ax.get_xticks(minor=True)) - self.assertLessEqual( - set(ticks[(ticks >= 722487.75) & (ticks <= 722599.75)].tolist()), - self.ref_dt_vals["week"], - ) - self.compare_figures(next(args, self.get_ref_file("xticks"))) - plotter.update(xticks={"major": None, "minor": None}) - self.assertEqual(list(ax.get_xticks()), list(xticks["major"])) - self.assertEqual( - list(ax.get_xticks(minor=True)), list(xticks["minor"]) - ) - - def test_tick_rotation(self): - """Test xrotation and yrotation formatoption""" - self.update(xrotation=90, yrotation=90) - self.assertTrue( - all( - t.get_rotation() == 90 - for t in self.plotter.ax.get_xticklabels() - ) - ) - self.assertTrue( - all( - t.get_rotation() == 90 - for t in self.plotter.ax.get_yticklabels() - ) - ) - - def test_ticksize(self): - """Tests ticksize formatoption""" - self.update(ticksize=24) - ax = self.plotter.ax - self.assertTrue( - all( - t.get_size() == 24 - for t in chain(ax.get_xticklabels(), ax.get_yticklabels()) - ) - ) - self.update( - xticks={"major": ["data", 40], "minor": ["data", 10]}, - ticksize={"major": 12, "minor": 10}, - xtickprops={"pad": 7.0}, - ) - self.assertTrue( - all( - t.get_size() == 12 - for t in chain(ax.get_xticklabels(), ax.get_yticklabels()) - ) - ) - self.assertTrue( - all(t.get_size() == 10 for t in ax.get_xticklabels(minor=True)) - ) - - def test_axiscolor(self): - """Test axiscolor formatoption""" - ax = self.plotter.ax - positions = ["top", "right", "left", "bottom"] - # test updating all to red - self.update(axiscolor="red") - self.assertEqual( - ["red"] * 4, - list(self.plotter["axiscolor"].values()), - "Edgecolors are not red but " - + ", ".join(self.plotter["axiscolor"].values()), - ) - # test updating all to the default setup - self.update(axiscolor=None) - for pos in positions: - error = "Edgecolor ({0}) is not the default color ({1})!".format( - ax.spines[pos].get_edgecolor(), mpl.rcParams["axes.edgecolor"] - ) - self.assertEqual( - mpl.colors.colorConverter.to_rgba( - mpl.rcParams["axes.edgecolor"] - ), - ax.spines[pos].get_edgecolor(), - msg=error, - ) - error = "Linewidth ({0}) is not the default width ({1})!".format( - ax.spines[pos].get_linewidth(), mpl.rcParams["axes.linewidth"] - ) - self.assertEqual( - mpl.rcParams["axes.linewidth"], - ax.spines[pos].get_linewidth(), - msg=error, - ) - # test updating only one spine - self.update(axiscolor={"top": "red"}) - self.assertEqual( - (1.0, 0.0, 0.0, 1.0), - ax.spines["top"].get_edgecolor(), - msg="Axiscolor ({0}) has not been updated".format( - ax.spines["top"].get_edgecolor() - ), - ) - self.assertGreater( - ax.spines["top"].get_linewidth(), 0.0, "Line width of axis is 0!" - ) - for pos in positions[1:]: - error = "Edgecolor ({0}) is not the default color ({1})!".format( - ax.spines[pos].get_edgecolor(), mpl.rcParams["axes.edgecolor"] - ) - self.assertEqual( - mpl.colors.colorConverter.to_rgba( - mpl.rcParams["axes.edgecolor"] - ), - ax.spines[pos].get_edgecolor(), - msg=error, - ) - - -class LinePlotterTest2D(tb.TestBase2D, LinePlotterTest): - """Test :class:`psy_simple.plotters.LinePlotter` class without - time and vertical dimension""" - - var = "t2m_2d" - - def test_xticks(self, *args): - """Test xticks, xticklabels, xtickprops formatoptions""" - self._test_DataTicksCalculator() - - def test_coord(self): - """Test whether we can use an alternative coordinate""" - self.update(coord="v_2d", xlabel="%(name)s") - self.assertEqual( - self.plotter.ax.get_xlabel(), - "v_2d", - msg="Did not update to the right coordinate!", - ) - - -# skip the reference creation functions of the 2D Plotter tests -skip_msg = ( - "Reference figures for this class are created by the " "LinePlotterTest" -) -for funcname in filter(lambda s: s.startswith("ref"), dir(LinePlotterTest2D)): - setattr( - LinePlotterTest2D, funcname, unittest.skip(skip_msg)(lambda self: None) - ) diff --git a/tests/test_lineplot_single.py b/tests/test_lineplot_single.py deleted file mode 100755 index f9cc3c51..00000000 --- a/tests/test_lineplot_single.py +++ /dev/null @@ -1,73 +0,0 @@ -"""Test module of the :mod:`psy_simple.plotters` module""" - -# Disclaimer -# ---------- -# -# Copyright (C) 2021 Helmholtz-Zentrum Hereon -# Copyright (C) 2020-2021 Helmholtz-Zentrum Geesthacht -# Copyright (C) 2016-2021 University of Lausanne -# -# This file is part of psy-simple and is released under the GNU LGPL-3.O license. -# See COPYING and COPYING.LESSER in the root of the repository for full -# licensing details. -# -# This program is free software: you can redistribute it and/or modify -# it under the terms of the GNU Lesser General Public License version 3.0 as -# published by the Free Software Foundation. -# -# 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 LGPL-3.0 license for more details. -# -# You should have received a copy of the GNU LGPL-3.0 license -# along with this program. If not, see . - -import unittest - -from psy_simple.plotters import LinePlotter - -import psyplot.project as psy - -import test_lineplot as tl -from psyplot import InteractiveList, open_dataset - - -class SingleLinePlotterTest(tl.LinePlotterTest): - """Test of :class:`psy_simple.plotters.LinePlotter` with a single array - instead of an InteractiveList""" - - plot_type = "singleline" - - @classmethod - def setUpClass(cls): - cls.ds = open_dataset(cls.ncfile) - cls.data = InteractiveList.from_dataset( - cls.ds, y=0, z=0, t=0, name=cls.var, auto_update=True - ) - cls.data[0].psy.arr_name = "arr0" - cls.data.psy.arr_name = "arr0" - cls.plotter = LinePlotter(cls.data[0]) - cls.create_dirs() - - @classmethod - def tearDown(cls): - cls.data[0].psy.update(t=0, todefault=True, replot=True) - - def plot(self, **kwargs): - name = kwargs.pop("name", self.var) - return psy.plot.lineplot( - self.ncfile, name=name, t=0, z=0, y=0, **kwargs - ) - - @unittest.skip("No need for figure creation") - def ref_plot_None(self, *args): - pass - - @unittest.skip("No need for figure creation") - def test_plot_None(self, *args): - pass - - @unittest.skip("Appending not possible for single line") - def test_append_data(self): - pass diff --git a/tests/test_plot2d.py b/tests/test_plot2d.py deleted file mode 100644 index 13615db5..00000000 --- a/tests/test_plot2d.py +++ /dev/null @@ -1,464 +0,0 @@ -"""Test module for 2D plots.""" - -# Disclaimer -# ---------- -# -# Copyright (C) 2021 Helmholtz-Zentrum Hereon -# Copyright (C) 2020-2021 Helmholtz-Zentrum Geesthacht -# Copyright (C) 2016-2021 University of Lausanne -# -# This file is part of psy-simple and is released under the GNU LGPL-3.O license. -# See COPYING and COPYING.LESSER in the root of the repository for full -# licensing details. -# -# This program is free software: you can redistribute it and/or modify -# it under the terms of the GNU Lesser General Public License version 3.0 as -# published by the Free Software Foundation. -# -# 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 LGPL-3.0 license for more details. -# -# You should have received a copy of the GNU LGPL-3.0 license -# along with this program. If not, see . - -import os -import unittest -import pytest - -import numpy as np -import xarray as xr -import matplotlib.pyplot as plt - -from psyplot import open_dataset, ArrayList -import psyplot.project as psy -from psy_simple.plotters import Simple2DPlotter - -import _base_testing as bt -import test_base as tb -import test_lineplot as tl - - -bold = tb.bold - - -class References2D(object): - """abstract base class that defines reference methods for 2D plotter""" - - def ref_datagrid(self, close=True): - """Create reference file for datagrid formatoption - - Create reference file for - :attr:`~psy_simple.plotters.Simple2DPlotter.datagrid` - formatoption""" - kwargs = dict(xlim=(0, 40), ylim=(0, 40)) - sp = self.plot(**kwargs) - sp.update(datagrid="k-") - sp.export(os.path.join(bt.ref_dir, self.get_ref_file("datagrid"))) - if close: - sp.close(True, True) - - def ref_cmap(self, close=True): - """Create reference file for cmap formatoption. - - Create reference file for - :attr:`~psy_simple.plotters.Simple2DPlotter.cmap` - formatoption""" - sp = self.plot(cmap="RdBu") - sp.export(os.path.join(bt.ref_dir, self.get_ref_file("cmap"))) - if close: - sp.close(True, True) - - def ref_cbar(self, close=True): - """Create reference file for cbar formatoption. - - Create reference file for - :attr:`~psy_simple.plotters.Simple2DPlotter.cbar` - formatoption""" - sp = self.plot(cbar=["fb", "fr", "fl", "ft", "b", "r"]) - sp.export(os.path.join(bt.ref_dir, self.get_ref_file("cbar"))) - if close: - sp.close(True, True) - - def ref_miss_color(self, close=True): - """Create reference file for miss_color formatoption. - - Create reference file for - :attr:`~psy_simple.plotters.Simple2DPlotter.miss_color` - formatoption""" - if self.plot_type[:3] == "map": - kwargs = {"projection": "ortho", "grid_labels": False} - else: - kwargs = {} - sp = self.plot(maskless=280, miss_color="0.9", **kwargs) - sp.export(os.path.join(bt.ref_dir, self.get_ref_file("miss_color"))) - if close: - sp.close(True, True) - - def ref_cbarspacing(self, close=True): - """Create reference file for cbarspacing formatoption. - - Create reference file for - :attr:`~psy_simple.plotters.Simple2DPlotter.cbarspacing` - formatoption""" - if self.plot_type.endswith("vector") or getattr( - self, "vector_mode", False - ): - kwargs = dict( - bounds=np.arange(0, 1.45, 0.1).tolist() - + np.linspace(1.5, 13.5, 7, endpoint=True).tolist() - + np.arange(13.6, 15.05, 0.1).tolist(), - color="absolute", - ) - else: - kwargs = dict( - bounds=list(range(235, 250)) - + np.linspace(250, 295, 7, endpoint=True).tolist() - + list(range(296, 310)) - ) - sp = self.plot(cbarspacing="proportional", cticks="rounded", **kwargs) - sp.export(os.path.join(bt.ref_dir, self.get_ref_file("cbarspacing"))) - if close: - sp.close(True, True) - - -class Simple2DPlotterTest(tl.LinePlotterTest, References2D): - """Test :class:`psyplot.plotter.maps.Simple2DPlotter` class""" - - plot_type = "simple2D" - - def plot(self, **kwargs): - name = kwargs.pop("name", self.var) - return psy.plot.plot2d(self.ncfile, name=name, **kwargs) - - @classmethod - def setUpClass(cls): - cls.ds = open_dataset(cls.ncfile) - cls.data = ArrayList.from_dataset( - cls.ds, t=0, z=0, name=cls.var, auto_update=True - )[0] - cls.plotter = Simple2DPlotter(cls.data) - cls.create_dirs() - - @unittest.skip("legend formatoption not implemented for 2D-Plotter") - def ref_legend(self, *args, **kwargs): - pass - - @unittest.skip("no need for xticks formatoption reference for 2D-Plotter") - def ref_xticks(self, *args, **kwargs): - pass - - @unittest.skip("color formatoption not implemented for 2D-Plotter") - def test_color(self): - pass - - @unittest.skip("Not implemented for 2D-Plotter") - def test_coord(self): - pass - - @unittest.skip("Not implemented for 2D-Plotter") - def ref_plot_area(self, close=True): - pass - - @unittest.skip("Not implemented for 2D-Plotter") - def ref_plot_areax(self, close=True): - pass - - @unittest.skip("No need for figure creation") - def ref_plot_None(self, *args): - pass - - @unittest.skip("No need for figure creation") - def ref_plot_stacked(self, close=True): - pass - - @unittest.skip("No need for figure creation") - def ref_plot_stacked_transposed(self, close=True): - pass - - @unittest.skip("Not implemented for 2D-Plotter") - def test_plot_area(self, *args): - pass - - @unittest.skip("Not implemented for 2D-Plotter") - def test_plot_areax(self, *args): - pass - - @unittest.skip("No need for figure creation") - def test_plot_None(self, *args): - pass - - @unittest.skip("Appending not possible for plot2d") - def test_append_data(self): - pass - - @unittest.skip("No need for figure creation") - def test_plot_stacked(self, close=True): - pass - - @unittest.skip("No need for figure creation") - def test_plot_stacked_transposed(self, close=True): - pass - - def test_ylabel(self): - """Test ylabel formatoption""" - self.update(ylabel="{desc}") - label = self.plotter.ax.yaxis.get_label() - self.assertEqual(label.get_text(), "latitude [degrees_north]") - self.update( - labelsize=22, labelweight="bold", labelprops={"ha": "left"} - ) - self.assertEqual(label.get_size(), 22) - self.assertEqual(label.get_weight(), bold) - self.assertEqual(label.get_ha(), "left") - - def test_xticks(self): - """Test xticks formatoption""" - self._test_DataTicksCalculator() - - def test_extend(self): - """Test extend formatoption""" - self.update(extend="both") - self.assertEqual(self.plotter.cbar.cbars["b"].extend, "both") - self.update(extend="min") - self.assertEqual(self.plotter.cbar.cbars["b"].extend, "min") - self.update(extend="neither") - self.assertEqual(self.plotter.cbar.cbars["b"].extend, "neither") - - def test_legend(self): - pass - - def test_cticks(self): - """Test cticks, cticksize, ctickweight, ctickprops formatoptions""" - cticks = self._minmax_cticks - self.update(cticks="minmax") - cbar = self.plotter.cbar.cbars["b"] - self.assertEqual( - list( - map(lambda t: float(t.get_text()), cbar.ax.get_xticklabels()) - ), - cticks, - ) - self.update(cticklabels="%3.1f") - cticks = np.round(cticks, decimals=1).tolist() - self.assertAlmostArrayEqual( - list( - map(lambda t: float(t.get_text()), cbar.ax.get_xticklabels()) - ), - cticks, - atol=0.1, - ) - self.update( - cticksize=20, ctickweight=bold, ctickprops={"labelcolor": "r"} - ) - texts = cbar.ax.get_xticklabels() - n = len(texts) - self.assertEqual([t.get_weight() for t in texts], [bold] * n) - self.assertEqual([t.get_size() for t in texts], [20] * n) - self.assertEqual([t.get_color() for t in texts], ["r"] * n) - - @property - def _minmax_cticks(self): - return np.round( - np.linspace( - self.data.values.min(), - self.data.values.max(), - 11, - endpoint=True, - ), - decimals=2, - ).tolist() - - def test_clabel(self): - """Test clabel, clabelsize, clabelweight, clabelprops formatoptions""" - - def get_clabel(): - return self.plotter.cbar.cbars["b"].ax.xaxis.get_label() - - self._label_test("clabel", get_clabel) - label = get_clabel() - self.update( - clabelsize=22, clabelweight="bold", clabelprops={"ha": "left"} - ) - self.assertEqual(label.get_size(), 22) - self.assertEqual(label.get_weight(), bold) - self.assertEqual(label.get_ha(), "left") - - def test_datagrid(self, *args): - """Test datagrid formatoption""" - self.update(xlim=(0, 40), ylim=(0, 40), datagrid="k-") - self.compare_figures(next(iter(args), self.get_ref_file("datagrid"))) - - def test_cmap(self, *args): - """Test colormap (cmap) formatoption""" - self.update(cmap="RdBu") - fname = next(iter(args), self.get_ref_file("cmap")) - self.compare_figures(fname) - self.update(cmap=plt.get_cmap("RdBu")) - self.compare_figures(fname) - - def test_cbar(self, *args): - """Test colorbar (cbar) formatoption""" - self.update(cbar=["fb", "fr", "fl", "ft", "b", "r"]) - self.compare_figures(next(iter(args), self.get_ref_file("cbar"))) - - def test_bounds(self): - """Test bounds formatoption""" - self.assertEqual( - np.round(self.plotter.bounds.norm.boundaries, 2).tolist(), - np.linspace(235, 310, 11, endpoint=True).tolist(), - ) - self.update(bounds="minmax") - bounds = [ - 239.91, - 246.89, - 253.88, - 260.87, - 267.86, - 274.84, - 281.83, - 288.82, - 295.81, - 302.79, - 309.78, - ] - self.assertEqual( - np.round(self.plotter.bounds.norm.boundaries, 2).tolist(), bounds - ) - self.update(bounds=["rounded", 5, 5, 95]) - self.assertEqual( - np.round(self.plotter.bounds.norm.boundaries, 2).tolist(), - np.linspace(245, 300, 5, endpoint=True).tolist(), - ) - - def test_miss_color(self, *args): - """Test miss_color formatoption""" - self.update(maskless=280, miss_color="0.9") - self.compare_figures(next(iter(args), self.get_ref_file("miss_color"))) - - def test_cbarspacing(self, *args): - """Test cbarspacing formatoption""" - self.update( - cbarspacing="proportional", - cticks="rounded", - bounds=list(range(235, 250)) - + np.linspace(250, 295, 7, endpoint=True).tolist() - + list(range(296, 310)), - ) - self.compare_figures( - next(iter(args), self.get_ref_file("cbarspacing")) - ) - - def test_ylim(self): - """Test ylim formatoption""" - super(Simple2DPlotterTest, self).test_ylim(test_pctls=False) - - -@pytest.mark.parametrize("vmin,vmax", [(1, int(1e2)), (int(-10), int(1e2))]) -def test_log_bounds(vmin, vmax): - ds = xr.Dataset() - ds["test"] = (("y", "x"), np.random.randint(vmin, vmax, (40, 50)) * 1e-3) - vmin *= 10e-3 - vmax *= 10e-3 - ds["x"] = ("x", np.arange(50)) - ds["y"] = ("y", np.arange(40)) - - sp = ds.psy.plot.plot2d(bounds="log") - plotter = sp.plotters[0] - - assert len(plotter.bounds.norm.boundaries) in [10, 11, 12] - assert np.isclose( - plotter.bounds.norm.boundaries[0], [vmin, vmin * 0.1, vmin * 10] - ).any() - assert np.isclose( - plotter.bounds.norm.boundaries[-1], [vmax, vmax * 0.1, vmax * 10] - ).any() - - -def test_symlog_bounds(): - vmin = -1 - vmax = 100 - ds = xr.Dataset() - ds["test"] = (("y", "x"), np.random.randint(vmin, vmax, (40, 50)) * 1e-3) - vmin *= 10e-3 - vmax *= 10e-3 - ds["x"] = ("x", np.arange(50)) - ds["y"] = ("y", np.arange(40)) - - sp = ds.psy.plot.plot2d(bounds="symlog") - plotter = sp.plotters[0] - - assert len(plotter.bounds.norm.boundaries) in [12, 13, 14] - assert plotter.bounds.norm.boundaries[0] == pytest.approx(-0.1) - assert plotter.bounds.norm.boundaries[-1] == pytest.approx(0.1) - - -class Simple2DPlotterTestArtificial(unittest.TestCase): - """A test case for artifial data""" - - def test_single_level(self): - """Test the case when all the data contains exactly one value""" - ds = xr.Dataset() - ds["test"] = (("y", "x"), np.ones((4, 5))) - sp = ds.psy.plot.plot2d(cmap="Reds", bounds=["rounded", 3]) - self.assertEqual(list(sp.plotters[0].bounds.bounds), [1.0, 1.0, 1.0]) - - -@pytest.mark.parametrize( - "old,new", - (("tri", "poly"), ("tricontour", "contour"), ("tricontourf", "contourf")), -) -def test_plot_deprecation(old, new): - """Test if tri is deprecated correctly""" - with psy.open_dataset(os.path.join(bt.test_dir, "icon_test.nc")) as ds: - with pytest.warns(DeprecationWarning, match="plot=[\"']%s[\"']" % old): - sp = ds.psy.plot.plot2d(name="t2m", plot=old) - plotter = sp.plotters[0] - assert plotter.plot.value == new - - -def test_plot_poly_3D_bounds(): - """Test plotting the polygons with 3D bounds.""" - fname = os.path.join(bt.test_dir, "rotated-pole-test.nc") - with psy.plot.plot2d(fname, plot="poly") as sp: - assert sp[0].ndim == 2 - plotter = sp.plotters[0] - xmin, xmax = plotter.ax.get_xlim() - ymin, ymax = plotter.ax.get_ylim() - assert xmax - xmin > 100 - assert ymax - ymin > 50 - - -def test_datagrid_3D_bounds(): - """Test plotting the datagrid with 3D bounds.""" - fname = os.path.join(bt.test_dir, "rotated-pole-test.nc") - with psy.plot.plot2d(fname, datagrid="k-") as sp: - assert sp[0].ndim == 2 - plotter = sp.plotters[0] - xmin, xmax = plotter.ax.get_xlim() - ymin, ymax = plotter.ax.get_ylim() - assert xmax - xmin > 100 - assert ymax - ymin > 50 - - -class Simple2DPlotterTest2D(tb.TestBase2D, Simple2DPlotterTest): - """Test :class:`psy_simple.plotters.Simple2DPlotter` class without - time and vertical dimension""" - - var = "t2m_2d" - - -# skip the reference creation functions of the 2D Plotter tests -skip_msg = ( - "Reference figures for this class are created by the " - "Simple2DPlotterTest" -) -for funcname in filter( - lambda s: s.startswith("ref"), dir(Simple2DPlotterTest2D) -): - setattr( - Simple2DPlotterTest2D, - funcname, - unittest.skip(skip_msg)(lambda self: None), - ) diff --git a/tests/test_plot2d_contour.py b/tests/test_plot2d_contour.py deleted file mode 100644 index 99a3476b..00000000 --- a/tests/test_plot2d_contour.py +++ /dev/null @@ -1,54 +0,0 @@ -"""Test module for the simple contour plot.""" - -# Disclaimer -# ---------- -# -# Copyright (C) 2021 Helmholtz-Zentrum Hereon -# Copyright (C) 2020-2021 Helmholtz-Zentrum Geesthacht -# Copyright (C) 2016-2021 University of Lausanne -# -# This file is part of psy-simple and is released under the GNU LGPL-3.O license. -# See COPYING and COPYING.LESSER in the root of the repository for full -# licensing details. -# -# This program is free software: you can redistribute it and/or modify -# it under the terms of the GNU Lesser General Public License version 3.0 as -# published by the Free Software Foundation. -# -# 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 LGPL-3.0 license for more details. -# -# You should have received a copy of the GNU LGPL-3.0 license -# along with this program. If not, see . - -import unittest - -from psyplot import rcParams -from psy_simple.plotters import Simple2DPlotter - -import test_plot2d as t2d - - -class Simple2DPlotterContourTest(t2d.Simple2DPlotterTest): - - plot_type = 'simple2D_contour' - - @classmethod - def setUpClass(cls): - plotter = Simple2DPlotter() - rcParams[plotter.plot.default_key] = 'contourf' - super(Simple2DPlotterContourTest, cls).setUpClass() - - @unittest.skip('Extend keyword not implemented') - def test_extend(self): - pass - - @unittest.skip('miss_color keyword not implemented') - def test_miss_color(self): - pass - - @unittest.skip('miss_color keyword not implemented') - def ref_miss_color(self): - pass diff --git a/tests/test_plot2d_icon.py b/tests/test_plot2d_icon.py deleted file mode 100644 index f317cda5..00000000 --- a/tests/test_plot2d_icon.py +++ /dev/null @@ -1,158 +0,0 @@ -"""Test module for the 2D plot of icon files.""" - -# Disclaimer -# ---------- -# -# Copyright (C) 2021 Helmholtz-Zentrum Hereon -# Copyright (C) 2020-2021 Helmholtz-Zentrum Geesthacht -# Copyright (C) 2016-2021 University of Lausanne -# -# This file is part of psy-simple and is released under the GNU LGPL-3.O license. -# See COPYING and COPYING.LESSER in the root of the repository for full -# licensing details. -# -# This program is free software: you can redistribute it and/or modify -# it under the terms of the GNU Lesser General Public License version 3.0 as -# published by the Free Software Foundation. -# -# 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 LGPL-3.0 license for more details. -# -# You should have received a copy of the GNU LGPL-3.0 license -# along with this program. If not, see . - -import os - -import numpy as np -import matplotlib.pyplot as plt - -from psyplot import InteractiveList - -import _base_testing as bt -import test_base as tb -import test_plot2d as t2d - -bold = tb.bold - - -class IconTestMixin(object): - """A mixin class for changed test methods for icon""" - - def ref_datagrid(self, close=True): - """Create reference file for datagrid formatoption - - Create reference file for - :attr:`~psy_simple.plotters.Simple2DPlotter.datagrid` - formatoption""" - sp = self.plot() - sp.update(datagrid="k-") - sp.export(os.path.join(bt.ref_dir, self.get_ref_file("datagrid"))) - if close: - sp.close(True, True) - - def test_datagrid(self, *args): - """Test datagrid formatoption""" - self.update(datagrid="k-") - self.compare_figures(next(iter(args), self.get_ref_file("datagrid"))) - - def test_xlabel(self): - """Test xlabel formatoption""" - self.update(xlabel="{desc}") - label = self.plotter.ax.xaxis.get_label() - self.assertIn("longitude [radian]", label.get_text()) - self.update( - labelsize=22, labelweight="bold", labelprops={"ha": "left"} - ) - self.assertEqual(label.get_size(), 22) - self.assertEqual(label.get_weight(), bold) - self.assertEqual(label.get_ha(), "left") - - def test_ylabel(self): - """Test ylabel formatoption""" - self.update(ylabel="{desc}") - label = self.plotter.ax.yaxis.get_label() - self.assertIn("latitude [radian]", label.get_text()) - self.update( - labelsize=22, labelweight="bold", labelprops={"ha": "left"} - ) - self.assertEqual(label.get_size(), 22) - self.assertEqual(label.get_weight(), bold) - self.assertEqual(label.get_ha(), "left") - - def _test_DataTicksCalculator(self): - # testing of psy_simple.plotters.DataTicksCalculator - - ax = plt.gca() - if isinstance(self.data, InteractiveList): - data = self.data[0] - else: - data = self.data - - try: - lon = data.clon.values - except AttributeError: - lon = data.elon.values - - self.update(xticks="rounded") - self.assertEqual( - list(ax.get_xticks()), - np.linspace(-3, 3.5, 11, endpoint=True).tolist(), - ) - self.update(xticks="roundedsym") - self.assertEqual( - list(ax.get_xticks()), - np.linspace(-3.5, 3.5, 10, endpoint=True).tolist(), - ) - self.update(xticks="minmax") - self.assertEqual( - list(ax.get_xticks()), - np.linspace(lon.min(), lon.max(), 11, endpoint=True).tolist(), - ) - self.update(xticks="sym") - vmax = np.abs(lon).max() - self.assertEqual( - list(ax.get_xticks()), - np.linspace(-vmax, vmax, 10, endpoint=True).tolist(), - ) - - -class IconSimplePlotterTest(IconTestMixin, t2d.Simple2DPlotterTest): - """Test :class:`psy_simple.plotters.Simple2DPlotter` class for icon grid""" - - grid_type = "icon" - - masking_val = 280 - - ncfile = os.path.join(bt.test_dir, "icon_test.nc") - - def test_bounds(self): - """Test bounds formatoption""" - self.assertEqual( - np.round(self.plotter.bounds.norm.boundaries, 2).tolist(), - np.linspace(240, 310, 11, endpoint=True).tolist(), - ) - self.update(bounds="minmax") - bounds = [ - 243.76, - 250.04, - 256.31, - 262.58, - 268.85, - 275.12, - 281.39, - 287.66, - 293.94, - 300.21, - 306.48, - ] - self.assertEqual( - np.round(self.plotter.bounds.norm.boundaries, 2).tolist(), bounds - ) - self.update(bounds=["rounded", 5, 5, 95]) - self.assertEqual( - np.round(self.plotter.bounds.norm.boundaries, 2).tolist(), - np.linspace(255, 305, 5, endpoint=True).tolist(), - ) - diff --git a/tests/test_plot2d_icon_contour.py b/tests/test_plot2d_icon_contour.py deleted file mode 100644 index 13a652ad..00000000 --- a/tests/test_plot2d_icon_contour.py +++ /dev/null @@ -1,66 +0,0 @@ -"""Test module for the contour plot for icon grids.""" - -# Disclaimer -# ---------- -# -# Copyright (C) 2021 Helmholtz-Zentrum Hereon -# Copyright (C) 2020-2021 Helmholtz-Zentrum Geesthacht -# Copyright (C) 2016-2021 University of Lausanne -# -# This file is part of psy-simple and is released under the GNU LGPL-3.O license. -# See COPYING and COPYING.LESSER in the root of the repository for full -# licensing details. -# -# This program is free software: you can redistribute it and/or modify -# it under the terms of the GNU Lesser General Public License version 3.0 as -# published by the Free Software Foundation. -# -# 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 LGPL-3.0 license for more details. -# -# You should have received a copy of the GNU LGPL-3.0 license -# along with this program. If not, see . - -import unittest - -from psyplot import rcParams -from psy_simple.plotters import Simple2DPlotter - -import test_plot2d_icon as t2di - - -class IconSimplePlotterContourTest(t2di.IconSimplePlotterTest): - - plot_type = "icon_contour" - - @classmethod - def setUpClass(cls): - plotter = Simple2DPlotter() - rcParams[plotter.plot.default_key] = "contourf" - super(IconSimplePlotterContourTest, cls).setUpClass() - - @unittest.skip("Extend keyword not implemented") - def test_extend(self): - pass - - @unittest.skip("miss_color keyword not implemented") - def test_miss_color(self): - pass - - @unittest.skip("miss_color keyword not implemented") - def ref_miss_color(self): - pass - - @unittest.skip("nan not supported for icon contour") - def test_mask_01_var(self): - pass - - @unittest.skip("nan not supported for icon contour") - def test_mask_02_da(self): - pass - - @unittest.skip("nan not supported for icon contour") - def test_mask_03_fname(self): - pass diff --git a/tests/test_plot2d_icon_edge.py b/tests/test_plot2d_icon_edge.py deleted file mode 100644 index b3468bba..00000000 --- a/tests/test_plot2d_icon_edge.py +++ /dev/null @@ -1,72 +0,0 @@ -"""Test module for the contour plot for the icon edge grid.""" - -# Disclaimer -# ---------- -# -# Copyright (C) 2021 Helmholtz-Zentrum Hereon -# Copyright (C) 2020-2021 Helmholtz-Zentrum Geesthacht -# Copyright (C) 2016-2021 University of Lausanne -# -# This file is part of psy-simple and is released under the GNU LGPL-3.O license. -# See COPYING and COPYING.LESSER in the root of the repository for full -# licensing details. -# -# This program is free software: you can redistribute it and/or modify -# it under the terms of the GNU Lesser General Public License version 3.0 as -# published by the Free Software Foundation. -# -# 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 LGPL-3.0 license for more details. -# -# You should have received a copy of the GNU LGPL-3.0 license -# along with this program. If not, see . - -import os - -import numpy as np - -import _base_testing as bt -from test_plot2d_icon import IconTestMixin -import test_plot2d as t2d - - -class IconEdgeSimplePlotterTest(IconTestMixin, t2d.Simple2DPlotterTest): - """Icon edge grid test :class:`psy_simple.plotters.Simple2DPlotter` class - """ - - grid_type = "icon_edge" - - masking_val = 280 - - ncfile = os.path.join(bt.test_dir, "icon_edge_test.nc") - - def test_bounds(self): - """Test bounds formatoption""" - self.assertEqual( - np.round(self.plotter.bounds.norm.boundaries, 2).tolist(), - np.linspace(240, 310, 11, endpoint=True).tolist(), - ) - self.update(bounds="minmax") - bounds = [ - 242.48, - 249.06, - 255.64, - 262.21, - 268.79, - 275.37, - 281.94, - 288.52, - 295.1, - 301.67, - 308.25, - ] - self.assertEqual( - np.round(self.plotter.bounds.norm.boundaries, 2).tolist(), bounds - ) - self.update(bounds=["rounded", 5, 5, 95]) - self.assertEqual( - np.round(self.plotter.bounds.norm.boundaries, 2).tolist(), - np.linspace(255, 305, 5, endpoint=True).tolist(), - ) diff --git a/tests/test_vector.py b/tests/test_vector.py deleted file mode 100644 index 904f7d80..00000000 --- a/tests/test_vector.py +++ /dev/null @@ -1,194 +0,0 @@ -"""Test module for vector (quiver) plots.""" - -# Disclaimer -# ---------- -# -# Copyright (C) 2021 Helmholtz-Zentrum Hereon -# Copyright (C) 2020-2021 Helmholtz-Zentrum Geesthacht -# Copyright (C) 2016-2021 University of Lausanne -# -# This file is part of psy-simple and is released under the GNU LGPL-3.O license. -# See COPYING and COPYING.LESSER in the root of the repository for full -# licensing details. -# -# This program is free software: you can redistribute it and/or modify -# it under the terms of the GNU Lesser General Public License version 3.0 as -# published by the Free Software Foundation. -# -# 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 LGPL-3.0 license for more details. -# -# You should have received a copy of the GNU LGPL-3.0 license -# along with this program. If not, see . - -import os -import unittest - -import numpy as np - -from psyplot import rcParams, open_dataset, ArrayList -from psy_simple.plotters import SimpleVectorPlotter -import psyplot.project as psy - -import _base_testing as bt -import test_plot2d as t2d - - -class SimpleVectorPlotterTest(t2d.Simple2DPlotterTest): - """Test :class:`psyplot.plotter.maps.SimpleVectorPlotter` class""" - - plot_type = "simplevector" - - var = ["u", "v"] - - def plot(self, **kwargs): - kwargs.setdefault("color", "absolute") - ds = psy.open_dataset(self.ncfile) - kwargs.setdefault("t", ds.time.values[0]) - kwargs.setdefault("z", ds.lev.values[0]) - kwargs.setdefault("x", slice(0, 69.0)) - kwargs.setdefault("y", slice(81.0, 34.0)) - kwargs.setdefault("method", "sel") - sp = psy.plot.vector(ds, name=[self.var], **kwargs) - return sp - - @unittest.skip("miss_color formatoption not implemented") - def ref_miss_color(self, close=True): - pass - - def ref_arrowsize(self, close=True): - """Create reference file for arrowsize formatoption. - - Create reference file for - :attr:`~psyplot.plotter.maps.VectorPlotter.arrowsize` (and others) - formatoption""" - sp = self.plot(arrowsize=100.0) - sp.export(os.path.join(bt.ref_dir, self.get_ref_file("arrowsize"))) - if close: - sp.close(True, True) - - def ref_datagrid(self, close=True): - """Create reference file for datagrid formatoption - - Create reference file for - :attr:`~psy_simple.plotters.Simple2DPlotter.datagrid` - formatoption""" - sp = self.plot() - sp.update(datagrid="k-") - sp.export(os.path.join(bt.ref_dir, self.get_ref_file("datagrid"))) - if close: - sp.close(True, True) - - def test_datagrid(self, *args): - """Test datagrid formatoption""" - self.update(datagrid="k-") - self.compare_figures(next(iter(args), self.get_ref_file("datagrid"))) - - @classmethod - def setUpClass(cls): - cls.ds = open_dataset(cls.ncfile) - cls.data = ArrayList.from_dataset( - cls.ds, t=0, z=0, name=[cls.var], auto_update=True - )[0] - cls.data = cls.data.psy.sel(lon=slice(0, 69.0), lat=slice(81.0, 34.0)) - cls.data.attrs["long_name"] = "absolute wind speed" - cls.data.name = "wind" - plotter = SimpleVectorPlotter() - rcParams[plotter.color.default_key] = "absolute" - cls.plotter = SimpleVectorPlotter(cls.data) - cls.create_dirs() - cls._color_fmts = cls.plotter.fmt_groups["colors"] - - def update(self, *args, **kwargs): - kwargs.setdefault("color", "absolute") - super(SimpleVectorPlotterTest, self).update(*args, **kwargs) - - @unittest.skip("Not supported") - def test_maskless(self): - pass - - @unittest.skip("Not supported") - def test_maskgreater(self): - pass - - @unittest.skip("Not supported") - def test_maskleq(self): - pass - - @unittest.skip("Not supported") - def test_maskgeq(self): - pass - - @unittest.skip("Not supported") - def test_maskbetween(self): - pass - - @unittest.skip("Not supported") - def test_miss_color(self): - pass - - def test_cbarspacing(self, *args): - """Test cbarspacing formatoption""" - self.update( - cbarspacing="proportional", - cticks="rounded", - color="absolute", - bounds=np.arange(0, 1.45, 0.1).tolist() - + np.linspace(1.5, 13.5, 7, endpoint=True).tolist() - + np.arange(13.6, 15.05, 0.1).tolist(), - ) - self.compare_figures( - next(iter(args), self.get_ref_file("cbarspacing")) - ) - - def test_arrowsize(self, *args): - """Test arrowsize formatoption""" - self.update(arrowsize=100.0) - self.compare_figures(next(iter(args), self.get_ref_file("arrowsize"))) - - _max_rounded_ref = 70 - - @property - def _minmax_cticks(self): - speed = ( - self.plotter.plot_data.values[0] ** 2 - + self.plotter.plot_data.values[1] ** 2 - ) ** 0.5 - speed = speed[~np.isnan(speed)] - return np.round( - np.linspace(speed.min(), speed.max(), 11, endpoint=True), - decimals=2, - ).tolist() - - def test_bounds(self): - """Test bounds formatoption""" - self.update(color="absolute") - self.assertEqual( - np.round(self.plotter.bounds.norm.boundaries, 2).tolist(), - np.linspace(0, 15, 11, endpoint=True).tolist(), - ) - self.update(bounds="minmax") - bounds = [ - 0.36, - 1.4, - 2.45, - 3.49, - 4.54, - 5.59, - 6.63, - 7.68, - 8.72, - 9.77, - 10.81, - ] - - self.assertEqual( - np.round(self.plotter.bounds.norm.boundaries, 2).tolist(), bounds - ) - self.update(bounds=["rounded", 5, 5, 95]) - self.assertEqual( - np.round(self.plotter.bounds.norm.boundaries, 3).tolist(), - np.linspace(1.0, 8.5, 5, endpoint=True).tolist(), - ) diff --git a/tests/test_vector_icon.py b/tests/test_vector_icon.py deleted file mode 100644 index d52dd821..00000000 --- a/tests/test_vector_icon.py +++ /dev/null @@ -1,97 +0,0 @@ -"""Test module for vector (quiver) plots with icon data.""" - -# Disclaimer -# ---------- -# -# Copyright (C) 2021 Helmholtz-Zentrum Hereon -# Copyright (C) 2020-2021 Helmholtz-Zentrum Geesthacht -# Copyright (C) 2016-2021 University of Lausanne -# -# This file is part of psy-simple and is released under the GNU LGPL-3.O license. -# See COPYING and COPYING.LESSER in the root of the repository for full -# licensing details. -# -# This program is free software: you can redistribute it and/or modify -# it under the terms of the GNU Lesser General Public License version 3.0 as -# published by the Free Software Foundation. -# -# 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 LGPL-3.0 license for more details. -# -# You should have received a copy of the GNU LGPL-3.0 license -# along with this program. If not, see . - -import os - -import numpy as np - -from psyplot import rcParams, ArrayList, open_dataset -from psy_simple.plotters import SimpleVectorPlotter -import psyplot.project as psy - -import _base_testing as bt -from test_plot2d_icon import IconTestMixin -import test_vector as tv - - -class IconSimpleVectorPlotterTest(IconTestMixin, tv.SimpleVectorPlotterTest): - """ - Test :class:`psy_simple.plotters.SimpleVectorPlotter` class for icon grid - """ - - grid_type = "icon" - - ncfile = os.path.join(bt.test_dir, "icon_test.nc") - - @classmethod - def setUpClass(cls): - plotter = SimpleVectorPlotter() - rcParams[plotter.color.default_key] = "absolute" - cls.ds = open_dataset(cls.ncfile) - cls.data = ArrayList.from_dataset( - cls.ds, t=0, z=0, name=[cls.var], auto_update=True - )[0] - cls.data.attrs["long_name"] = "absolute wind speed" - cls.data.name = "wind" - cls.plotter = SimpleVectorPlotter(cls.data) - cls.create_dirs() - cls._color_fmts = cls.plotter.fmt_groups["colors"] - - def plot(self, **kwargs): - kwargs.setdefault("color", "absolute") - ds = psy.open_dataset(self.ncfile) - sp = psy.plot.vector(ds, name=[self.var], **kwargs) - return sp - - def test_bounds(self): - """Test bounds formatoption""" - self.update(color="absolute") - self.assertEqual( - np.round(self.plotter.bounds.norm.boundaries, 2).tolist(), - np.linspace(0, 15, 11, endpoint=True).tolist(), - ) - self.update(bounds="minmax") - bounds = [ - 0.08, - 1.18, - 2.28, - 3.38, - 4.48, - 5.59, - 6.69, - 7.79, - 8.89, - 9.99, - 11.09, - ] - self.assertEqual( - np.round(self.plotter.bounds.norm.boundaries, 2).tolist(), bounds - ) - self.update(bounds=["rounded", 5, 5, 95]) - self.assertEqual( - np.round(self.plotter.bounds.norm.boundaries, 2).tolist(), - np.round(np.linspace(0.5, 9.0, 5, endpoint=True), 2).tolist(), - ) - diff --git a/tests/test_vector_stream.py b/tests/test_vector_stream.py deleted file mode 100644 index 4f9d4d2e..00000000 --- a/tests/test_vector_stream.py +++ /dev/null @@ -1,91 +0,0 @@ -"""Test module for streamplots.""" - -# Disclaimer -# ---------- -# -# Copyright (C) 2021 Helmholtz-Zentrum Hereon -# Copyright (C) 2020-2021 Helmholtz-Zentrum Geesthacht -# Copyright (C) 2016-2021 University of Lausanne -# -# This file is part of psy-simple and is released under the GNU LGPL-3.O license. -# See COPYING and COPYING.LESSER in the root of the repository for full -# licensing details. -# -# This program is free software: you can redistribute it and/or modify -# it under the terms of the GNU Lesser General Public License version 3.0 as -# published by the Free Software Foundation. -# -# 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 LGPL-3.0 license for more details. -# -# You should have received a copy of the GNU LGPL-3.0 license -# along with this program. If not, see . - -import os - -from psyplot import rcParams -from psy_simple.plotters import SimpleVectorPlotter - -import _base_testing as bt -import test_vector as tv - - -class SimpleStreamVectorPlotterTest(tv.SimpleVectorPlotterTest): - """Test case for stream plot of - :class:`psy_simple.plotters.SimpleVectorPlotter` - """ - - @classmethod - def setUpClass(cls): - plotter = SimpleVectorPlotter() - rcParams[plotter.plot.default_key] = "stream" - return super(SimpleStreamVectorPlotterTest, cls).setUpClass() - - def get_ref_file(self, identifier): - return super(SimpleStreamVectorPlotterTest, self).get_ref_file( - identifier + "_stream" - ) - - def ref_arrowsize(self, *args): - """Create reference file for arrowsize formatoption. - - Create reference file for - :attr:`~psy_simple.plotters.SimpleVectorPlotter.arrowsize` (and others) - formatoption""" - sp = self.plot(arrowsize=2.0) - sp.export(os.path.join(bt.ref_dir, self.get_ref_file("arrowsize"))) - - def ref_arrowstyle(self, *args): - """Create reference file for arrowstyle formatoption. - - Create reference file for - :attr:`~psy_simple.plotters.SimpleVectorPlotter.arrowstyle` (and - others) formatoption""" - sp = self.plot(arrowsize=2.0, arrowstyle="fancy") - sp.export(os.path.join(bt.ref_dir, self.get_ref_file("arrowstyle"))) - - def test_arrowsize(self, *args): - """Test arrowsize formatoption""" - self.update(arrowsize=2.0) - self.compare_figures(next(iter(args), self.get_ref_file("arrowsize"))) - - def test_arrowstyle(self, *args): - """Test arrowstyle formatoption""" - self.update(arrowsize=2.0, arrowstyle="fancy") - self.compare_figures(next(iter(args), self.get_ref_file("arrowstyle"))) - - def ref_density(self, *args): - """Create reference file for density formatoption. - - Create reference file for - :attr:`~psy_simple.plotters.SimpleVectorPlotter.density` (and others) - formatoption""" - sp = self.plot(density=0.5) - sp.export(os.path.join(bt.ref_dir, self.get_ref_file("density"))) - - def test_density(self, *args): - """Test density formatoption""" - self.update(density=0.5) - self.compare_figures(next(iter(args), self.get_ref_file("density"))) diff --git a/tests/test_violin.py b/tests/test_violin.py deleted file mode 100755 index 799c010c..00000000 --- a/tests/test_violin.py +++ /dev/null @@ -1,118 +0,0 @@ -"""Test module of the :mod:`psy_simple.plotters` module.""" - -# Disclaimer -# ---------- -# -# Copyright (C) 2021 Helmholtz-Zentrum Hereon -# Copyright (C) 2020-2021 Helmholtz-Zentrum Geesthacht -# Copyright (C) 2016-2021 University of Lausanne -# -# This file is part of psy-simple and is released under the GNU LGPL-3.O license. -# See COPYING and COPYING.LESSER in the root of the repository for full -# licensing details. -# -# This program is free software: you can redistribute it and/or modify -# it under the terms of the GNU Lesser General Public License version 3.0 as -# published by the Free Software Foundation. -# -# 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 LGPL-3.0 license for more details. -# -# You should have received a copy of the GNU LGPL-3.0 license -# along with this program. If not, see . - -import unittest - -from psy_simple.plotters import ViolinPlotter - -import psyplot.project as psy -from psyplot import InteractiveList, open_dataset - -import test_lineplot as tl - - -class ViolinPlotterTest(tl.LinePlotterTest): - """Test class for :class:`psy_simple.plotters.BarPlotter`""" - - plot_type = "violin" - - @classmethod - def setUpClass(cls): - cls.ds = open_dataset(cls.ncfile) - cls.data = InteractiveList.from_dataset( - cls.ds, y=[0, 1], z=0, t=0, name=cls.var, auto_update=True - ) - cls.plotter = ViolinPlotter(cls.data) - cls.create_dirs() - - def plot(self, **kwargs): - name = kwargs.pop("name", self.var) - return psy.plot.violinplot( - self.ncfile, name=name, t=0, z=0, y=[0, 1], **kwargs - ) - - @unittest.skip("No need for figure creation") - def ref_xticks(self, close=True): - pass - - @unittest.skip("No need for figure creation") - def ref_plot_area(self, close=True): - pass - - @unittest.skip("No need for figure creation") - def ref_plot_areax(self, close=True): - pass - - @unittest.skip("No need for figure creation") - def ref_plot_None(self, *args): - pass - - @unittest.skip("No need for figure creation") - def ref_plot_stacked(self, close=True): - pass - - @unittest.skip("No need for figure creation") - def ref_plot_stacked_transposed(self, close=True): - pass - - @unittest.skip("seaborn changes colors") - def test_append_data(self): - pass - - @unittest.skip("Test needs to be implemented") - def test_xticks(self, *args): - """ - .. todo:: - - Implement this test""" - # TODO: implement this test - pass - - @unittest.skip("No need for figure creation") - def test_plot_area(self, *args): - pass - - @unittest.skip("No need for figure creation") - def test_plot_areax(self, *args): - pass - - @unittest.skip("No need for figure creation") - def test_plot_None(self, *args): - pass - - @unittest.skip("No need for figure creation") - def test_plot_stacked(self, close=True): - pass - - @unittest.skip("No need for figure creation") - def test_plot_stacked_transposed(self, close=True): - pass - - def test_color(self): - pass - - @unittest.skip("Not implemented for ViolinPlotter") - def test_coord(self): - pass diff --git a/tests/test_violin_single.py b/tests/test_violin_single.py deleted file mode 100755 index 84a272c5..00000000 --- a/tests/test_violin_single.py +++ /dev/null @@ -1,56 +0,0 @@ -"""Test module of the :mod:`psy_simple.plotters` module.""" - -# Disclaimer -# ---------- -# -# Copyright (C) 2021 Helmholtz-Zentrum Hereon -# Copyright (C) 2020-2021 Helmholtz-Zentrum Geesthacht -# Copyright (C) 2016-2021 University of Lausanne -# -# This file is part of psy-simple and is released under the GNU LGPL-3.O license. -# See COPYING and COPYING.LESSER in the root of the repository for full -# licensing details. -# -# This program is free software: you can redistribute it and/or modify -# it under the terms of the GNU Lesser General Public License version 3.0 as -# published by the Free Software Foundation. -# -# 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 LGPL-3.0 license for more details. -# -# You should have received a copy of the GNU LGPL-3.0 license -# along with this program. If not, see . - -from psy_simple.plotters import ViolinPlotter -import psyplot.project as psy -import test_base as tb -import test_violin as tv -from psyplot import InteractiveList, open_dataset - - -class SingleViolinPlotterTest(tv.ViolinPlotterTest): - """Test of :class:`psy_simple.plotters.ViolinPlotter` with a single array - instead of an InteractiveList""" - - plot_type = 'singleviolin' - - @classmethod - def setUpClass(cls): - cls.ds = open_dataset(cls.ncfile) - cls.data = InteractiveList.from_dataset( - cls.ds, y=0, z=0, t=0, name=cls.var, auto_update=True) - cls.data[0].psy.arr_name = 'arr0' - cls.data.psy.arr_name = 'arr0' - cls.plotter = ViolinPlotter(cls.data[0]) - cls.create_dirs() - - @classmethod - def tearDown(cls): - cls.data[0].psy.update(t=0, todefault=True, replot=True) - - def plot(self, **kwargs): - name = kwargs.pop('name', self.var) - return psy.plot.violinplot( - self.ncfile, name=name, t=0, z=0, y=0, **kwargs) diff --git a/tests/widgets/_widgets_base_testing.py b/tests/widgets/_widgets_base_testing.py deleted file mode 100644 index 025fe5d4..00000000 --- a/tests/widgets/_widgets_base_testing.py +++ /dev/null @@ -1,153 +0,0 @@ -# -*- coding: utf-8 -*- -"""Module defining the base class for the gui test""" - -# Disclaimer -# ---------- -# -# Copyright (C) 2021 Helmholtz-Zentrum Hereon -# Copyright (C) 2020-2021 Helmholtz-Zentrum Geesthacht -# Copyright (C) 2016-2021 University of Lausanne -# -# This file is part of psy-simple and is released under the GNU LGPL-3.O license. -# See COPYING and COPYING.LESSER in the root of the repository for full -# licensing details. -# -# This program is free software: you can redistribute it and/or modify -# it under the terms of the GNU Lesser General Public License version 3.0 as -# published by the Free Software Foundation. -# -# 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 LGPL-3.0 license for more details. -# -# You should have received a copy of the GNU LGPL-3.0 license -# along with this program. If not, see . - -import six -import os -import os.path as osp -import numpy as np -import unittest - -os.environ['PSYPLOT_PLUGINS'] = 'yes:psy_simple.plugin' - - -from psyplot_gui.compat.qtcompat import QApplication -from psyplot_gui import rcParams -from psyplot import rcParams as psy_rcParams - - -def is_running_in_gui(): - from psyplot_gui.main import mainwindow - return mainwindow is not None - - -running_in_gui = is_running_in_gui() - - -on_travis = os.environ.get('TRAVIS') - - -def setup_rcparams(): - rcParams.defaultParams['console.start_channels'][0] = False - rcParams.defaultParams['main.listen_to_port'][0] = False - rcParams.defaultParams['help_explorer.render_docs_parallel'][0] = False - rcParams.defaultParams['help_explorer.use_intersphinx'][0] = False - rcParams.defaultParams['plugins.include'][0] = [] - rcParams.defaultParams['plugins.exclude'][0] = 'all' - rcParams.update_from_defaultParams() - - -class PsyPlotGuiTestCase(unittest.TestCase): - """A base class for testing the psyplot_gui module - - At the initializzation of the TestCase, a new - :class:`psyplot_gui.main.MainWindow` widget is created which is closed at - the end of all the tests""" - - @classmethod - def setUpClass(cls): - from psyplot_gui.main import mainwindow - cls._close_app = mainwindow is None - cls._app = QApplication.instance() - if not running_in_gui: - if cls._app is None: - cls._app = QApplication([]) - cls._app.setQuitOnLastWindowClosed(False) - - @classmethod - def tearDownClass(cls): - if not running_in_gui: - cls._app.quit() - del cls._app - - def setUp(self): - import psyplot_gui.main as main - if not running_in_gui: - setup_rcparams() - self.window = main.MainWindow.run(show=False) - else: - self.window = main.mainwindow - - def tearDown(self): - import psyplot.project as psy - import matplotlib.pyplot as plt - if not running_in_gui: - import psyplot_gui.main as main - self.window.close() - rcParams.update_from_defaultParams() - psy_rcParams.update_from_defaultParams() - rcParams.disconnect() - psy_rcParams.disconnect() - main._set_mainwindow(None) - del self.window - psy.close('all') - plt.close('all') - - def get_file(self, fname): - """Get the path to the file `fname` - - Parameters - ---------- - fname: str - The path of the file name (relative to the test directory) - - Returns - ------- - str - The complete path to the given file""" - return osp.join(osp.dirname(__file__), fname) - - def assertAlmostArrayEqual(self, actual, desired, rtol=1e-07, atol=0, - msg=None, **kwargs): - """Asserts that the two given arrays are almost the same - - This method uses the :func:`numpy.testing.assert_allclose` function - to compare the two given arrays. - - Parameters - ---------- - actual : array_like - Array obtained. - desired : array_like - Array desired. - rtol : float, optional - Relative tolerance. - atol : float, optional - Absolute tolerance. - equal_nan : bool, optional. - If True, NaNs will compare equal. - msg : str, optional - The error message to be printed in case of failure. - verbose : bool, optional - If True, the conflicting values are appended to the error message. - """ - try: - np.testing.assert_allclose(actual, desired, rtol=rtol, atol=atol, - err_msg=msg or '', **kwargs) - except AssertionError as e: - if six.PY2: - self.fail(e.message) - else: - self.fail(str(e)) diff --git a/tests/widgets/test_color_widgets.py b/tests/widgets/test_color_widgets.py deleted file mode 100644 index 3c0e3aa2..00000000 --- a/tests/widgets/test_color_widgets.py +++ /dev/null @@ -1,282 +0,0 @@ -"""Test module for the :mod:`psy_simple.widgets.colors` module""" - -# Disclaimer -# ---------- -# -# Copyright (C) 2021 Helmholtz-Zentrum Hereon -# Copyright (C) 2020-2021 Helmholtz-Zentrum Geesthacht -# Copyright (C) 2016-2021 University of Lausanne -# -# This file is part of psy-simple and is released under the GNU LGPL-3.O license. -# See COPYING and COPYING.LESSER in the root of the repository for full -# licensing details. -# -# This program is free software: you can redistribute it and/or modify -# it under the terms of the GNU Lesser General Public License version 3.0 as -# published by the Free Software Foundation. -# -# 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 LGPL-3.0 license for more details. -# -# You should have received a copy of the GNU LGPL-3.0 license -# along with this program. If not, see . - -import six -import os.path as osp -import numpy as np -from psyplot.data import isstring -import psy_simple.widgets.colors as pswc -from psy_simple.colors import get_cmap -import matplotlib.colors as mcol -from psyplot_gui.compat.qtcompat import QTest, Qt, QtGui -import _widgets_base_testing as bt -import unittest - -import matplotlib as mpl - -mpl_version = tuple(map(int, mpl.__version__.split('.')[:2])) - - -class CMapWidgetTest(bt.PsyPlotGuiTestCase): - """Test case for the :class:`psy_simple.widgets.colors.CMapFmtWidget`""" - - @property - def fmt_widget(self): - return self.window.fmt_widget - - @property - def plotter(self): - return self.project.plotters[0] - - def setUp(self): - import psyplot.project as psy - super(CMapWidgetTest, self).setUp() - self.project = psy.plot.plot2d( - self.get_file(osp.join('..', 'test-t2m-u-v.nc')), - name='t2m') - self.fmt_widget.fmto = self.plotter.cmap - - def assertColormapEqual(self, cmap, reference, force_string=False): - """Test whether two colormaps are the same - - Parameters - ---------- - cmap: str or :class:`matplotlib.colors.Colormap` - The colormap to test - reference: str or :class:`matplotlib.colors.Colormap` - The reference colormap""" - if force_string or (isstring(cmap) and isstring(reference)): - self.assertEqual(cmap, reference) - if isstring(cmap): - cmap = get_cmap(cmap) - if isstring(reference): - reference = get_cmap(reference) - colors = np.linspace(0, 1, 4) - self.assertAlmostArrayEqual(cmap(colors), reference(colors)) - - def test_instance(self): - """Test changes""" - self.assertIsInstance(self.fmt_widget.fmt_widget, pswc.CMapFmtWidget) - - def test_choose_cmap(self): - fmt_w = self.fmt_widget - fmt_w.fmt_widget.choose_cmap('Blues') - self.assertColormapEqual(fmt_w.get_obj(), 'Blues', True) - cmap = get_cmap('Blues') - fmt_w.fmt_widget.choose_cmap(cmap) - chosen = fmt_w.get_obj() - self.assertIsInstance(chosen, mcol.Colormap) - self.assertColormapEqual(chosen, cmap) - - def test_edit_colormap_01_standard(self): - dialog = pswc.ColormapDialog('Blues') - self.assertIsInstance(dialog, pswc.ColormapDialog) - self.assertEqual(dialog.table.rowCount(), 1) - dialog.table.selectRow(0) - self.assertColormapEqual(dialog.table.chosen_colormap, 'Blues', True) - dialog.close() - - def test_edit_colormap_02_custom(self): - cmap = get_cmap('Blues') - dialog = pswc.ColormapDialog(cmap) - self.assertEqual(dialog.table.rowCount(), 1) - dialog.table.selectRow(0) - self.assertIsInstance(dialog.table.chosen_colormap, mcol.Colormap) - self.assertColormapEqual(dialog.table.chosen_colormap, 'Blues') - dialog.close() - - -class BoundsWidgetTest(bt.PsyPlotGuiTestCase): - """Test case for the :class:`psy_simple.widgets.colors.BoundsFmtWidget`""" - - @property - def fmt_widget(self): - return self.window.fmt_widget - - @property - def plotter(self): - return self.project.plotters[0] - - def setUp(self): - import psyplot.project as psy - super(BoundsWidgetTest, self).setUp() - self.project = psy.plot.plot2d( - self.get_file(osp.join('..', 'test-t2m-u-v.nc')), - name='t2m') - self.fmt_widget.fmto = self.plotter.bounds - - def test_instance(self): - """Test changes""" - self.assertIsInstance(self.fmt_widget.fmt_widget, pswc.BoundsFmtWidget) - - def test_minmax(self): - self.project.update(bounds=['minmax', 14, 5, 95]) - fmt_w = self.fmt_widget - fmt_w.reset_fmt_widget() - w = fmt_w.fmt_widget.current_widget - self.assertIs(w, fmt_w.fmt_widget._auto_array_widget) - self.assertEqual(fmt_w.fmt_widget.method_combo.currentText(), 'minmax') - self.assertEqual(w.sb_N.value(), 14) - self.assertEqual(float(w.txt_min_pctl.text()), 5) - self.assertEqual(float(w.txt_max_pctl.text()), 95) - - w.txt_min_pctl.setText('10') - self.assertEqual(fmt_w.get_obj(), ['minmax', 14, 10, 95, None, None]) - - def test_powernorm(self): - """Test a :class:`matplotlib.colors.PowerNorm`""" - self.project.update(bounds=mcol.PowerNorm(1.0, 280, 290)) - fmt_w = self.fmt_widget - fmt_w.reset_fmt_widget() - w = fmt_w.fmt_widget.current_widget - self.assertIs(w, fmt_w.fmt_widget._norm_widget) - w.txt_gamma.setText('2.0') - self.assertIsInstance(fmt_w.get_obj(), mcol.PowerNorm) - - def test_symlognorm(self): - """Test a :class:`matplotlib.colors.SymLogNorm`""" - if mpl_version <= (3, 1): - kws = {} - else: - kws = {'base': 10} - self.project.update(bounds=mcol.SymLogNorm(1.0, **kws)) - fmt_w = self.fmt_widget - fmt_w.reset_fmt_widget() - w = fmt_w.fmt_widget.current_widget - self.assertIs(w, fmt_w.fmt_widget._norm_widget) - w.txt_linthresh.setText('2.0') - self.assertIsInstance(fmt_w.get_obj(), mcol.SymLogNorm) - - def test_array(self): - bounds = np.arange(280., 290.1, 1) - self.project.update(bounds=bounds) - fmt_w = self.fmt_widget - fmt_w.reset_fmt_widget() - w = fmt_w.fmt_widget.current_widget - self.assertEqual(float(w.txt_min.text()), 280) - self.assertEqual(float(w.txt_max.text()), 290) - self.assertEqual(float(w.txt_step.text()), 1) - self.assertEqual(w.sb_nsteps.value(), 11) - self.assertIs(w, fmt_w.fmt_widget._array_widget) - self.assertEqual(fmt_w.get_obj(), bounds.tolist()) - self.assertTrue(w.txt_step.isEnabled()) - self.assertFalse(w.sb_nsteps.isEnabled()) - w.txt_step.setText('0.5') - self.assertAlmostArrayEqual( - fmt_w.get_obj(), np.arange(280, 290.1, 0.5)) - - w.step_inc_combo.setCurrentText('# Steps') - self.assertFalse(w.txt_step.isEnabled()) - self.assertTrue(w.sb_nsteps.isEnabled()) - w.sb_nsteps.setValue(12) - w.set_array() - self.assertAlmostArrayEqual( - fmt_w.get_obj(), np.round(np.linspace(280, 290, 12), 3)) - - -class BackgroundColorWidgetTest(bt.PsyPlotGuiTestCase): - """Test case for the :class:`BackGroundColorWidget` - """ - - @property - def fmt_widget(self): - return self.window.fmt_widget - - @property - def plotter(self): - return self.project.plotters[0] - - def setUp(self): - import psyplot.project as psy - super().setUp() - self.project = psy.plot.plot2d( - self.get_file(osp.join('..', 'test-t2m-u-v.nc')), - name='t2m') - self.fmt_widget.fmto = self.plotter.background - - def test_transparent(self): - w = self.fmt_widget.fmt_widget - w.cb_enable.setChecked(True) - self.assertIsNone(self.fmt_widget.get_obj()) - self.assertFalse(w.color_label.isEnabled()) - - def test_color_change(self): - w = self.fmt_widget.fmt_widget - w.color_label.set_color(QtGui.QColor(51, 51, 51, 255)) - obj = self.fmt_widget.get_obj() - self.assertEqual(list(obj), [0.2, 0.2, 0.2, 1.0]) - - -class CTicksWidgetTest(bt.PsyPlotGuiTestCase): - """Test case for the :class:`psy_simple.widgets.colors.BoundsFmtWidget`""" - - @property - def fmt_widget(self): - return self.window.fmt_widget - - @property - def plotter(self): - return self.project.plotters[0] - - def setUp(self): - import psyplot.project as psy - super(CTicksWidgetTest, self).setUp() - self.project = psy.plot.plot2d( - self.get_file(osp.join('..', 'test-t2m-u-v.nc')), - name='t2m') - self.fmt_widget.fmto = self.plotter.cticks - - def test_instance(self): - """Test changes""" - self.assertIsInstance(self.fmt_widget.fmt_widget, - pswc.CTicksFmtWidget) - - def test_minmax(self): - self.project.update(cticks=['minmax', 14, 5, 95]) - fmt_w = self.fmt_widget - fmt_w.reset_fmt_widget() - w = fmt_w.fmt_widget.current_widget - self.assertIs(w, fmt_w.fmt_widget._auto_array_widget) - self.assertEqual(fmt_w.fmt_widget.method_combo.currentText(), 'minmax') - self.assertEqual(w.sb_N.value(), 14) - self.assertEqual(float(w.txt_min_pctl.text()), 5) - self.assertEqual(float(w.txt_max_pctl.text()), 95) - - w.txt_min_pctl.setText('10') - self.assertEqual(fmt_w.get_obj(), ['minmax', 14, 10, 95, None, None]) - - def test_bounds(self): - self.project.update(cticks=['bounds', 3]) - - fmt_w = self.fmt_widget - fmt_w.reset_fmt_widget() - w = fmt_w.fmt_widget.current_widget - self.assertIs(w, fmt_w.fmt_widget._auto_array_widget) - self.assertEqual(fmt_w.fmt_widget.method_combo.currentText(), 'bounds') - self.assertEqual(w.sb_N.value(), 3) - - -if __name__ == '__main__': - unittest.main() diff --git a/tests/widgets/test_texts.py b/tests/widgets/test_texts.py deleted file mode 100644 index 59ae39f8..00000000 --- a/tests/widgets/test_texts.py +++ /dev/null @@ -1,116 +0,0 @@ -"""Test module for the :mod:`psy_simple.widgets.texts` module""" - -# Disclaimer -# ---------- -# -# Copyright (C) 2021 Helmholtz-Zentrum Hereon -# Copyright (C) 2020-2021 Helmholtz-Zentrum Geesthacht -# Copyright (C) 2016-2021 University of Lausanne -# -# This file is part of psy-simple and is released under the GNU LGPL-3.O license. -# See COPYING and COPYING.LESSER in the root of the repository for full -# licensing details. -# -# This program is free software: you can redistribute it and/or modify -# it under the terms of the GNU Lesser General Public License version 3.0 as -# published by the Free Software Foundation. -# -# 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 LGPL-3.0 license for more details. -# -# You should have received a copy of the GNU LGPL-3.0 license -# along with this program. If not, see . - -import os.path as osp -import psy_simple.widgets.texts as pswt -from psyplot_gui.compat.qtcompat import QTest, Qt, QtGui -import _widgets_base_testing as bt -import unittest - - -class TitleFmtWidgetTest(bt.PsyPlotGuiTestCase): - """Test case for the LabelWidget""" - - @property - def fmt_widget(self): - return self.window.fmt_widget - - @property - def plotter(self): - return self.project.plotters[0] - - def setUp(self): - import psyplot.project as psy - super(TitleFmtWidgetTest, self).setUp() - self.project = psy.plot.lineplot( - self.get_file(osp.join('..', 'test-t2m-u-v.nc')), - name='t2m', x=0, y=0, z=0) - - def test_instance(self): - """Test changes""" - self.fmt_widget.fmto = self.plotter.title - self.assertIsInstance(self.fmt_widget.fmt_widget, pswt.LabelWidget) - self.fmt_widget.fmto = self.plotter.titleprops - self.assertIsInstance(self.fmt_widget.fmt_widget, - pswt.FontPropertiesWidget) - self.fmt_widget.fmto = self.plotter.titleweight - self.assertIsInstance(self.fmt_widget.fmt_widget, - pswt.FontWeightWidget) - self.fmt_widget.fmto = self.plotter.titlesize - self.assertIsInstance(self.fmt_widget.fmt_widget, - pswt.FontSizeWidget) - - def test_choose_font(self): - self.fmt_widget.fmto = self.plotter.titleprops - fmto_widget = self.fmt_widget.fmt_widget - font = QtGui.QFont('Arial', 24, QtGui.QFont.Bold, True) - fmto_widget.choose_font(font) - properties = self.fmt_widget.get_obj() - self.assertEqual(properties, - dict(family='Arial', size=24, weight='bold', - style='italic')) - self.assertTrue(fmto_widget.btn_bold.isChecked()) - self.assertTrue(fmto_widget.btn_italic.isChecked()) - self.assertEqual(fmto_widget.spin_box.value(), 24) - - def test_btn_bold(self): - self.test_choose_font() - fmto_widget = self.fmt_widget.fmt_widget - QTest.mouseClick(fmto_widget.btn_bold, Qt.LeftButton) - properties = self.fmt_widget.get_obj() - self.assertEqual(properties['weight'], 'normal') - QTest.mouseClick(fmto_widget.btn_bold, Qt.LeftButton) - properties = self.fmt_widget.get_obj() - self.assertEqual(properties['weight'], 'bold') - - def test_btn_italic(self): - self.test_choose_font() - fmto_widget = self.fmt_widget.fmt_widget - QTest.mouseClick(fmto_widget.btn_italic, Qt.LeftButton) - properties = self.fmt_widget.get_obj() - self.assertEqual(properties['style'], 'normal') - QTest.mouseClick(fmto_widget.btn_italic, Qt.LeftButton) - properties = self.fmt_widget.get_obj() - self.assertEqual(properties['style'], 'italic') - - def test_modify_size(self): - self.test_choose_font() - fmto_widget = self.fmt_widget.fmt_widget - fmto_widget.spin_box.setValue(28) - properties = self.fmt_widget.get_obj() - self.assertEqual(properties['size'], 28) - - def test_choose_color(self): - """Test choosing the color""" - self.fmt_widget.fmto = self.plotter.titleprops - fmto_widget = self.fmt_widget.fmt_widget - fmto_widget.choose_color(QtGui.QColor(Qt.red)) - - properties = self.fmt_widget.get_obj() - self.assertEqual(properties['color'], (1.0, 0.0, 0.0, 1.0)) - - -if __name__ == '__main__': - unittest.main() diff --git a/versioneer.py b/versioneer.py deleted file mode 100644 index fc7bee17..00000000 --- a/versioneer.py +++ /dev/null @@ -1,1848 +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/ . - -""" - -# Disclaimer -# ---------- -# -# Copyright (C) 2021 Helmholtz-Zentrum Hereon -# Copyright (C) 2020-2021 Helmholtz-Zentrum Geesthacht -# Copyright (C) 2016-2021 University of Lausanne -# -# This file is part of psy-simple and is released under the GNU LGPL-3.O license. -# See COPYING and COPYING.LESSER in the root of the repository for full -# licensing details. -# -# This program is free software: you can redistribute it and/or modify -# it under the terms of the GNU Lesser General Public License version 3.0 as -# published by the Free Software Foundation. -# -# 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 LGPL-3.0 license for more details. -# -# You should have received a copy of the GNU LGPL-3.0 license -# along with this program. If not, see . -# -# This file is originally released into the public domain. Generated by -# versioneer-0.18 (https://github.com/warner/python-versioneer) - -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)