Skip to content
Snippets Groups Projects

Correct phenotype 'type' property undefined in the API

Closed Hanna JULIENNE requested to merge hot_fix_batch into dev-nuxt
6 files
+ 1092
1029
Compare changes
  • Side-by-side
  • Inline
Files
6
+ 22
11
Installation
============
You can use JASS locally either using the command line interface in a terminal, or by running a web server. Deployment in a public server is also later discussed in this document.
Basic installation
------------------
You can use JASS locally either using the command line interface in a terminal, or by running a web server. Deployment in a public server is also later discussed in this document.
You need **python3** to install and use JASS. As of April 2021, JASS runs on python 3.x with x < 9.
.. warning::
The Installation of JASS crashes for python 3.9 on Windows and on Linux : various packages (including tables) are not compatible with python 3.9. Moreover celery is also not compatible with python 3.9 .
Installation with pip (recommended)
-----------------------------------
We advise users to install jass in a virtual environment
.. code-block:: shell
python3 -m venv $PATH_NEW_ENVIRONMENT
source $PATH_NEW_ENVIRONMENT/bin/activate
pip3 install git+https://gitlab.pasteur.fr/statistical-genetics/jass.git
pip3 install -r https://gitlab.pasteur.fr/statistical-genetics/jass/-/raw/master/requirements.txt
Installation with conda
-----------------------
A procedure for the correct installation of JASS in Anaconda environment for development purpose is developed in detail below.
**1. Create a specific directory and load the code on your laptop (only the first time)**
For example, the directory $HOME/DEVELOP_JASS has been created.
For example, the directory $HOME/DEVELOP_JASS has been created.
In a TERMINAL window, type the following instructions:
.. code-block:: shell
@@ -29,7 +40,7 @@ In a TERMINAL window, type the following instructions:
cd $HOME/DEVELOP_JASS/jass
**3. Create a specific virtual ANACONDA environment for JASS:**
**3. Create a specific virtual ANACONDA environment for JASS:**
.. note::
@@ -64,7 +75,7 @@ In a TERMINAL window, type the following instructions:
pip freeze
Installing it this way will automatically import and setup all of the dependencies required to run JASS.
Installing it this way will automatically import and setup all of the dependencies required to run JASS.
This is pretty much all you need to do to use JASS on the command line, or to run a local personal web server. To deploy JASS on a public web server, please refer to the "Public server deployment" section.
@@ -99,7 +110,7 @@ Then, you can install RabbitMQ with the "choco install" command:
Run JASS as a web application (optional)
----------------------------------------
To run locally JASS as a web application, you need to launch two servers in two different processes, the `celery` task management server and the web server. The web server handles the HTTP requests, and sends all computation requests to the task management server.
To run locally JASS as a web application, you need to launch two servers in two different processes, the `celery` task management server and the web server. The web server handles the HTTP requests, and sends all computation requests to the task management server.
launching the two servers on Linux
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -113,7 +124,7 @@ The command lines below show how to launch the two servers. Please note that you
# launch the web server
jass serve
By default, the Jass server will listen to requests on the port 8080 of your machine. You can control the host and port that the JASS standalone webserver listens to through two environment variables, ``JASS_HOST`` and ``JASS_PORT``, that you just have to set before to launch the web server.
By default, the Jass server will listen to requests on the port 8080 of your machine. You can control the host and port that the JASS standalone webserver listens to through two environment variables, ``JASS_HOST`` and ``JASS_PORT``, that you just have to set before to launch the web server.
Launching the celery server on Windows
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -140,6 +151,6 @@ The web server is launched in another terminal (the same as on Linux):
Public server deployment (optional)
-----------------------------------
Ansible playbooks are available in the `ansible folder of the source repository <https://gitlab.pasteur.fr/statistical-genetics/jass/tree/master/ansible>`_. These playbooks automate the initial configuration of the system (for a server using CentOS), and the initial installation or the update of the code from the repository.
Ansible playbooks are available in the `ansible folder of the source repository <https://gitlab.pasteur.fr/statistical-genetics/jass/tree/master/ansible>`_. These playbooks automate the initial configuration of the system (for a server using CentOS), and the initial installation or the update of the code from the repository.
In this specific deployment, the JASS web application is hosted by an NGINX server, connected through the uWSGI library. It communicates with a celery service that handles the user-launched tasks. Many other deployment options are of course possible, use whichever suits your infrastructure!
In this specific deployment, the JASS web application is hosted by an NGINX server, connected through the uWSGI library. It communicates with a celery service that handles the user-launched tasks. Many other deployment options are of course possible, use whichever suits your infrastructure!
Loading