# 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
```
Raw data
{
"_id": null,
"home_page": "https://github.com/esdc-esac-esa-int/pyesasky.git",
"name": "pyesasky",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "Jupyter,JupyterLab,JupyterLab3",
"author": "Mattias W\u00e5ngblad / Fabrizio Giordano from ESDC (ESA/ESAC)",
"author_email": "esdc_esasky@sciops.esa.int",
"download_url": "https://files.pythonhosted.org/packages/38/b0/661268e382c5069fd57b6aa518ca1d687c9a6142349a802e5153c9659471/pyesasky-1.9.4.tar.gz",
"platform": "Linux",
"description": "# pyESASky\r\n\r\nWelcome to the ESASky Jupyter widget page. \r\n\r\n# Requirements\r\n\r\n`Jupyter` comes together with anaconda. \r\n\r\n# Installation\r\n\r\n```bash\r\n$ pip install pyesasky\r\n```\r\n\r\n# pyesasky in Jupyter lab\r\n\r\n```bash\r\n$ jupyter labextension install pyesasky\r\n```\r\nIn some cases you might also have to run these 2 commands to enable PyESASky in Jupyter\r\n\r\n```bash\r\n$ jupyter nbextension install --py pyesasky --sys-prefix\r\n$ jupyter nbextension enable --py pyeasky --sys-prefix\r\n```\r\nIn order to be able to run pyesasky in Jupyter lab it is necessary to install the labextension ivywidgets by the following command:\r\n\r\n```bash\r\n$ jupyter labextension install @jupyter-widgets/jupyterlab-manager\r\n```\r\n\r\nNOTE that this requires `node.js` to be installed. \r\n\r\nIf you use conda, you can get it with:\r\n\r\n```bash\r\nconda install -c conda-forge nodejs\r\n```\r\n\r\nIf you use Homebrew on Mac OS X:\r\n```bash\r\nbrew install node\r\n```\r\nYou can also download `Node.js` from the Node.js website https://nodejs.org/ and install it directly.\r\n\r\n\r\n# Running pyESASky samples:\r\n\r\nMultiple sample notebooks of the functionality in pyESASky can be found in https://github.com/esdc-esac-esa-int/pyesasky/tree/master/samples\r\n\r\nFor 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 .\r\n\r\n# Run pyesasky\r\n\r\nIn general, it is possible to instantiate pyESASky by running the folowing code in your Jupyter Notebook.\r\n\r\n```python\r\nfrom pyesasky import ESASkyWidget\r\nesasky = ESASkyWidget()\r\nesasky\r\n```\r\nTo be able to use catalogue features, the following additional classes must be imported:\r\n\r\n```python\r\nfrom pyesasky import Catalogue\r\nfrom pyesasky import CatalogueDescriptor\r\nfrom pyesasky import MetadataDescriptor\r\nfrom pyesasky import MetadataType\r\n```\r\n\r\nTo be able to use footprints features, the following additional classes must be imported:\r\n\r\n```python\r\nfrom pyesasky import FootprintSet\r\nfrom pyesasky import FootprintSetDescriptor\r\nfrom pyesasky import MetadataDescriptor\r\nfrom pyesasky import MetadataType\r\n```\r\n\r\n# Source code installation\r\n\r\nFor a development installation (requires npm),\r\n```bash\r\n$ git clone https://github.com/esdc-esac-esa-int/pyesasky\r\n$ cd pyesasky\r\n$ sh install.sh\r\n```\r\n",
"bugtrack_url": null,
"license": "BSD-3-Clause",
"summary": "ESASky Python wrapper",
"version": "1.9.4",
"split_keywords": [
"jupyter",
"jupyterlab",
"jupyterlab3"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "aa55efd4078661c81a820cf0091e1cf93ba2defd47c138043230daefbca3c968",
"md5": "38b6504708b92a9de251a299199fed24",
"sha256": "99b812fdc254089b5ae61d0b436e3445ae4444644cc41e707f3ae2c596d2e831"
},
"downloads": -1,
"filename": "pyesasky-1.9.4-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "38b6504708b92a9de251a299199fed24",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">=3.6",
"size": 1649683,
"upload_time": "2023-01-11T14:40:47",
"upload_time_iso_8601": "2023-01-11T14:40:47.600036Z",
"url": "https://files.pythonhosted.org/packages/aa/55/efd4078661c81a820cf0091e1cf93ba2defd47c138043230daefbca3c968/pyesasky-1.9.4-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "38b0661268e382c5069fd57b6aa518ca1d687c9a6142349a802e5153c9659471",
"md5": "3979126cf607310fcbf592db62d5597d",
"sha256": "de9c0f473a0d651f913ea1520922bde88a4a994246b3695659baf5ed6cd2fd9c"
},
"downloads": -1,
"filename": "pyesasky-1.9.4.tar.gz",
"has_sig": false,
"md5_digest": "3979126cf607310fcbf592db62d5597d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 877255,
"upload_time": "2023-01-11T14:40:49",
"upload_time_iso_8601": "2023-01-11T14:40:49.683048Z",
"url": "https://files.pythonhosted.org/packages/38/b0/661268e382c5069fd57b6aa518ca1d687c9a6142349a802e5153c9659471/pyesasky-1.9.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-01-11 14:40:49",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "esdc-esac-esa-int",
"github_project": "pyesasky.git",
"lcname": "pyesasky"
}
JSON
