/lcm-dev

Developer repository for the lcm package.

Primary LanguagePythonMIT LicenseMIT

LCM Development Repository

image pre-commit.ci status image

This repository aims to facilitate the development of the package lcm. In particular, here we

  • Generate data that is used in the testing process of lcm
  • Publish the developer documentation, which is designed to explain the inner workings of the lcm code base
  • Create graphical comparisons between lcm and analytical solutions

Getting Started

Get started by installing the conda environment. The conda environment will contain a local installation of lcm. Therefore, we require the following directory structure:

parent_folder
 |-lcm-dev
 |-lcm

Then you can install the environment using

cd /path/to/lcm-dev
mamba env create

and generate all data and figures by running

pytask