ipymizar

A Jupyter / Mizar plugin to display interactive planets and Sky maps in a notebook.

The implementation is based on ipyleaflet.

Python API

You can view our Python API on the following link.

It currently supports these types of layer:

• WMS
• OpenStreetMap
• Hips
• GeoJSON

Examples

You can find many notebook examples in the examples directory.

A Planet Map

A Sky Map

Installation

To install this plugin, use pip:

$ git clone https://github.com/MizarWeb/ipymizar
$ cd ipymizar
$ pip install .

Dev installation

Clone the repo:

$ git clone https://github.com/MizarWeb/ipymizar
$ cd ipymizar

For a development installation, you can use conda to create a dev environment with the required dependencies (including Node.js and Yarn version 1):

$ conda env create --file dev-environment.yml
$ conda activate ipymizar-dev

Install a dev version of ipymizar:

$ pip install -e .

When developing for the classic Jupyter Notebook (launched with jupyter notebook), run:

$ jupyter nbextension install --py --symlink --overwrite --sys-prefix ipymizar
$ jupyter nbextension enable --py --sys-prefix ipymizar

When developing for JupyterLab (launched with jupyter lab), run the following command only if using JupyterLab <= 2:

$ jupyter labextension install @jupyter-widgets/jupyterlab-manager ipymizar

This command has to be run whatever the version of JupyterLab (not required for the classic version):

$ jupyter labextension develop --overwrite .

Then you need to rebuild the front-end (Javascript) when you make a code change:

$ cd js
$ yarn build

If you change the code:

• In Python: the kernel needs to be restarted using the Kernel menu item available on the Web UI
• In Javascript: rebuild and refresh the notebook page

To build/rebuild the front-end:

$ cd js

And the following command to build both the notebook and the lab extensions;

$ yarn build

Or one of these commands to build one of these extensions in watch mode (automatically rebuilds when a change is detected):

$ yarn watch:nbextension

or

$ yarn watch:labextension

Documentation

You can generate the HTML documentation using :

$ pdoc --html ipymizar

Then commit HTML files on the gh-pages branch.