Getting started

Requirements

Before getting started, you need:

• R
• Python 3
• Java >= 17
• Git
• Conda

Programs use

Repository preparation

git clone git@github.com:lotusnprod/lotus-processor.git
cd lotus-processor

Conda environment

An environment.yml file is provided and should allow recreating a working env from the project without being too restrictive on the versions to install. Install it by running the following lines in the home directory:

source ~/anaconda3/etc/profile.d/conda.sh # If your environment is not directly sourced by your default bash
conda env create -f environment.yml
conda activate lotus_env

Having the data in a different place

If you want to have the data in a different place (for example for running a test), you can set the environment variable DATA_PATH.

Docker container

⚠️ Only working on Linux for now If you want to, first install docker on your machine, make sure it is on your path and then:

make docker-build
make docker-bash

The docker-build and docker-bash commands were initially made for our CI integration, and may be useful if you want to use our custom docker environment. The advantage is that you are sure to have the right versions of everything in your image, as it can sometimes be difficult to reproduce other people's environments.

You are now ready for the next steps! See more details under make-commands.

Programs dependency graph

A program dependency graph is available at https://github.com/lotusnprod/lotus-processor/blob/main/docs/flowchart.md. GitHub now supports native Mermaid in markdown files, but not in Wikis.