WhatsThatFormula

An online cheatsheet for engineers

This repository maintain data for WhatsThatFormula, built and maintained by Valispace.

Format

  {
        "name": "{Formula name}",
        "latex": "$$ {formula TeX code here} $$",
        "description": "{give a short description for the formula}",
        "definition": {
            "{variable1}": "{description}",
            "{variable2}": "{description}",
            "{variablen}": "{description}"
            
        },
        "keywords": [
            "{keyword1}",
            "{keyword2}",
            "{keywordn}"
        ],
        "tags": [
            "{tag1}",
            "{tag2}"
        ],
        "href": "{Insert a link to find more details}",
        "contributed_by": "{Your Name}"
    }

A formula entry looks like this example.

Contribute

1. Head over to Contribute Form
2. Append this to the data.json.
3. Submit a pull request to update the data.json.
4. Your entry will be up on the website, as soon as it is verified!

Thanks for your contribution!

Extra Notes

• For the latex field, the formula is enclosed between $$ $$, and use double backslash \\ for commands. e.g. \\pi, \\Delta , \\frac{}{} etc.
• For inline LaTeX command use '\( ... \)'
• Keywords are used for search. e.g. the rocket equation can be described by keywords: ["rocket", "delta-v", "tsiolkovski", "momentum"]
• Tags are used for categorization: e.g. the rocket equation can be categorized by tags: ['Aerospace', 'Propulsion']

Thank you for your contribution to this cheat sheet!

Use issues to tell us about any problems you face during contribution