mirror of
https://github.com/ivan-usov-org/bec.git
synced 2025-04-21 18:20:01 +02:00
171 lines
4.6 KiB
ReStructuredText
171 lines
4.6 KiB
ReStructuredText
#############
|
|
Installation
|
|
#############
|
|
|
|
BEC can be installed differently depending on the use case. For testing and exploring, a light-weight version can be installed following the instructions in `Install BEC (test system)`_.
|
|
For a production system using Docker, please follow the instructions given in `Install BEC using Docker (production system)`_.
|
|
|
|
*************************
|
|
Install BEC (test system)
|
|
*************************
|
|
|
|
Prerequisites
|
|
=============
|
|
|
|
Redis
|
|
------
|
|
To install Redis, you can either use conda
|
|
|
|
.. code-block:: bash
|
|
|
|
conda install redis
|
|
|
|
or install it manually by following the instructions `here <https://redis.io/docs/getting-started/>`_. Once installed, start it with
|
|
|
|
.. code-block:: bash
|
|
|
|
redis-server
|
|
|
|
If you prefer to run redis in Docker, you can also follow the instructions in `Start docker containers for MongoDB, SciBec API server, and Redis`_ instead of installing it through conda.
|
|
|
|
|
|
Python environment
|
|
-------------------
|
|
|
|
User environment
|
|
^^^^^^^^^^^^^^^^^^
|
|
|
|
If you want to install the BEC server as a user and not for development purposes, you can create a Python (>= 3.8) environment using
|
|
|
|
.. code-block:: bash
|
|
|
|
python -m venv ./bec_venv
|
|
source ./bec_venv/bin/activate
|
|
|
|
and install the BEC server using
|
|
|
|
.. code-block:: bash
|
|
|
|
pip install bec-server
|
|
|
|
Once installed, you can start the server using
|
|
|
|
.. code-block:: bash
|
|
|
|
bec-server start
|
|
|
|
|
|
Development environment
|
|
^^^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
If you want to install the BEC server for development purposes, make sure you have git and conda installed. Then, run
|
|
|
|
.. code-block:: bash
|
|
|
|
git clone https://gitlab.psi.ch/bec/bec.git
|
|
cd bec
|
|
|
|
source ./bin/install_bec_dev.sh
|
|
|
|
Once everything is installed, run
|
|
|
|
.. code-block:: bash
|
|
|
|
bec-server start
|
|
|
|
|
|
.. include:: install/install_bec_services.rst
|
|
|
|
.. include:: install/start_python_services.rst
|
|
|
|
.. include:: install/start_client.rst
|
|
|
|
You are now ready to load your first device configuration. To this end, please follow the instructions given in :doc:`quickstart`.
|
|
|
|
|
|
|
|
********************************************
|
|
Install BEC using Docker (production system)
|
|
********************************************
|
|
|
|
Prerequisites
|
|
=============
|
|
|
|
Install docker
|
|
--------------
|
|
- Linux: https://docs.docker.com/desktop/install/linux-install/
|
|
- macOS: https://docs.docker.com/desktop/install/mac-install/
|
|
|
|
Create a new virtual environment
|
|
--------------------------------
|
|
|
|
.. note:: The minimum python version is 3.8. Although newer python versions are being tested, they are currently not actively supported.
|
|
|
|
Python environment
|
|
^^^^^^^^^^^^^^^^^^
|
|
.. code-block:: bash
|
|
|
|
python -m venv ./bec_venv
|
|
source ./bec_venv/bin/activate
|
|
|
|
|
|
Conda environment
|
|
^^^^^^^^^^^^^^^^^^
|
|
|
|
Instead of using a python environment, you can also use conda
|
|
|
|
- Linux: https://docs.conda.io/projects/conda/en/latest/user-guide/install/linux.html
|
|
- macOS: https://docs.conda.io/projects/conda/en/latest/user-guide/install/macos.html
|
|
|
|
.. code-block:: bash
|
|
|
|
conda create --name bec python=3.8
|
|
conda activate bec
|
|
|
|
|
|
Start backend services
|
|
======================
|
|
The easiest way of starting the backend services (MongoDB, SciBec and Redis) is to use Docker. Follow the instructions in `Start docker containers for MongoDB, SciBec API server, and Redis`_
|
|
|
|
Alternatively, you can also install them locally without Docker. Please follow the instructions on the official documentation for `MongoDB <https://www.mongodb.com/docs/manual/installation/>`_ , `Loopback 4 for SciBec <https://loopback.io/doc/en/lb4/Getting-started.html>`_ and `Redis <https://redis.io/docs/getting-started/>`_.
|
|
|
|
.. include:: install/start_docker_container.rst
|
|
|
|
|
|
.. include:: install/install_bec_services.rst
|
|
|
|
|
|
Update the configuration of the current session
|
|
================================================
|
|
|
|
.. NOTE::
|
|
Before you can update or modify the configuration, MongoDB AND the SciBec API server must be running. It's okay if the other services are not started.
|
|
|
|
Please activate the proper environment as needed.
|
|
|
|
Create a config file
|
|
---------------------
|
|
|
|
.. include:: install/create_config.rst
|
|
|
|
.. _update_session:
|
|
|
|
Upload the (newly created) config file to SciBec
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
.. code-block:: bash
|
|
|
|
cd ./scibec; python ./init_scibec/update_sessions.py
|
|
|
|
By default, :file:`update_sessions.py` will look for a config file :file:`./init_scibec/demo_config.yaml`. If you have specified a different name, you can use the `--config` option of :file:`update_sessions.py`, e.g.
|
|
|
|
.. code-block:: bash
|
|
|
|
cd ./scibec; python ./init_scibec/update_sessions.py --config <path/to/my/yaml/file.yaml>
|
|
|
|
|
|
.. include:: install/start_python_services.rst
|
|
|
|
.. include:: install/start_client.rst
|
|
|