wiki:WikiStart

Version 27 (modified by tirons, 6 months ago) (diff)

--

Lemma is an Electromagnetics Modelling API

Overview

  • Lemma has an expressive API
  • Lemma employs a modern test-driven development
  • Lemma is 100% C++, currently we require a C++-14 compliant compiler
  • Lemma has bindings and integration with VTK
  • Lemma provides excellent multi-core performance
  • Lemma objects employ class serialization using YAML.

Getting the code

Lemma uses git. The project is hosted here on our own website:

git clone https://git.lemmasoftware.org/Lemma.git

If you prefer to use GitHub, Lemma is mirrored there as well, pull requests can be managed though GitHub too https://github.com/LemmaSoftware/Lemma.

git clone https://git.github.com/LemmaSoftware/Lemma.git

Read only anonymous access is permitted at either site. If you would like to contribute and obtain write access please email info for a username and password.

Modules

Lemma is modular, compile and bundle only what you need. There are several modules provided with the main project.

  1. LemmaCore (required) - Provides base classes which all Lemma objects inherit from
  2. FDEM1D (optional) - Frequency domain 1D forward modelling of Maxwell's equations
  3. TEM1D (optional) - Time domain 1D forward modelling of Maxwell's equations
  4. Several other modules are being ported over from prior versions of Lemma.

Lemma is extensible, in addition to the main modules, you can easily plugin additional modules.

  1. EMSchur3D - 3D solution of Maxwell's equations.
  2. Merlin - Merlin provides surface NMR functionality to Lemma including 1D inversion
  3. FEM4EllipticPDE - This is a finite element solver of general elliptic PDE problems.

Documentation

  • Doxygen generated man pages are index.

Benchmarks and testing

Lemma ComparesWell with existing FORTRAN 77 codes and also ScalesWell on multi-processor machines. Lemma uses CxxTest, results are posted using CDash

Requirements

The only hard dependencies prior to installation are a C++ compiler, git, and CMake

  • C++ Compiler - we actively test against GCC (gcc-7, gcc-8), Microsoft Visual C++, clang, and the Intel compiler (icpc)
  • git - a distributed version control software needed for the build process
  • CMake - v3 or higher, CMake is a cross-platform platform for building software

Bundled dependencies

Several additional dependencies are bundled with Lemma, all have liberal licenses and should place minimal restrictions on any use of Lemma.

  • Eigen 3 C++ linear algebra (header) library
  • yaml-cpp
  • CxxTest (optional, CxxTest also requires a working python interpreter)

Optional dependencies

  • VTK is needed for visualisation. VTK is released under a BSD license.
  • Boost special functions are used in several classes.
  • Python interpreter is required if CxxTest is used.

Compiler support

We actively test against GCC versions 6-8, Intel 13.0.1, Clang++, and Microsoft Visual C.

Platform support

Lemma has been successfully compiled on Linux (our primary platform) Windows ( XP, Vista, 7, and 8), as well as Max OS X.

Linux

Most Linux package managers handle all the dependencies for Lemma, and the Lemma install process should proceed smoothly in a UNIX/Un*x environment.

MacOS

Compilation on MacOS using clang++ is relatively straightforward with the caveat that Clang on macOS still does not support OpenMP preprocessor directives. Notes on working around this can be found in MacNotes.

Windows

The preferred compilation approach is shown in AnacondaWindowsNotes which relies on the Anaconda Python Distribution as a means to install third-party software including git, CMake, and VTK. This approach uses the Microsoft Visual C++ compiler.

License

Lemma is available under the Mozilla Public License, v. 2.0. MPL. This is a fairly weak copyleft license, which stipulates that while the code can be used for any purpose, changes made to specific files must be shared back with the community on a file by file basis. Much of the code is covered by

  • Copyright (C) 2009--2018 Trevor Irons
  • Copyright (C) 2010, 2011, 2012 Colorado School of Mines.
  • Copyright (C) 2010--2013 M. Andy Kass.

Support

Email questions to support.

Bug reports

File a ticket using this website.

Contributing

Interested in contributing? Great. Whether you are interested in extending Lemma, improving some aspect, or just making the documentation better, we welcome contributions. Some links that might be useful

Citing Lemma

Lemma has been built in collaboration with the department of Geophysics at the Colorado School of Mines, specifically CGEM the United States Geological Survey http://crustal.usgs.gov and the University of Utah https://egi.utah.edu.

Our primary authors are Trevor Irons and M. Andy Kass.

Lemma has extended public domain code from Walt Anderson, Alan Chave, and Ki Ha Lee. In all cases original FORTRAN 77 codes were ported and reworked into our modern framework. We are grateful for their fine contributions to the public domain. Please keep in mind use of their code does not imply endorsement. An example BibTeX entry is provided below. If you are using a module with different primary authors, it may be appropriate to modify this entry.

@MISC{LemmaWeb,
  author = {Trevor Irons and M. Andrew Kass and others},
  title = {Lemma v1},
  howpublished = {https://lemmasoftware.org},
  year = {2012}
 }