Merge branch 'master' into legend-colorbar-classes

Author: lukelbd

.gitignore

@@ -14,9 +14,9 @@ docs/api
 docs/_build
 
 # Subfolders in data directories
-**/cmaps/**
-**/cycles/**
-**/fonts/**
+**/cmaps/*/
+**/cycles/*/
+**/fonts/*/
 
 # Folder of notebooks for testing and bugfixing
 local

.pre-commit-config.yaml

@@ -7,8 +7,6 @@ repos:
     - id: double-quote-string-fixer
     - id: check-docstring-first
     - id: check-merge-conflict
-    - id: check-yaml
-    - id: debug-statements
     - id: end-of-file-fixer
     - id: trailing-whitespace
     - id: flake8

CHANGELOG.rst

@@ -15,77 +15,230 @@ ProPlot v1.0.0 (2020-##-##)
 This will be published when some major refactoring tasks are completed.
 See :pr:`45`, :pr:`46`, and :pr:`50`.
 
+ProPlot v0.5.0 (2020-##-##)
+===========================
+.. rubric:: Features
+
+- Users can now use `~proplot.subplots.figure` with `~proplot.subplots.Figure.add_subplot`
+  *or* `~proplot.subplots.subplots` (:pr:`50`). This is a major improvement!
+- `~proplot.subplots.GridSpec` now accepts physical units, rather than having
+  `~proplot.subplots.subplots` handle the units (:pr:`50`).
+- Allow "hanging" twin *x* and *y* axes as members of the `~proplot.subplots.EdgeStack`
+  container. Arbitrarily many siblings are now permitted.
+- Use `~proplot.subplots.GeometrySolver` for calculating various automatic layout
+  stuff instead of having 1000 hidden `~proplot.subplots.Figure` methods (:pr:`50`).
+- Use `~proplot.subplots.EdgeStack` class for handling
+  stacks of colorbars, legends, and text (:pr:`50`).
+
+.. rubric:: Internals
+
+- Handle all projection keyword arguments in `~proplot.subplots.Figure.add_subplot`
+  instead of `~proplot.subplots.subplots` (:pr:`50`).
+- Panels, colorbars, and legends are now members of `~proplot.subplots.EdgeStack`
+  stacks rather than getting inserted directly into
+  the main `~proplot.subplots.GridSpec` (:pr:`50`).
+
+ProPlot v0.4.0 (2020-01-07)
+===========================
+.. rubric:: Deprecated
+
+
+- Rename `basemap_defaults` to `~proplot.projs.basemap_kwargs` and `cartopy_projs`
+  to `~proplot.projs.cartopy_names` (:commit:`431a06ce`).
+- Remove ``subplots.innerspace``, ``subplots.titlespace``,
+  ``subplots.xlabspace``, and ``subplots.ylabspace`` spacing arguments,
+  automatically calculate default non-tight spacing using `~proplot.subplots._get_space`
+  based on current tick lengths, label sizes, etc.
+- Remove redundant `~proplot.rctools.use_fonts`, use ``rcParams['sans-serif']``
+  precedence instead (:pr:`95`).
+- `~proplot.axes.Axes.dualx` and `~proplot.axes.Axes.dualy` no longer accept "scale-spec" arguments.
+  Must be a function, two functions, or an axis scale instance (:pr:`96`).
+- Remove `~proplot.axes.Axes` ``share[x|y]``, ``span[x|y]``, and ``align[x|y]`` kwargs
+  (:pr:`99`).
+  These settings are now always figure-wide.
+- Rename `~proplot.styletools.Cycle` ``samples`` to ``N``, rename
+  `~proplot.styletools.show_colors` ``nbreak`` to ``nhues`` (:pr:`98`).
+
+.. rubric:: Features
+
+- Add `~proplot.styletools.LinearSegmentedColormap.from_file` static methods (:pr:`98`).
+  You can now load files by passing a name to `~proplot.styletools.Colormap`.
+- Add TeX Gyre Heros as open source Helvetica-alternative; this is the new default font.
+  Add Fira Math as DejaVu Sans-alternative; has complete set of math characters (:pr:`95`).
+- Add `xlinewidth`, `ylinewidth`, `xgridcolor`, `ygridcolor` keyword
+  args to `~proplot.axes.XYAxes.format` (:pr:`95`).
+- Add getters and setters for various `~proplot.subplots.Figure` settings like ``share[x|y]``,
+  ``span[x|y]``, and ``align[x|y]`` (:pr:`99`).
+- Add `~proplot.subplots.Figure` ``fallback_to_cm`` kwarg. This is used by
+  `~proplot.styletools.show_fonts` to show dummy glyphs to clearly illustrate when fonts are
+  missing characters, but preserve graceful fallback for end user.
+- Improve `~proplot.projs.Proj` constructor function. It now accepts
+  `~cartopy.crs.Projection` and `~mpl_toolkits.basemap.Basemap` instances, just like other
+  constructor functions, and returns only the projection instance (:pr:`92`).
+- `~proplot.rctools.rc` `~proplot.rctools.rc_configurator.__getitem__` always
+  returns the setting. To get context block-restricted settings, you must explicitly pass
+  ``context=True`` to `~proplot.rctools.rc_configurator.get`, `~proplot.rctools.rc_configurator.fill`,
+  or `~proplot.rctools.rc_configurator.category` (:pr:`91`).
+
+.. rubric:: Bug fixes
+
+- Fix `~proplot.rctools.rc_configurator.context` bug (:issue:`80` and :pr:`91`).
+- Fix issues with `~proplot.axes.Axes.dualx` and `~proplot.axes.Axes.dualy` with non-linear parent scales (:pr:`96`).
+- Ignore TTC fonts because they cannot be saved in EPS/PDF figures (:issue:`94` and :pr:`95`).
+- Do not try to use Helvetica Neue because "thin" font style is read as regular (:issue:`94` and :pr:`95`).
+
+.. rubric:: Documentation
+
+- Use the imperative mood for docstring summaries (:pr:`92`).
+- Fix `~proplot.styletools.show_cycles` bug (:pr:`90`) and show cycles using colorbars
+  rather than lines (:pr:`98`).
+
+.. rubric:: Internals
+
+- Define `~proplot.rctools.rc` default values with inline dictionaries rather than
+  with a default ``.proplotrc`` file, change the auto-generated user ``.proplotrc``
+  (:pr:`91`).
+- Remove useless `panel_kw` keyword arg from `~proplot.wrappers.legend_wrapper` and
+  `~proplot.wrappers.colorbar_wrapper` (:pr:`91`). Remove `wflush`, `hflush`,
+  and `flush` keyword args from `~proplot.subplots.subplots` that should have been
+  removed long ago.
+
+ProPlot v0.3.1 (2019-12-16)
+===========================
+.. rubric:: Bug fixes
+
+- Fix issue where custom fonts were not synced (:commit:`a1b47b4c`).
+- Fix issue with latest versions of matplotlib where ``%matplotlib inline``
+  fails *silently* so the backend is not instantiated (:commit:`cc39dc56`).
+
+ProPlot v0.3.0 (2019-12-15)
+===========================
+.. rubric:: Deprecated
+
+- Remove ``'Moisture'`` colormap (:commit:`cf8952b1`).
+
+.. rubric:: Features
+
+- Add `~proplot.styletools.use_font`, only sync Google Fonts fonts (:pr:`87`).
+- New ``'DryWet'`` colormap is colorblind friendly (:commit:`0280e266`).
+- Permit shifting arbitrary colormaps by ``180`` degrees by appending the
+  name with ``'_shifted'``, just like ``'_r'`` (:commit:`e2e2b2c7`).
+
+.. rubric:: Bug fixes
+
+- Add brute force workaround for saving colormaps with
+  *callable* segmentdata (:commit:`8201a806`).
+- Fix issue with latest versions of matplotlib where ``%matplotlib inline``
+  fails *silently* so the backend is not instantiated (:commit:`cc39dc56`).
+- Fix `~proplot.styletools.LinearSegmentedColormap.shifted` when `shift` is
+  not ``180`` (:commit:`e2e2b2c7`).
+- Save the ``cyclic`` and ``gamma`` attributes in JSON files too (:commit:`8201a806`).
+
+.. rubric:: Documentation
+
+- Cleanup notebooks, especially the colormaps demo (e.g. :commit:`952d4cb3`).
+
+.. rubric:: Internals
+
+- Change `~time.clock` to `~time.perf_counter` (:pr:`86`).
+
+ProPlot v0.2.7 (2019-12-09)
+===========================
+
+.. rubric:: Bug fixes
+
+- Fix issue where `~proplot.styletools.AutoFormatter` logarithmic scale
+  points are incorrect (:commit:`9b164733`).
+
+.. rubric:: Documentation
+
+- Improve :ref:`Configuring proplot` documentation (:commit:`9d50719b`).
+
+.. rubric:: Internals
+
+- Remove `prefix`, `suffix`, and `negpos` keyword args from
+  `~proplot.styletools.SimpleFormatter`, remove `precision` keyword arg from
+  `~proplot.styletools.AutoFormatter` (:commit:`8520e363`).
+- Make ``'deglat'``, ``'deglon'``, ``'lat'``, ``'lon'``, and ``'deg'`` instances
+  of `~proplot.styletools.AutoFormatter` instead of `~proplot.styletools.SimpleFormatter`
+  (:commit:`8520e363`). The latter should just be used for contours.
+
+ProPlot v0.2.6 (2019-12-08)
+===========================
+.. rubric:: Bug fixes
+
+- Fix issue where twin axes are drawn *twice* (:commit:`56145122`).
+
+
+ProPlot v0.2.5 (2019-12-07)
+===========================
+.. rubric:: Features
+
+- Much better `~proplot.axistools.CutoffScale` algorithm, permit arbitrary
+  cutoffs (:pr:`83`).
+
 ProPlot v0.2.4 (2019-12-07)
 ===========================
-Deprecated
-----------
+.. rubric:: Deprecated
+
 - Rename `ColorCacheDict` to `~proplot.styletools.ColorDict` (:commit:`aee7d1be`).
 - Rename `colors` to `~proplot.styletools.Colors` (:commit:`aee7d1be`)
 - Remove `fonts_system` and `fonts_proplot`, rename `colordict` to
   `~proplot.styletools.colors`, make top-level variables
   more robust (:commit:`861583f8`).
 
-Documentation
--------------
+.. rubric:: Documentation
+
 - Params table for `~proplot.styletools.show_fonts` (:commit:`861583f8`).
 
-Internals
----------
+.. rubric:: Internals
+
 - Improvements to `~proplot.styletools.register_colors`.
 
 ProPlot v0.2.3 (2019-12-05)
 ===========================
-Bug fixes
----------
+.. rubric:: Bug fixes
+
 - Fix issue with overlapping gridlines (:commit:`8960ebdc`).
 - Fix issue where auto colorbar labels are not applied when ``globe=True`` (:commit:`ecb3c899`).
 - More sensible zorder for gridlines (:commit:`90d94e55`).
 - Fix issue where customized super title settings are overridden when
   new axes are created (:commit:`35cb21f2`).
 
-Documentation
--------------
+.. rubric:: Documentation
+
 - Organize ipython notebook documentation (:commit:`35cb21f2`).
 
-Internals
----------
+.. rubric:: Internals
+
 - Major cleanup of the `~proplot.wrappers.colorbar_wrapper` source code, handle
   minor ticks using the builtin matplotlib API just like major ticks (:commit:`b9976220`).
 
 ProPlot v0.2.2 (2019-12-04)
 ===========================
-Bug fixes
----------
-- Fix shared *x* and *y* axis bugs (:commit:`ac14e9dd`).
+.. rubric:: Deprecated
 
-Deprecated
-----------
 - Rename `~proplot.subplots.axes_grid` to `~proplot.subplots.subplot_grid` (:commit:`ac14e9dd`).
 
-Documentation
--------------
+.. rubric:: Bug fixes
+
+- Fix shared *x* and *y* axis bugs (:commit:`ac14e9dd`).
+
+.. rubric:: Documentation
+
 - Make notebook examples PEP8 compliant (:commit:`97f5ffd4`). Much more readable now.
 
 ProPlot v0.2.1 (2019-12-02)
 ===========================
-Deprecated
-----------
+.. rubric:: Deprecated
+
 - Rename `autoreload_setup`, `autosave_setup`, and `matplotlib_setup` to
   `~proplot.rctools.ipython_autoreload`, `~proplot.rctools.ipython_autosave`, and `~proplot.rctools.ipython_matplotlib`, respectively (:commit:`84e80c1e`).
 
 ProPlot v0.2.0 (2019-12-02)
 ===========================
-Features
---------
-- Support manual resizing for all backends, including ``osx`` and ``qt`` (:commit:`3a622887`).
+.. rubric:: Deprecated
 
-Bug fixes
----------
-- Disable automatic resizing for the ``nbAgg`` interactive inline backend. Found no
-  suitable workaround (:commit:`3a622887`).
-
-Deprecated
-----------
 - Remove the ``nbsetup`` rc setting in favor of separate ``autosave``, ``autoreload``,
   and ``matplotlib`` settings for triggering the respective ``%`` magic commands.
   (:commit:`3a622887`; ``nbsetup`` is still accepted but no longer documented).
@@ -95,8 +248,17 @@ Deprecated
   and ``SubplotSpec`` (:commit:`3a622887`; until :pr:`50` is merged it is impossible
   to use these manually, so this won't bother anyone).
 
-Internals
----------
+.. rubric:: Features
+
+- Support manual resizing for all backends, including ``osx`` and ``qt`` (:commit:`3a622887`).
+
+.. rubric:: Bug fixes
+
+- Disable automatic resizing for the ``nbAgg`` interactive inline backend. Found no
+  suitable workaround (:commit:`3a622887`).
+
+.. rubric:: Internals
+
 - Organize the ``rc`` documentation and the default ``.proplotrc`` file (:commit:`3a622887`).
 - Rename ``rcParamsCustom`` to ``rcParamsLong``
   (:commit:`3a622887`; this is inaccessible to the user).
@@ -106,16 +268,16 @@ Internals
 
 ProPlot v0.1.0 (2019-12-01)
 ===========================
-Internals
----------
+.. rubric:: Internals
+
 - Include `flake8` in Travis CI testing (:commit:`8743b857`).
 - Enforce source code PEP8 compliance (:commit:`78da51a7`).
 - Use pre-commit for all future commits (:commit:`e14f6809`).
 - Implement tight layout stuff with canvas monkey patches (:commit:`67221d10`).
   ProPlot now works for arbitrary backends, not just inline and qt.
 
-Documentation
--------------
+.. rubric:: Documentation
+
 - Various `RTD bugfixes <https://github.com/readthedocs/readthedocs.org/issues/6412>`__ (e.g. :commit:`37633a4c`).
 
 ProPlot v0.0.0 (2019-11-27)