diff options
| author | Pjotr Prins | 2022-10-08 17:07:26 -0500 |
|---|---|---|
| committer | Pjotr Prins | 2022-10-08 17:07:26 -0500 |
| commit | 43553eb82b1ed98e308d390bc81b57184f899b91 (patch) | |
| tree | 6798e079975b001aaf7444cfeda8ddab203d4983 /README.md | |
| parent | 660f125d3e448add6005e3998a782ce0d6b57151 (diff) | |
| download | genenetwork3-43553eb82b1ed98e308d390bc81b57184f899b91.tar.gz | |
README: a note on design
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 12 |
1 files changed, 11 insertions, 1 deletions
@@ -6,13 +6,23 @@ badge](https://ci.genenetwork.org/badge/genenetwork3.svg)](https://ci.genenetwor badge](https://ci.genenetwork.org/badge/genenetwork3-pylint.svg)](https://ci.genenetwork.org/jobs/genenetwork3-pylint) [](https://ci.genenetwork.org/jobs/genenetwork3-mypy) -GeneNetwork3 REST API for data science and machine learning +GeneNetwork3 REST API for data science and machine learning + +GeneNetwork3 is a light-weight back-end that serves different front-ends, including the GeneNetwork2 web UI. +Transports happen in multiple ways: + +1. A REST API +2. Direct python library calls (using PYTHONPATH) + +The main advantage is that the code is not cluttered by UX output and starting the webserver and running tests is *easier* than using GeneNetwork2. It allows for using Jupyter Notebooks and Pluto Notebooks as front-ends as well as using the API from R etc. A continuously deployed instance of genenetwork3 is available at [https://cd.genenetwork.org/](https://cd.genenetwork.org/). This instance is redeployed on every commit provided that the [continuous integration tests](https://ci.genenetwork.org/jobs/genenetwork3) pass. + + ## Installation #### GNU Guix packages |