Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/esdc-esac-esa-int/pyesasky
ESASky Widget for Jupyter Notebook
https://github.com/esdc-esac-esa-int/pyesasky
Last synced: 3 months ago
JSON representation
ESASky Widget for Jupyter Notebook
- Host: GitHub
- URL: https://github.com/esdc-esac-esa-int/pyesasky
- Owner: esdc-esac-esa-int
- License: bsd-3-clause
- Created: 2019-05-08T09:49:37.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-03-31T07:05:45.000Z (almost 2 years ago)
- Last Synced: 2024-09-19T15:45:18.721Z (4 months ago)
- Language: JavaScript
- Size: 45.8 MB
- Stars: 22
- Watchers: 7
- Forks: 10
- Open Issues: 23
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-jupyter-widgets - pyESASky - visualize and download public astronomical data (Interactive Widgets / Interactive Jupyter Widget Ecosystem)
README
# pyESASky
Welcome to the ESASky Jupyter widget page.
# Requirements
`Jupyter` comes together with anaconda.
# Installation
```bash
$ pip install pyesasky
```
# pyesasky in Jupyter lab
```bash
$ jupyter labextension install pyesasky
```
In some cases you might also have to run these 2 commands to enable PyESASky in Jupyter
```bash
$ jupyter nbextension install --py pyesasky --sys-prefix
$ jupyter nbextension enable --py pyeasky --sys-prefix
```
In order to be able to run pyesasky in Jupyter lab it is necessary to install the labextension ivywidgets by the following command:
```bash
$ jupyter labextension install @jupyter-widgets/jupyterlab-manager
```
NOTE that this requires `node.js` to be installed.
If you use conda, you can get it with:
```bash
conda install -c conda-forge nodejs
```
If you use Homebrew on Mac OS X:
```bash
brew install node
```
You can also download `Node.js` from the Node.js website https://nodejs.org/ and install it directly.
# Running pyESASky samples:
Multiple sample notebooks of the functionality in pyESASky can be found in https://github.com/esdc-esac-esa-int/pyesasky/tree/master/samples
For the basic functionalities, open the pyESASky-Basic.ipynb. To check how to overlay a catalogue, run the pyESASky-Catalogue.ipynb. To overlay a set of footprints, open pyESASky-Footprints.ipynb .
# Run pyesasky
In general, it is possible to instantiate pyESASky by running the folowing code in your Jupyter Notebook.
```python
from pyesasky import ESASkyWidget
esasky = ESASkyWidget()
esasky
```
To be able to use catalogue features, the following additional classes must be imported:
```python
from pyesasky import Catalogue
from pyesasky import CatalogueDescriptor
from pyesasky import MetadataDescriptor
from pyesasky import MetadataType
```
To be able to use footprints features, the following additional classes must be imported:
```python
from pyesasky import FootprintSet
from pyesasky import FootprintSetDescriptor
from pyesasky import MetadataDescriptor
from pyesasky import MetadataType
```
# Source code installation
For a development installation (requires npm),
```bash
$ git clone https://github.com/esdc-esac-esa-int/pyesasky
$ cd pyesasky
$ sh install.sh
```