WorldWide Telescope embedded as an app within JupyterLab.
Перейти к файлу
Peter Williams 56d9769e67 Add _pywwtExpedite tags for pywwt's Jupyter async skullduggery
In order for user code to be able to interact with WWT with proper async
characteristics, we need to hack the Python kernel to expedite
processing of WWT messages, for reasons laid out in detail in the
corresponding pywwt code. Here we add the special tag that requests
expedited processing. If the kernel isn't hacked, then nothing unusual
happens.
2021-07-23 12:11:04 -04:00
.config/cranko Prep for repo rename 2021-01-28 16:34:12 -05:00
ci src: fix eslint complaints 2021-01-27 17:20:09 -05:00
src Add _pywwtExpedite tags for pywwt's Jupyter async skullduggery 2021-07-23 12:11:04 -04:00
style ... and move jupyterlab/ to the top level 2021-01-27 16:47:01 -05:00
.eslintignore ... and move jupyterlab/ to the top level 2021-01-27 16:47:01 -05:00
.eslintrc.js ... and move jupyterlab/ to the top level 2021-01-27 16:47:01 -05:00
.gitignore jupyterlab: very rough import of something here 2021-01-05 14:04:12 -05:00
.prettierignore ... and move jupyterlab/ to the top level 2021-01-27 16:47:01 -05:00
.prettierrc ... and move jupyterlab/ to the top level 2021-01-27 16:47:01 -05:00
LICENSE Initial import of something that builds 2021-01-05 12:18:43 -05:00
README.md Prep for repo rename 2021-01-28 16:34:12 -05:00
package.json Update to bugfixed @wwtelescope/research-app-messages 0.7.1 2021-07-19 12:49:03 -04:00
tsconfig.json ... and move jupyterlab/ to the top level 2021-01-27 16:47:01 -05:00
yarn.lock Update to bugfixed @wwtelescope/research-app-messages 0.7.1 2021-07-19 12:49:03 -04:00

README.md

Build Status

@wwtelescope/jupyterlab

AAS WorldWide Telescope (WWT) inside JupyterLab. Learn more about WWT here.

Requirements

This extension supports:

  • The JupyterLab 2.x series
  • The JupyterLab 3.x series

Installation

If youve got JupyterLab all set up, you dont even need to download the source code. All you need to do is:

$ jupyter labextension install @wwtelescope/jupyterlab

There is a jupyter labextension uninstall command to remove the extension.

Development

Since this repo contains a JupyterLab extension, the primary build interface is using the jlpm command, which is JupyterLabs bundled version of yarn.

Some useful commands are as follows:

$ jupyter labextension install .  # link your development version of the extension with JupyterLab
$ jupyter lab build  # Rebuild JupyterLab after making any changes
$ jlpm watch  # Auto-rebuild sources (long-running)
$ jupyter lab --watch  # Run JupyterLab, auto-reloading changed extensions (long-running)

$ jlpm run build  # build locally
$ jlpm add ${npm_package_name}  # add a dep

Continuous Integration and Deployment

This repository uses Cranko to automate release workflows. This automation is essential to the smooth and reproducible deployment of the WWT web services.

Getting involved

We love it when people get involved in the WWT community! You can get started by participating in our user forum or by signing up for our low-traffic newsletter. If you would like to help make WWT better, our Contributor Hub aims to be your one-stop shop for information about how to contribute to the project, with the Contributors Guide being the first thing you should read. Here on GitHub we operate with a standard fork-and-pull model.

All participation in WWT communities is conditioned on your adherence to the WWT Code of Conduct, which basically says that you should not be a jerk.

Acknowledgments

The AAS WorldWide Telescope system is a .NET Foundation project. Work on WWT has been supported by the American Astronomical Society (AAS), the US National Science Foundation (grants 1550701, 1642446, 2004840), the Gordon and Betty Moore Foundation, and Microsoft.

Legalities

The WWT code is licensed under the MIT License. The copyright to the code is owned by the .NET Foundation.