Commit 1418b35a authored by Nathalie Rousse's avatar Nathalie Rousse
Browse files

misc (install documentation, minor things...)

parent fec6607f
Pipeline #832 failed with stages
in 31 seconds
*******************************************************************************
vle-1.0
vle-x
The webrecord project (2011-2014), web solutions for models of the Record
platform : a web application prototype that enables remote simulations of
some existing agronomic models developped with vle-1.0.3 version, that have
been previously loaded into the web tool.
erecord project (from 2018) : the web services provided by erecord allow to
edit, modify and simulate some vle models, such as the Record platform ones.
An archive of the webrecord site dedicated to the webrecord project
presentation and productions (no longer online) :
http://147.100.164.34/misc/webrecord/webrecord.pdf
*******************************************************************************
vle-1.1
Features :
The erecord project is dedicated to the Record platform web development,
concerning more specifically its models developed with vle-1.1 version. The
web services provided by erecord allow to edit, modify and simulate some vle
models, such as the Record platform ones.
- Version using erecord package instead of pyvle.
Version using pyvle.
- Version supporting several vle versions (vle-1.1.3, vle-2.0.0...).
Is the version installed under erecord VM (147.100.164.34).
erecord.toulouse.inra.fr
Is the version under development.
*******************************************************************************
vle-x
The erecord project : the web services provided by erecord allow to edit,
modify and simulate some vle models, such as the Record platform ones.
vle-1.1
Version under development.
The erecord project (2014-2018) is dedicated to the Record platform web
development, concerning more specifically its models developed with vle-1.1
version. The web services provided by erecord allow to edit, modify and
simulate some vle models, such as the Record platform ones.
Features :
Version using pyvle.
- Version using erecord package instead of pyvle.
Is the version installed under erecord VM (erecord.toulouse.inra.fr).
- Should support several vle versions (vle-1.1, vle-2).
*******************************************************************************
vle-1.0
- Tests about using genotoul cluster.
The webrecord project (2011-2014), web solutions for models of the Record
platform : a web application prototype that enables remote simulations of
some existing agronomic models developped with vle-1.0.3 version, that have
been previously loaded into the web tool.
- Docs for installs : centos (genotoul VM 147.99.108.17),
debian (erecord VM 147.100.164.34).
An archive of the webrecord site dedicated to the webrecord project
presentation and productions (no longer online) :
http://147.100.164.34/misc/webrecord/webrecord.pdf
*******************************************************************************
!!!
...voir ~/workspace_git/DEVELOPPEMENT_WEB/recordweb/vle-x/trunk/erecord/erecord/install/dev_run.txt !!!
...voir ~/workspace_git/DEVELOPPEMENT_WEB/recordweb/vle-x/trunk/erecord/erecord/install/run.txt !!!
!!!
===============================================================================
vle-x version of erecord development
===============================================================================
......
......@@ -42,33 +42,33 @@ The erecord project software is developed with :
.. literalinclude:: ../../../../erecord/install/requirement.txt
The stored models software :
- have previously been developed with vle (vle-1.1 version), a C++ platform.
- are interfaced with erecord software by pyvle (pyvle-1.1 version).
The stored models software have previously been developed with vle, that is a C++ platform.
Deployment environment
----------------------
The software is deployed on a virtual machine with **Debian 8** (*Jessie*),
The software is deployed on a virtual machine with **Debian 9.5** (*Stretch*),
**Apache2.4** server and **mod_wsgi**.
*Django’s primary deployment platform is WSGI, the Python standard for web
servers and applications. mod_wsgi is an Apache module which can host any
Python WSGI application, including Django.*
Installation procedure in 'from scratch' case
=============================================
Installation procedure
======================
See :ref:`devel_deployment_fromscratch_case`.
- :ref:`devel_deployment_install_erecord`
- :ref:`devel_deployment_install_vle`
- :ref:`devel_deployment_install_vle_repositories`
Running instructions
====================
See :ref:`deploy_run_server`.
Installation procedure in updating case
=======================================
OLDASUPPRIMER
=============
See :ref:`devel_deployment_updating_case`.
See :ref:`devel_deployment_fromscratch_case`.
.. _devel_deployment_install_erecord:
=======================
Installation of erecord
=======================
.. literalinclude:: ../../../../erecord/install/debian/apache2.4/install.txt
.. _devel_deployment_install_vle:
===================
Installation of vle
===================
Case of vle-1.1.3 version
=========================
.. literalinclude:: ../../../../erecord/install/install_vle_1.1.3.txt
Case of vle-2.0.0 version
=========================
.. literalinclude:: ../../../../erecord/install/install_vle_2.0.0.txt
.. _devel_deployment_install_vle_repositories:
==================================================
Installation of models repositories (vle packages)
==================================================
.. literalinclude:: ../../../../erecord/install/install_vle_repositories_notes.txt
Case of vle-1.1.3 version
=========================
.. literalinclude:: ../../../../erecord/install/install_vle_1.1.3_repositories.txt
Case of vle-2.0.0 version
=========================
.. literalinclude:: ../../../../erecord/install/install_vle_2.0.0_repositories.txt
......@@ -16,14 +16,3 @@ The 'outselect' option is used to choose the restituted output datas.
named vname (the output datas of this view, that are not selected like
this, are unselected).
.. note::
The 'outselect' option is available only in 'dataframe' restype case, the
restituted output datas are not filtered in 'matrix' restype case.
Temporarily, the 'outselect' option is not available in case of both
'dataframe' restype and 'linear' plan.
As a result, the 'outselect' option is available only in case of both
'dataframe' restype and 'single' plan.
......@@ -12,11 +12,32 @@ The **main documentation** of erecord project is produced with Sphinx.
Sphinx is a documentation generator which converts reStructuredText files into
HTML websites and other formats including PDF, EPub and man).
There is some **other external documentation**, for example html home and pattern pages produced for erecord simulators (with a specific python script).
There is some **other external documentation**, for example html home pages produced for erecord simulators (with a specific python script).
Production and generation
=========================
Main documentation
------------------
See "**Main documentation generation**" into
:ref:`devel_deployment_install_erecord`.
Some other external documentation
---------------------------------
See "**Simulators home pages generation**" into
:ref:`devel_deployment_install_erecord`.
OLD A SUPPRIMER
===============
Prerequisite
------------
......
......@@ -13,29 +13,19 @@ Intellectual property
Source code repository
----------------------
The erecord **source code repository** is hosted on the recordweb
project of the Mulcyber software forge
https://mulcyber.toulouse.inra.fr/projects/recordweb, where its path is
**vle-1.1/trunk** under Subversion (*see 'Dépôt de sources'*).
The erecord source code repository is hosted on the **recordweb**
project of **forgemia** (*forge of MIA Department of INRA Institute*)
https://forgemia.inra.fr/record/recordweb.
.. _erecord_contacts:
Contacts
--------
You are invited to use the erecord tracking tools :
The erecord tracking tools are those of the recordweb project of the
Mulcyber software forge, under
https://mulcyber.toulouse.inra.fr/projects/recordweb :
- ' **Bug Report** ' to notice a bug.
- ' **Feature Request** ' to ask for new functions.
You may find answers to your own questions in :ref:`faqs`.
You can send mail to Nathalie Rousse (INRA, MIAT, RECORD Team Member)
at nathalie.rousse@inra.fr.
: nathalie.rousse@inra.fr (*help, notice a bug, ask for new functions...*).
More
====
......
......@@ -8,11 +8,18 @@ Contains the configuration : paths, constants...
import os
import datetime
base_dir = os.path.dirname(os.path.abspath(__file__))
"""base directory path"""
PACKAGE_HOME = os.path.normpath(os.path.join(base_dir, "..", "..", ".."))
"""erecord package home path"""
OPT_LOCATION = True
"""OPT_LOCATION value False or True \n
True if erecord is located under '/opt', and else relative location
"""
if OPT_LOCATION is True :
PACKAGE_HOME = "/opt/erecord/erecord"
"""erecord package home path"""
else :
PACKAGE_HOME = os.path.normpath(os.path.join(base_dir, "..", "..", ".."))
"""erecord package home path"""
PROJECT_HOME = os.path.normpath(os.path.join(PACKAGE_HOME, ".."))
"""erecord project home path"""
......
......@@ -46,7 +46,7 @@ def get_vleversionusrpath_choices() :
ht_vleversion_usr_path = mht_vleversion_usr_path+ \
" Choose a directory among those existing ones under "+ \
REPOSITORIES_HOME+"."
INSTALL_HOME+"."
class VleVersionForm(forms.ModelForm):
......
*******************************************************************************
Install erecord
Install erecord
*******************************************************************************
Case of development under ubuntu
================================
see ubuntu/install.txt
see /opt/erecord/erecord/install/ubuntu/install.txt
Case of production under debian
===============================
"RENAME" : ln -s /home/nrousse/workspace_git/DEVELOPPEMENT_WEB/recordweb/vle-x/trunk/erecord /opt/erecord
General
-------
The erecord project software is developed with :
- python language (python 2.7 version),
- django framework,
- some django applications, like for example django-rest-framework.
- SQLite for databases.
- Sphinx for documentation.
Some other basic required tools :
- virtualenv
- install LibYAML version 0.1.5 :
* Download and extract the source package :
wget http://pyyaml.org/download/libyaml/yaml-0.1.5.tar.gz
tar -zxvf yaml-0.1.5.tar.gz
* Build and install LibYAML :
./configure
make
sudo make install
- install about libcurl :
sudo apt-get install libcurl4-openssl-dev
sudo apt-get install libssl-dev
Installation of the erecordenv virtualenv
-----------------------------------------
* erecordenv creation :
virtualenv /opt/erecord/factory/install/erecordenv -p /usr/bin/python2.7 --no-site-packages
* erecordenv virtualenv activation
* in bash or sh case :
source /opt/erecord/factory/install/erecordenv/bin/activate
* in csh or tcsh case :
source /opt/erecord/factory/install/erecordenv/bin/activate.csh
* just to control the activation on the erecordenv virtualenv :
which python
* installation from requirement.txt :
pip install -r /opt/erecord/erecord/install/requirement.txt
erecord software modifications and generations
----------------------------------------------
* /opt/erecord/erecord/apps/erecord_cmn/configs/config.py :
IN_PRODUCTION = False
ONLINEDOC_URL = 'http://erecord.toulouse.inra.fr/docs.html' ...?
* opt/erecord/erecord/projects/ws/ws/settings.py :
DEBUG = True
* /opt/erecord/docs/source/devel/design/webapi/include/online_url.rst and
/opt/erecord/docs/source/devel/design/webapi/include/online_*.rst :
Put the appropriate url value : http://erecord.toulouse.inra.fr:8000 ...?
(commands, if '127.0.0.1' has to be replaced by 'erecord.toulouse.inra.fr' into online_*.rst files :
cd /home/erecord/save/opt/erecord/docs/source/devel/design/webapi/include ;
sed -i 's/127.0.0.1/erecord.toulouse.inra.fr/g' online_url*.rst ; )
* DOC STATIC...
Install vle
-----------
* Install vle and its dependencies, models repositories
(vle-1.1.3 version, vle-2.0.0 version) :
see install_vle.txt
see /opt/erecord/erecord/install/debian/apache2.4/install.txt
*******************************************************************************
*******************************************************************************
Install vle and models repositories (vle packages)
Install vle and models repositories (vle packages)
*******************************************************************************
Case of development under ubuntu
================================
Notes
=====
see ubuntu/install_vle.txt
Some rules about models repositories :
see /opt/erecord/erecord/install/install_vle_notes.txt
*******************************************************************************
Install vle
*******************************************************************************
Case of vle-1.1.3 version
=========================
see install_vle_1.1.3.txt
Case of vle-2.0.0 version
=========================
see install_vle_2.0.0.txt
*******************************************************************************
Install models repositories (vle packages)
*******************************************************************************
Case of vle-1.1.3 version
=========================
see install_vle_1.1.3_repositories.txt
Case of vle-2.0.0 version
=========================
see install_vle_2.0.0_repositories.txt
*******************************************************************************
*******************************************************************************
Install vle
Case of :
- development under ubuntu
- vle-1.1.3 version
Case of vle-1.1.3 version
*******************************************************************************
"RENAME" : ln -s /home/nrousse/workspace_git/DEVELOPPEMENT_WEB/recordweb/vle-x/trunk/erecord /opt/erecord
"RENAME" erecord path as /opt/erecord, for example :
ln -s /home/nrousse/workspace_git/DEVELOPPEMENT_WEB/recordweb/vle-x/trunk/erecord /opt/erecord
INSTALL vle-1.1.3 and its dependencies
======================================
* Dependencies (Ubuntu 16.04) : (nothing more than for vle-2.0.0)
* Dependencies (Ubuntu 16.04 case) : (nothing more than for vle-2.0.0)
* VLE :
......
*******************************************************************************
Install models repositories (vle packages)
Case of :
- development under ubuntu
- vle-1.1.3 version
Case of vle-1.1.3 version
*******************************************************************************
"RENAME" : ln -s /home/nrousse/workspace_git/DEVELOPPEMENT_WEB/recordweb/vle-x/trunk/erecord /opt/erecord
"RENAME" erecord path as /opt/erecord, for example :
ln -s /home/nrousse/workspace_git/DEVELOPPEMENT_WEB/recordweb/vle-x/trunk/erecord /opt/erecord
The install of some public models repositories are described here, as examples
so that you can delivery your own models repositories under
......@@ -97,6 +95,7 @@ Containing :
- recordb packages :
cd /opt/erecord/factory/install/REPOSITORIES_deliveries/vle-1.1.3/recordb
Note : recordb/mulcyber --> now RECORD/forgemia
git clone git+ssh://rousse@mulcyber.toulouse.inra.fr//var/lib/gforge/chroot/scmrepos/git/recordb/recordb.git
cd recordb/pkgs
vle -P tester configure build
......
*******************************************************************************
Install vle
Case of :
- development under ubuntu
- vle-2.0.0 version
Case of vle-2.0.0 version
*******************************************************************************
"RENAME" : ln -s /home/nrousse/workspace_git/DEVELOPPEMENT_WEB/recordweb/vle-x/trunk/erecord /opt/erecord
"RENAME" erecord path as /opt/erecord, for example :
ln -s /home/nrousse/workspace_git/DEVELOPPEMENT_WEB/recordweb/vle-x/trunk/erecord /opt/erecord
INSTALL vle-2.0.0 and its dependencies
......@@ -18,8 +17,7 @@ INSTALL vle-2.0.0 and its dependencies
* Dependencies : Boost (...using mpi)
- Install dependencies (Ubuntu 16.04) :
- Install dependencies (Ubuntu 16.04 case) :
sudo apt-get update
sudo apt-get install curl libxml2-dev libboost-dev cmake pkg-config g++
......
*******************************************************************************
Install models repositories (vle packages)
Case of :
- development under ubuntu
- vle-2.0.0 version
Case of vle-2.0.0 version
*******************************************************************************
"RENAME" : ln -s /home/nrousse/workspace_git/DEVELOPPEMENT_WEB/recordweb/vle-x/trunk/erecord /opt/erecord
"RENAME" erecord path as /opt/erecord, for example :
ln -s /home/nrousse/workspace_git/DEVELOPPEMENT_WEB/recordweb/vle-x/trunk/erecord /opt/erecord
The install of some public models repositories are described here, as examples
so that you can delivery your own models repositories under
......@@ -83,6 +82,7 @@ Containing :
- recordb packages :
cd /opt/erecord/factory/install/REPOSITORIES_deliveries/vle-2.0.0/recordb
Note : recordb/mulcyber --> now RECORD/forgemia
git clone git+ssh://rousse@mulcyber.toulouse.inra.fr//var/lib/gforge/chroot/scmrepos/git/recordb/recordb.git
cd recordb
git checkout -b using2.0 origin/using2.0
......
*******************************************************************************
Install models repositories (vle packages)
*******************************************************************************
Some rules about models repositories
====================================
- Each models repository must contain the erecord package :
see /opt/erecord/repositories/deliveries/README.txt
- If a models repository contains the erecord_conf folder (optional), then
its simulators (vpz file) will be able to be declared as VpzPath :
see /opt/erecord/repositories/deliveries/README.txt
*******************************************************************************
*******************************************************************************
Run erecord
......@@ -8,20 +7,20 @@
Case of development under ubuntu
================================
"RENAME" : ln -s /home/nrousse/workspace_git/DEVELOPPEMENT_WEB/recordweb/vle-x/trunk/erecord /opt/erecord
"RENAME" erecord path as /opt/erecord, for example :
ln -s /home/nrousse/workspace_git/DEVELOPPEMENT_WEB/recordweb/vle-x/trunk/erecord /opt/erecord
cd /opt/erecord/erecord/projects/ws
erecordenv
----------
erecordenv activation
---------------------
#source ../../../factory/install/erecordenv/bin/activate.csh
source ../../../factory/install/erecordenv/bin/activate ; which python