Skip to content

Commit 3109ed7

Browse files
KarlLundengaardm-messer
KarlLundengaard
and
m-messer
authored
Updated links and added unit tables to documentation (#162)
* Updated links and added unit tables to documentation * Added missing underscore --------- Co-authored-by: Marcus Messer <12846590+m-messer@users.noreply.github.com> Co-authored-by: Marcus Messer <marcus@marcusm.co.uk>
1 parent 3288ec9 commit 3109ed7

File tree

2 files changed

+46
-43
lines changed

2 files changed

+46
-43
lines changed

‎app/docs/dev.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
=======
12
# CompareExpressions
23
This function utilises the [`SymPy`](https://docs.sympy.org/latest/index.html) to provide a maths-aware evaluation of a learner's response.
34

‎app/docs/user.md‎

Lines changed: 45 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -110,22 +110,24 @@ SI base units based on Table 2 in [The International System of Units (SI), 9th e
110110

111111
Note that gram is used as a base unit instead of kilogram.
112112

113-
| SI base unit | Symbol | Dimension name |
114-
|--------------|:-------|:--------------------|
115-
| metre | m | length |
116-
| gram | g | mass |
117-
| second | s | time |
118-
| ampere | A | electriccurrent |
119-
| kelvin | k | temperature |
120-
| mole | mol | amountofsubstance |
121-
| candela | cd | luminousintensity |
113+
| SI base unit | Symbol | Dimension name |
114+
|--------------|:-------|:----------------------|
115+
| metre | m | `length` |
116+
| gram | g | `mass` |
117+
| second | s | `time` |
118+
| ampere | A | `electric_current` |
119+
| kelvin | k | `temperature` |
120+
| mole | mol | `amount_of_substance` |
121+
| candela | cd | `luminous_intensity` |
122122

123123
###### Table: SI prefixes
124124

125125
SI prefixes based on Table 7 in [The International System of Units (SI), 9th edition](https://www.bipm.org/documents/20126/41483022/SI-Brochure-9-EN.pdf).
126126

127127
| SI Prefix | Symbol | Factor | | SI Prefix | Symbol | Factor |
128128
|-----------|:-------|:-----------|-|-----------|:-------|:-----------|
129+
| quetta | Q | $10^{30}$ | | deci | d | $10^{-1}$ |
130+
| ronna | R | $10^{27}$ | | centi | c | $10^{-2}$ |
129131
| yotta | Y | $10^{24}$ | | deci | d | $10^{-1}$ |
130132
| zetta | Z | $10^{21}$ | | centi | c | $10^{-2}$ |
131133
| exa | E | $10^{18}$ | | milli | m | $10^{-3}$ |
@@ -174,54 +176,54 @@ Note that the function treats angles, neper and bel as dimensionless values.
174176

175177
Note that only the first table in this section has short form symbols defined, the second table does not, this is done to minimize ambiguities when writing units.
176178

177-
| Unit name | Symbol | Expressed in SI units |
179+
|| Unit name | Symbol | Expressed in SI units |
178180
|-------------------|:-------|:-------------------------------------------|
179-
| minute | min | $60 \mathrm{second}$ |
180-
| hour | h | $3600 \mathrm{second}$ |
181-
| degree | deg | $\frac{1}{360}$ |
182-
| liter | l | $10^{-3} \mathrm{metre}^3$ |
183-
| metric_ton | t | $10^3 \mathrm{kilogram}$ |
181+
| minute | min | $60~\mathrm{second}$ |
182+
| hour | h | $3600~\mathrm{second}$ |
183+
| degree | deg | $\frac{\pi}{180}$ |
184+
| liter | l | $10^{-3}~\mathrm{metre}^3$ |
185+
| metric_ton | t | $10^3~\mathrm{kilogram}$ |
184186
| neper | Np | $1$ |
185-
| bel | B | $\frac{1}{2} \ln(10)$ |
186-
| electronvolt | eV | $1.60218 \cdot 10^{-19} \mathrm{joule}$ |
187-
| atomic_mass_unit | u | $1.66054 \cdot 10^{-27} \mathrm{kilogram}$ |
188-
| angstrom | å | $10^{-10} \mathrm{metre}$ |
187+
| bel | B | $\frac{1}{2}~\ln(10)$ |
188+
| electronvolt | eV | $1.60218 \cdot 10^{-19}~\mathrm{joule}$ |
189+
| atomic_mass_unit | u | $1.66054 \cdot 10^{-27}~\mathrm{kilogram}$ |
190+
| angstrom | å | $10^{-10}~\mathrm{metre}$ |
189191

190192
| Unit name | Expressed in SI units |
191193
|------------------|:-----------------------------------------------------|
192-
| day | $86400 \mathrm{second}$ |
194+
| day | $86400~\mathrm{second}$ |
193195
| angleminute | $\frac{\pi}{10800}$ |
194196
| anglesecond | $\frac{\pi}{648000}$ |
195-
| astronomicalunit | $149597870700 \mathrm{metre}$ |
196-
| nauticalmile | $1852 \mathrm{metre}$ |
197-
| knot | $\frac{1852}{3600} \mathrm{metre second}^{-1}$ |
198-
| are | $10^2 \mathrm{metre}^2$ |
199-
| hectare | $10^4 \mathrm{metre}^2$ |
200-
| bar | $10^5 \mathrm{pascal}$ |
201-
| barn | $10^{-28} \mathrm{metre}$ |
202-
| curie | $3.7 \cdot 10^{10} \mathrm{becquerel} |
203-
| roentgen | $2.58 \cdot 10^{-4} \mathrm{kelvin (kilogram)}^{-1}$ |
204-
| rad | $10^{-2} \mathrm{gray}$ |
205-
| rem | $10^{-2} \mathrm{sievert}$ |
197+
| astronomicalunit | $149597870700~\mathrm{metre}$ |
198+
| nauticalmile | $1852~\mathrm{metre}$ |
199+
| knot | $\frac{1852}{3600}~\mathrm{metre~second}^{-1}$ |
200+
| are | $10^2~\mathrm{metre}^2$ |
201+
| hectare | $10^4~\mathrm{metre}^2$ |
202+
| bar | $10^5~\mathrm{pascal}$ |
203+
| barn | $10^{-28}~\mathrm{metre}$ |
204+
| curie | $3.7 \cdot 10^{10}~\mathrm{becquerel} |
205+
| roentgen | $2.58 \cdot 10^{-4}~\mathrm{kelvin~(kilogram)}^{-1}$ |
206+
| rad | $10^{-2}~\mathrm{gray}$ |
207+
| rem | $10^{-2}~\mathrm{sievert}$ |
206208

207209
###### Table: Imperial units
208210

209211
Commonly imperial units taken from [Wikipedia, Imperial Units](https://en.wikipedia.org/wiki/Imperial_units)
210212

211213
| Unit name | Symbol | Expressed in SI units |
212214
|-------------------|:-------|:----------------------------------------------|
213-
| inch | in | $0.0254 \mathrm{metre}$ |
214-
| foot | ft | $0.3048 \mathrm{metre}$ |
215-
| yard | yd | $0.9144 \mathrm{metre}$ |
216-
| mile | mi | $1609.344 \mathrm{metre}$ |
217-
| fluid ounce | fl oz | $28.4130625 \mathrm{millilitre}$ |
218-
| gill | gi | $142.0653125 \mathrm{millilitre}$ |
219-
| pint | pt | $568.26125 \mathrm{millilitre}$ |
220-
| quart | qt | $1.1365225 \mathrm{litre}$ |
221-
| gallon | gal | $4546.09 \mathrm{litre}$ |
222-
| ounce | oz | $28.349523125 \mathrm{gram}$ |
223-
| pound | lb | $0.45359237 \mathrm{kilogram}$ |
224-
| stone | st | $6.35029318 \mathrm{kilogram}$ |
215+
| inch | in | $0.0254~\mathrm{metre}$ |
216+
| foot | ft | $0.3048~\mathrm{metre}$ |
217+
| yard | yd | $0.9144~\mathrm{metre}$ |
218+
| mile | mi | $1609.344~\mathrm{metre}$ |
219+
| fluid ounce | fl oz | $28.4130625~\mathrm{millilitre}$ |
220+
| gill | gi | $142.0653125~\mathrm{millilitre}$ |
221+
| pint | pt | $568.26125~\mathrm{millilitre}$ |
222+
| quart | qt | $1.1365225~\mathrm{litre}$ |
223+
| gallon | gal | $4546.09~\mathrm{litre}$ |
224+
| ounce | oz | $28.349523125~\mathrm{gram}$ |
225+
| pound | lb | $0.45359237~\mathrm{kilogram}$ |
226+
| stone | st | $6.35029318~\mathrm{kilogram}$ |
225227

226228
#### `plus_minus` and `minus_plus`
227229

0 commit comments

Comments
 (0)