A collection of modular equations that are used throughout the SimPEG ecosystem.
Equations are an example of a modular piece of text that can be reused. Currently this is hard, and is often not done - especially not between multiple researchers. This repository our first take at that problem in the geophysics community where notation is often dissonant between various research groups.
The goals of equations is to provide a small repository of equations
used in geophysics.
- a collection of equations with consistent notation
- a place to flag issues and have discussions
- increase ease of reuse of equations through writing, presentations and documentation
- meta data about the equation can be provided
- attribution can be given (through citations, git commits etc.)
We will focus on the equations used throughout the SimPEG ecosystem specifically:
- inverse problems
- optimization
- electromagnetics
- potential fields
- vadose zone fluid flow
Copy paste equations. Booooo
- Listen to Lindsey Heagy talk about equation banks in GeoSci at SciPy2016
- Creating modular documents in latex using
inputandinclude - SimPEG project at http://simpeg.xyz
- GitProject for inclusion of this repository in other writing projects
In a latex document, clone the github repository into your working path (use git project or alternative). In the header of your document input the header material:
\input{equations/index}
When you want to include a specific figure, just call that up:
\input{equations/richards/richards-objective-deriv}
This keeps your latex code clean. In our experience, we often work on google docs for collaborative document this allows us to just write minimal latex and copy paste it when ready for a publication view.