From b3725784dfb691d1cf0205d0a26c2716d417efc6 Mon Sep 17 00:00:00 2001 From: Greg Blumberg Date: Sat, 21 Sep 2019 14:57:57 -0400 Subject: [PATCH] Fixed changelog so docs don't build weird --- CHANGELOG.rst | 24 +++++++++--------------- docs/source/picker.rst | 6 ++++-- 2 files changed, 13 insertions(+), 17 deletions(-) diff --git a/CHANGELOG.rst b/CHANGELOG.rst index 733d8602..297765c4 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -7,24 +7,18 @@ SHARPpy v1.4.0 "Andover" Release NEW FEATURES * User preferences - * Change units for wind, surface temperature and dewpoint - * Choice of three color schemes: standard (the usual white-on-black), inverted (black-on-white), and protanopia (white-on-black, but with colorblind-friendly colors) * Python 3 support -* Hodograph improvements - * Can now click and drag the storm-motion vectors, updating all the other insets - * Double click to change which storm motion vector is used for storm-relative calculations - * New readout on the hodograph, coupled to the readout on the Skew-T +* Can now click and drag the storm-motion vectors, updating all the other insets +* Double click to change which storm motion vector is used for storm-relative calculations +* New readout on the hodograph, coupled to the readout on the Skew-T * Improvements for southern-hemisphere users - * Wind barbs are flipped - * Left-mover vector is used by default - * Storm motion vector is chosen if the SPC-formatted sounding file specifies the latitude and longitude of the input sounding (southern-hemisphere uses the left-mover, northern the right-mover). - * Left-mover vector is used in all other storm-motion dependent functions (e.g., STP insets, SARS). -* New data sources for international and U.S. users - * Realtime and historical U.S. and international soundings from 1946-now are accessible through the Picker. Soundings include the latitude and longitude. - * IEM BUFKIT sounding archive (data back to 2010 from RUC, NAM, GFS, RAP) +* Storm motion vector is chosen if the SPC-formatted sounding file specifies the latitude and longitude of the input sounding (southern-hemisphere uses the left-mover, northern the right-mover). +* Left-mover vector is used in all other storm-motion dependent functions (e.g., STP insets, SARS). +* Realtime and historical U.S. and international soundings from 1946-now are accessible through the Picker. Soundings include the latitude and longitude. +* IEM BUFKIT sounding archive (data back to 2010 from RUC, NAM, GFS, RAP) * New documentation and API accessible through Github pages - * Improved documentation online (no longer in README) - * Documentation and sphinx-generated API is pushed to Github Pages with each tagged release. +* Improved documentation online (no longer in README) +* Documentation and sphinx-generated API is pushed to Github Pages with each tagged release. * Readout cursor can be configured to output other variables (e.g., potential temperature, theta-E) * Ability to modify surface by changing the surface temperature or dewpoint (mixed layer optional) * Up/down buttons on keyboard can now be used to flip through the ensemble members plotted in the SHARPpy GUI. diff --git a/docs/source/picker.rst b/docs/source/picker.rst index 78c46acf..9f66ea9e 100644 --- a/docs/source/picker.rst +++ b/docs/source/picker.rst @@ -106,12 +106,14 @@ the user can use modifier ``--debug`` to turn on logging: sharppy --debug -Logs are stored within the ``~/.sharppy`` folder. Versioning info may also be output from the :command:`sharppy` commmand: +Log files are stored within the ``~/.sharppy`` folder as the ``sharppy.log`` file. +Versioning info may also be output from the :command:`sharppy` commmand: .. prompt:: bash sharppy --version Versioning is also output when the About box is launched by the user from the program. These -tools may be used when debugging the code and `submitting bug reports to Github `_: +tools may be used when debugging the code and `submitting bug reports to Github `_: +Please submit log files and versioning information when submitting issues.