[](https://pypi.python.org/pypi/Escher)
[](https://www.npmjs.com/package/escher)
[](https://gitter.im/zakandrewking/escher)
[](https://escher.readthedocs.io/en/latest/?badge=latest)
[](https://travis-ci.org/zakandrewking/escher)
[](https://coveralls.io/github/zakandrewking/escher?branch=master)
[](https://github.com/zakandrewking/escher/blob/master/LICENSE)
# Escher
Escher is a web-based tool to build, view, share, and embed metabolic maps. The
easiest way to use Escher is to browse or build maps on the
[Escher website](http://escher.github.io/).
Visit the [documentation](http://escher.readthedocs.org/) to get started with
Escher and explore the API.
Check out the
[developer docs](https://escher.readthedocs.org/en/latest/development.html),
the [Gitter chat room](https://gitter.im/zakandrewking/escher), and the
[Development Roadmap](https://github.com/zakandrewking/escher/wiki/Development-Roadmap) for information
on Escher development. Feel free to submit bugs and feature requests as Issues,
or, better yet, Pull Requests.
Follow [@zakandrewking](https://twitter.com/zakandrewking) for Escher updates.
You can help support Escher by citing our publication when you use Escher or
EscherConverter:
Zachary A. King, Andreas Dräger, Ali Ebrahim, Nikolaus Sonnenschein, Nathan
E. Lewis, and Bernhard O. Palsson (2015) *Escher: A web application for
building, sharing, and embedding data-rich visualizations of biological
pathways*, PLOS Computational Biology 11(8):
e1004321. doi:[10.1371/journal.pcbi.1004321](http://dx.doi.org/10.1371/journal.pcbi.1004321)
Escher was developed at [SBRG](http://systemsbiology.ucsd.edu/). Funding was
provided by [The National Science Foundation Graduate Research Fellowship](https://www.nsfgrfp.org)
under Grant no. DGE-1144086, The European Commission as part of a Marie Curie
International Outgoing Fellowship within the EU 7th Framework Program for
Research and Technological Development ([EU project AMBiCon, 332020](http://ec.europa.eu/research/mariecurieactions/node_en)),
and [The Novo Nordisk Foundation](http://novonordiskfonden.dk/)
through [The Center for Biosustainability](https://www.biosustain.dtu.dk/)
at the Technical University of Denmark (NNF10CC1016517)
# Building and testing Escher
## JavaScript
First, install dependencies with [npm](https://www.npmjs.com) (or you can use
[yarn](https://yarnpkg.com)):
```
npm install
```
Escher uses webpack to manage the build process. To run typical build steps, just run:
```
npm run build
```
You can run a development server with:
```
npm run start
# or for live updates when the source code changes:
npm run watch
```
To test the JavaScript files, run:
```
npm run test
```
## Python
Escher has a Python package for generating Escher visualizations from within a
Python data anlaysis session. To learn more about using the features of the
Python package, check out the documentation:
https://escher.readthedocs.io/en/latest/escher-python.html
You can install it with pip:
```
pip install escher
```
## Jupyter extensions
When you `pip install escher`, the Jupyter notebook extension should be
installed automatically. If that doesn't work, try:
```bash
# The notebook extenstion should install automatically. You can check by running:
jupyter nbextension list
# Make sure you have version >=5 of the `notebook` package
pip install "notebook>=5"
# To manually install the extension
jupyter nbextension install --py escher
jupyter nbextension enable --py escher
# depending on you environment, you might need the `--sysprefix` flag with those commands
```
To install the Jupyter lab extension, simply install Escher with `pip install escher` then
install the extension:
```bash
jupyter labextension install @jupyter-widgets/jupyterlab-manager
jupyter labextension install escher
```
## Python/Jupyter Development
For development of the Python package, first build the JavaScript package and
copy it over to the `py` directory with these commands in the Escher root:
```
npm install
npm run build
npm run copy
```
Then in the `py` directory, install the Python package:
```
cd py
pip install -e . # installs escher in develop mode and dependencies
```
For Python testing, run this in the `py` directory:
```
cd py
pytest
```
To develop the Jupyter notebook and Jupyter Lab extensions, you will need
install them with symlinks.
First, install the Python package for development as described above.
For the Jupyter notebooks, run:
```
cd py
jupyter nbextension install --py --symlink escher
jupyter nbextension enable --py escher
```
If you are using virtualenv or conda, you can add the `--sys-prefix` flag to
those commands to keep your environment isolated and reproducible.
When you make changes, you will need to `yarn build && yarn copy` and refresh
notebook browser tab.
For Jupyter Lab, run (in the root directory):
```
yarn watch # keep this running as a separate process
jupyter labextension install @jupyter-widgets/jupyterlab-manager
jupyter labextension link
jupyter lab --watch
```
If you don't see changes when you edit the code, try refreshing or restarting
`jupyter lab --watch`.
## Docs
Build and run the docs::
```
cd docs
./build_docs
cd _build/html
python -m SimpleHTTPServer # python 2
python -m http.server # python 3
```
Raw data
{
"_id": null,
"home_page": "https://escher.github.io",
"name": "Escher-legacy",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "visualization,pathway map,metabolism,genome-scale-model,web application,D3.js,biojs",
"author": "Zachary King",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/8b/27/92b9df14cf2d182ee781d71ced757a27b07eb2344c381cbe232f2383d7e2/Escher-legacy-1.7.4.tar.gz",
"platform": null,
"description": "[](https://pypi.python.org/pypi/Escher)\n[](https://www.npmjs.com/package/escher)\n[](https://gitter.im/zakandrewking/escher)\n[](https://escher.readthedocs.io/en/latest/?badge=latest)\n[](https://travis-ci.org/zakandrewking/escher)\n[](https://coveralls.io/github/zakandrewking/escher?branch=master)\n[](https://github.com/zakandrewking/escher/blob/master/LICENSE)\n\n# Escher\n\nEscher is a web-based tool to build, view, share, and embed metabolic maps. The\neasiest way to use Escher is to browse or build maps on the\n[Escher website](http://escher.github.io/).\n\nVisit the [documentation](http://escher.readthedocs.org/) to get started with\nEscher and explore the API.\n\nCheck out the\n[developer docs](https://escher.readthedocs.org/en/latest/development.html),\nthe [Gitter chat room](https://gitter.im/zakandrewking/escher), and the\n[Development Roadmap](https://github.com/zakandrewking/escher/wiki/Development-Roadmap) for information\non Escher development. Feel free to submit bugs and feature requests as Issues,\nor, better yet, Pull Requests.\n\nFollow [@zakandrewking](https://twitter.com/zakandrewking) for Escher updates.\n\nYou can help support Escher by citing our publication when you use Escher or\nEscherConverter:\n\nZachary A. King, Andreas Dr\u00e4ger, Ali Ebrahim, Nikolaus Sonnenschein, Nathan\nE. Lewis, and Bernhard O. Palsson (2015) *Escher: A web application for\nbuilding, sharing, and embedding data-rich visualizations of biological\npathways*, PLOS Computational Biology 11(8):\ne1004321. doi:[10.1371/journal.pcbi.1004321](http://dx.doi.org/10.1371/journal.pcbi.1004321)\n\nEscher was developed at [SBRG](http://systemsbiology.ucsd.edu/). Funding was\nprovided by [The National Science Foundation Graduate Research Fellowship](https://www.nsfgrfp.org)\nunder Grant no. DGE-1144086, The European Commission as part of a Marie Curie\nInternational Outgoing Fellowship within the EU 7th Framework Program for\nResearch and Technological Development ([EU project AMBiCon, 332020](http://ec.europa.eu/research/mariecurieactions/node_en)),\nand [The Novo Nordisk Foundation](http://novonordiskfonden.dk/)\nthrough [The Center for Biosustainability](https://www.biosustain.dtu.dk/)\nat the Technical University of Denmark (NNF10CC1016517)\n\n# Building and testing Escher\n\n## JavaScript\n\nFirst, install dependencies with [npm](https://www.npmjs.com) (or you can use\n[yarn](https://yarnpkg.com)):\n\n```\nnpm install\n```\n\nEscher uses webpack to manage the build process. To run typical build steps, just run:\n\n```\nnpm run build\n```\n\nYou can run a development server with:\n\n```\nnpm run start\n# or for live updates when the source code changes:\nnpm run watch\n```\n\nTo test the JavaScript files, run:\n\n```\nnpm run test\n```\n\n## Python\n\nEscher has a Python package for generating Escher visualizations from within a\nPython data anlaysis session. To learn more about using the features of the\nPython package, check out the documentation:\n\nhttps://escher.readthedocs.io/en/latest/escher-python.html\n\nYou can install it with pip:\n\n```\npip install escher\n```\n\n## Jupyter extensions\n\nWhen you `pip install escher`, the Jupyter notebook extension should be\ninstalled automatically. If that doesn't work, try:\n\n```bash\n# The notebook extenstion should install automatically. You can check by running:\njupyter nbextension list\n# Make sure you have version >=5 of the `notebook` package\npip install \"notebook>=5\"\n# To manually install the extension\njupyter nbextension install --py escher\njupyter nbextension enable --py escher\n# depending on you environment, you might need the `--sysprefix` flag with those commands\n```\n\nTo install the Jupyter lab extension, simply install Escher with `pip install escher` then\ninstall the extension:\n\n```bash\njupyter labextension install @jupyter-widgets/jupyterlab-manager\njupyter labextension install escher\n```\n\n## Python/Jupyter Development\n\nFor development of the Python package, first build the JavaScript package and\ncopy it over to the `py` directory with these commands in the Escher root:\n\n```\nnpm install\nnpm run build\nnpm run copy\n```\n\nThen in the `py` directory, install the Python package:\n\n```\ncd py\npip install -e . # installs escher in develop mode and dependencies\n```\n\nFor Python testing, run this in the `py` directory:\n\n```\ncd py\npytest\n```\n\nTo develop the Jupyter notebook and Jupyter Lab extensions, you will need\ninstall them with symlinks.\n\nFirst, install the Python package for development as described above.\n\nFor the Jupyter notebooks, run:\n\n```\ncd py\njupyter nbextension install --py --symlink escher\njupyter nbextension enable --py escher\n```\n\nIf you are using virtualenv or conda, you can add the `--sys-prefix` flag to\nthose commands to keep your environment isolated and reproducible.\n\nWhen you make changes, you will need to `yarn build && yarn copy` and refresh\nnotebook browser tab.\n\nFor Jupyter Lab, run (in the root directory):\n\n```\nyarn watch # keep this running as a separate process\njupyter labextension install @jupyter-widgets/jupyterlab-manager\njupyter labextension link\njupyter lab --watch\n```\n\nIf you don't see changes when you edit the code, try refreshing or restarting\n`jupyter lab --watch`.\n\n## Docs\n\nBuild and run the docs::\n\n```\ncd docs\n./build_docs\ncd _build/html\npython -m SimpleHTTPServer # python 2\npython -m http.server # python 3\n```\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Escher-legacy: A Web Application for Building, Sharing, and Embedding Data-Rich Visualizations of Metabolic Pathways",
"version": "1.7.4",
"split_keywords": [
"visualization",
"pathway map",
"metabolism",
"genome-scale-model",
"web application",
"d3.js",
"biojs"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "6020c726dbf29d59bde3db6a047d240a0ad9259812e89dfa0ccbd96142f11d67",
"md5": "a504de38a1a4e4eee07c6d94f7168d88",
"sha256": "88793a5c2d0ed3a103a05e9caf0cd585a44ce9a72b0909efd83f9b019aabb656"
},
"downloads": -1,
"filename": "Escher_legacy-1.7.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a504de38a1a4e4eee07c6d94f7168d88",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 1192018,
"upload_time": "2023-01-26T12:21:58",
"upload_time_iso_8601": "2023-01-26T12:21:58.245454Z",
"url": "https://files.pythonhosted.org/packages/60/20/c726dbf29d59bde3db6a047d240a0ad9259812e89dfa0ccbd96142f11d67/Escher_legacy-1.7.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8b2792b9df14cf2d182ee781d71ced757a27b07eb2344c381cbe232f2383d7e2",
"md5": "5506c5d3d473cb2a12c3833cbb1c5c13",
"sha256": "4e3d2308c5fc39070b3121bc85b84a7d031425a7b6dd108a694f25365a8cfecb"
},
"downloads": -1,
"filename": "Escher-legacy-1.7.4.tar.gz",
"has_sig": false,
"md5_digest": "5506c5d3d473cb2a12c3833cbb1c5c13",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 598074,
"upload_time": "2023-01-26T12:22:00",
"upload_time_iso_8601": "2023-01-26T12:22:00.015738Z",
"url": "https://files.pythonhosted.org/packages/8b/27/92b9df14cf2d182ee781d71ced757a27b07eb2344c381cbe232f2383d7e2/Escher-legacy-1.7.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-01-26 12:22:00",
"github": false,
"gitlab": false,
"bitbucket": false,
"lcname": "escher-legacy"
}
JSON