From f2f379ef5abe6c7bd72fd7b42eb3347f2a273763 Mon Sep 17 00:00:00 2001 From: Peter Williams Date: Sat, 17 Oct 2020 18:19:02 -0400 Subject: [PATCH] Update developer docs in prep for Cranko work --- .github/pull_request_template.md | 1 - CHANGELOG.md | 8 ++ CHANGES.rst | 180 ------------------------------- MANIFEST.in | 5 +- RELEASE.rst | 84 --------------- frontend/CHANGELOG.md | 8 ++ frontend/README.md | 23 ++++ 7 files changed, 41 insertions(+), 268 deletions(-) create mode 100644 CHANGELOG.md delete mode 100644 CHANGES.rst delete mode 100644 RELEASE.rst create mode 100644 frontend/CHANGELOG.md create mode 100644 frontend/README.md diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index c370f2b5..712a1bed 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -13,4 +13,3 @@ - [ ] Changed code has some test coverage (or justify why not) - [ ] Changes in functionality documented (or justify why not) -- [ ] Changes summarized in `CHANGES.rst` file, if they merit mention in release notes diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 00000000..7f133eb6 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,8 @@ +# See elsewhere for changelog + +This project’s release notes are curated from the Git history of its main +branch. You can find them by looking at [the version of this file on the +`release` branch][branch] or the [GitHub release history][gh-releases]. + +[branch]: https://github.com/WorldWideTelescope/pywwt/blob/release/CHANGELOG.md +[gh-releases]: https://github.com/WorldWideTelescope/pywwt/releases diff --git a/CHANGES.rst b/CHANGES.rst deleted file mode 100644 index 4473be53..00000000 --- a/CHANGES.rst +++ /dev/null @@ -1,180 +0,0 @@ -0.10.0 (not yet released) -------------------------- - -(no changes as yet) - -0.9.0 (2020-08-29) ------------------- - -- pywwt now obtains the WWT WebGL SDK code from web.wwtassets.org, rather than - a private copy hosted on the pywwt GitHub Pages instance. - -- Live notebook links now point to mybinder.org rather than the old private WWT - instance of BinderHub, because HTTPS support is now working! - -- Fix Jupyter server plumbing when operating in the JupyterHub single-user - environment. - -0.8.0 (2020-04-03) ------------------- - -- Improve performance when changing size parameters for tabular layers. In these - cases, the performance is e.g. more than 1000x better for a 50,000 row - dataset. [#224] - -- Improve performance when changing colormap parameters for tabular - layers, for a subset of colormaps. In these cases, the performance - is e.g. more than 1000x better for a 50,000 row dataset. [#223] - -- Added a ``cmap`` parameter on image layers to control the colormap. [#244] - -- Incorporate time series behavior for data layers; add method that - returns current time in the viewer. [#187] - -- Drop support for Python 2.7 and now require at least Python 3.6. [#259] - -- Fix compatibility with Jupyter 2.0. [#260] - -0.7.0 (2019-09-20) ------------------- - -- You can now save your WWT views as interactive figures to be used in journal - articles! (Actually, they're just standalone web pages, so they can be used - anywhere you've got a web server.) This feature is new so it will still have - some rough edges — keep your eyes open for improvements. And the docs haven't - been written yet :-( [#215, #227] - -- Relatedly, there is new first-draft support for interactive controls for - image layers through the ``image.controls`` meta-property. This will also - evolve over the next few releases. [#217] - -- Initial support for data layers with Cartesian (XYZ) rather than spherical - (lat, lon, alt) coordinates. [#190] - -- Fix compatibility with the JupyterLab 1.0.x series. [#216, #219, #221] - -- Expose all available imagery layers. [#220] - -- Validate coordinate frame names used with tabular data layers. [#195] - -- Fix the widget ``reset`` method . [#212] - -- Various improvements to CI infrastructure, docs, landing pages, etc. [#218, - #225, #228, #229, #230] - -0.6.1 (2019-06-10) ------------------- - -- Fixed issues when calling ``reset()``. [#212] - -- Fixed resizing issues in Jupyter Lab. [#216] - -- Fixed server URL when using Jupyter Lab. [#219] - -0.6.0 (2019-05-29) ------------------- - -- Implement support for color-coding and scaling points in layers according - to table attributes. [#183] - -- Removed ``load_fits_data`` and added ``layers.add_image_layer`` instead, - which provides control over the image stretch, and renamed - ``layers.add_data_layer`` to ``layers.add_table_layer``. [#188, #201] - -- Added support for drag and drop events in Qt widget. [#202] - -- Added support for ``get_center`` for the Jupyter widget, and add a new - ``get_fov`` method to get the current field of view. [#206] - -- Fixed compatibility with notebook>=5.7.6 which requires mime - types for served files to be correct. [#192, #208] - -- Fixed display of table layers on Windows. [#207] - -0.5.3 (2019-01-16) ------------------- - -- Exposed option to turn off large-scale SDSS data in 3D mode, improving - performance. [#176] - -- Make sure default altitude type is set correctly. [#176] - -0.5.2 (2019-01-08) ------------------- - -- Added instructions for using Jupyter Lab. [#170] - -- Fixed ``set_view('Mars')``. [#171] - -- Fixed issue with layers not appearing under certain circumstances. [#173] - -0.5.1 (2019-01-04) ------------------- - -- Fixed a bug that caused layers to not immediately update when updating - data. [#167] - -- Fixed a bug that caused some columns to be pre-assigned to e.g. size_att - based on column name. [#167] - -0.5.0 (2019-01-04) ------------------- - -- Fixed issues with zooming using trackpad/scroll wheel. [#166] - -- Added support for customizing the layer marker type (``marker_type``), the - option to specify whether the marker size is absolute or relative to the - screen (``marker_scale``), and the option to show points on the far side of - an object (``far_side_visible``). [#165] - -- Fixed a bug that caused issues with the distance/altitude of points when not - centered on the Earth. [#165] - -0.4.1 (2018-12-23) ------------------- - -- Work around an issue with getting base URLs on e.g. mybinder. - -- Improvements to documentation. [#160, #164] - -0.4.0 (2018-12-20) ------------------- - -- Added keyboard shortcuts for movement in-viewer. [#81] - -- Disable crosshairs by default. [#157] - -- Added ``pause_time`` and ``play_time`` for controlling time and make it - possible to control the rate of passage of time. [#146, #152] - -- Added support for displaying fields of view for common telescope. [#102] - -- Added ``minor_orbits`` and ``stars`` attributes to control the visibility - of minor orbits and stars in solar system mode. [#145] - -- Added support for showing tables of data using layers. [#122, #136, #139, #140, #143, #147, #150] - -- Added ``load_fits_data`` method for Qt and Jupyter clients. [#78] - -- Added support for non-sky modes (e.g. solar system mode). [#74, #83, #95, #98] - -- Added GUI controls for imagery layers using the ``layer_controls`` attribute. [#64] - -- Added support for exploring available imagery layers. [#71] - -- Added support for showing circle collections with annotations. [#54] - -- Switch to use OpenGL API. [#73] - -- Fixed compatibility with Jupyter Lab. [#63, #65] - -- Fixed compatibility with older versions of Qt. [#133] - -- Fixed compatibility with unicode strings for colors on Python 2. [#105] - -- Improved documentation. [#60, #70, #84, #101, #109] - -0.3.0 (2017-12-20) ------------------- - -- Initial version with changelog diff --git a/MANIFEST.in b/MANIFEST.in index e91eccc2..5bac55cc 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -1,6 +1,5 @@ -include LICENSE.rst -include README.rst -include CHANGES.rst +include *.md +include *.rst include pyproject.toml include setup.py diff --git a/RELEASE.rst b/RELEASE.rst deleted file mode 100644 index edaae3d1..00000000 --- a/RELEASE.rst +++ /dev/null @@ -1,84 +0,0 @@ -Releasing -========= - -Start the release process by creating a new branch named -``release-``, where ```` will be the version to be released. - -The first real step is edit the ``CHANGES.rst`` file to include the date of -the release after the version number. Make sure the changelog is up to -date, using:: - - git log v..HEAD - -to review the commit history. Then edit the following files to update the -version numbers: - -* ``pywwt/_version.py`` (make sure the string in the tuple is set to ``final``) -* ``package.json`` - -At this point, commit all changes and use the following for the commit message:: - - Preparing release v - -Now make sure there are no temporary files in the repository:: - - git clean -fxd - -and build the release files:: - - python setup.py sdist bdist_wheel --universal - -Go inside the ``dist`` directory, and you should see a tar file and a wheel. -At this point, you should try:: - - pip install dist/pywwt-*.tar.gz - -and validate the package as extensively as you can. - -Push the current branch to GitHub and create a pull request against -``master``. Get final validation that the CI likes the release commit, but do -*not* merge the PR yet. - -Once you are satisfied that the release is good, you can merge in the pull -request. Next, fetch the latest master branch from the repository and tag -the release with:: - - git tag -m v v - -If you have PGP keys set up, you can sign the tag by also including ``-s``. - -Push the tag to GitHub:: - - git push --tags - -Azure should now run the continuous integration on the tag and publish the packages -to PyPI and npm. If not, resolve any issues, you can always delete the tag from -the repository, fix any issues, and try again. Once the release is on PyPI and npm, -you can proceed. - -If this release is a new minor series (``0.N.0``), create a new branch for point -releases as well:: - - git branch v0.N.x - -and push that branch to GitHub. - -Now change the versions in the files listed above to the next version. For the -``pywwt/_version.py`` file, change ``final`` to ``dev``. Commit the changes -with the message:: - - Back to development: v - -Push this update to your release PR branch and let the CI run again. - -While waiting, update the ``stable`` branch to trigger an update on -ReadTheDocs:: - - git push wwt v:stable - -Here, ``wwt`` is the name of the Git remote corresponding to -``WorldWideTelescope/pywwit.git`` on GitHub. A ``-f`` flag may be necessary if -the previous release had backports cherry-picked from ``master``. - -Finally, create a new release on GitHub. Copy the release notes from -``CHANGES.rst``, adapting the ReStructuredText markup to Markdown. diff --git a/frontend/CHANGELOG.md b/frontend/CHANGELOG.md new file mode 100644 index 00000000..56985bb2 --- /dev/null +++ b/frontend/CHANGELOG.md @@ -0,0 +1,8 @@ +# See elsewhere for changelog + +This project’s release notes are curated from the Git history of its main +branch. You can find them by looking at [the version of this file on the +`release` branch][branch] or the [GitHub release history][gh-releases]. + +[branch]: https://github.com/WorldWideTelescope/pywwt/blob/release/frontend/CHANGELOG.md +[gh-releases]: https://github.com/WorldWideTelescope/pywwt/releases diff --git a/frontend/README.md b/frontend/README.md new file mode 100644 index 00000000..c3cf829f --- /dev/null +++ b/frontend/README.md @@ -0,0 +1,23 @@ +# The pywwt Frontend Module + +This NPM package contains the JavaScript code implementing the frontend of the +[pywwt] data visualization tool, as used in [Jupyter/JupyterLab][jupyter]. For +more information, see [the pywwt docs][pywwt]. As such, this package is mostly a +pywwt implementation detail. To write your own WWT-based web apps, check out +[documentation for the WWT web stack][web-docs]. + +[pywwt]: https://pywwt.readthedocs.io/ +[jupyter]: https://jupyter.org/ +[web-docs]: https://docs.worldwidetelescope.org/webgl-reference/latest/ + +pywwt is built on the [AAS][aas] [WorldWide Telescope][wwt] (WWT) system. WWT is +a free, open-source tool for visually exploring humanity’s scientific +understanding of the Universe. WWT is brought to you by the non-profit [American +Astronomical Society][aas] (AAS), the major organization of professional +astronomers in North America, and the [.NET Foundation][dnf]. + +[pywwt]: https://pywwt.readthedocs.io/ +[aas]: https://aas.org/ +[wwt]: http://www.worldwidetelescope.org/home +[dnf]: https://dotnetfoundation.org/ +