Skip to content

Commit 1a55e18

Browse files
committed
docs: generated systems linked from other documentation chapters
1 parent 55dece2 commit 1a55e18

File tree

6 files changed

+49
-33
lines changed

6 files changed

+49
-33
lines changed

docs/users_guide/systems/cgs.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -257,6 +257,8 @@ For general engineering and most modern scientific work, [SI units](si.md) are r
257257
258258
## References
259259
260-
- [CGS Units on Wikipedia](https://en.wikipedia.org/wiki/Centimetre%E2%80%93gram%E2%80%93second_system_of_units)
261-
- [International System of Units (SI)](si.md)
260+
- [CGS Systems Reference](../../reference/systems_reference/systems/cgs.md) - Complete
261+
list of units
262262
- [Systems of Units](../framework_basics/systems_of_units.md) - Framework basics
263+
- [International System of Units (SI)](si.md)
264+
- [CGS Units on Wikipedia](https://en.wikipedia.org/wiki/Centimetre%E2%80%93gram%E2%80%93second_system_of_units)

docs/users_guide/systems/iau.md

Lines changed: 22 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -15,12 +15,23 @@ The **mp-units** IAU system implements:
1515
- **CODATA 2018**: Measured values for the Newtonian gravitational constant G and derived
1616
_masses_
1717

18-
!!! tip "When to Use"
18+
!!! tip "Astronomy Utilities"
1919

20-
- Use **`iau`** for professional astronomy/astrophysics calculations requiring IAU standard values
21-
- Use **`astronomy`** utilities (see tip at the end) for common astronomy units like light-years,
22-
jansky, or sidereal days
23-
- The two can be used together when needed
20+
For commonly used astronomy units not standardized by the IAU (such as light-years,
21+
jansky, sidereal days, Julian years, etc.), see the `astronomy` utility system:
22+
23+
```cpp
24+
#include <mp-units/systems/astronomy.h>
25+
26+
using namespace mp_units::astronomy::unit_symbols;
27+
28+
quantity distance = 4.22 * ly; // light-year
29+
quantity flux = 1.5 * Jy; // jansky (radio astronomy)
30+
quantity period = 1. * D_sid; // sidereal day
31+
quantity age = 13.8e9 * a; // Julian year
32+
```
33+
34+
These units can be freely mixed with IAU and SI units.
2435

2536
## Resolution B3: Nominal Values
2637

@@ -289,27 +300,13 @@ Exoplanet mass: 0.13 M_⊕
289300

290301
## References
291302

292-
- [IAU Resolution B3 (2015)](https://www.iau.org/Iau/Publications/List-of-Resolutions) -
303+
- [IAU Systems Reference](../../reference/systems_reference/systems/iau.md) - Complete
304+
list of IAU units
305+
- [Astronomy Systems Reference](../../reference/systems_reference/systems/astronomy.md) -
306+
Complete list of astronomy utility units
307+
- [IAU 2015 Resolution B3](https://www.iau.org/Iau/Publications/List-of-Resolutions) -
293308
Nominal conversion constants for selected solar and planetary properties
294-
- [IAU Resolution B2 (2012)](https://www.iau.org/Iau/Publications/List-of-Resolutions) -
309+
- [IAU 2012 Resolution B2](https://www.iau.org/Iau/Publications/List-of-Resolutions) -
295310
On the re-definition of the astronomical unit of length
296311
- [CODATA 2018](https://physics.nist.gov/cuu/Constants/index.html) -
297312
Internationally recommended values of the fundamental physical constants
298-
299-
!!! tip "Astronomy Utilities"
300-
301-
For commonly used astronomy units not standardized by the IAU (such as light-years,
302-
jansky, sidereal days, Julian years, etc.), see the `astronomy` utility system:
303-
304-
```cpp
305-
#include <mp-units/systems/astronomy.h>
306-
307-
using namespace mp_units::astronomy::unit_symbols;
308-
309-
quantity distance = 4.22 * ly; // light-year
310-
quantity flux = 1.5 * Jy; // jansky (radio astronomy)
311-
quantity period = 1. * D_sid; // sidereal day
312-
quantity age = 13.8e9 * a; // Julian year
313-
```
314-
315-
These units can be freely mixed with IAU and SI units.

docs/users_guide/systems/isq.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,15 @@
55
The **International System of Quantities (ISQ)** is the system of quantities used as the basis
66
for the International System of Units (SI) and other systems of units.
77

8-
The ISQ is defined across the ISO/IEC 80000 series, which currently includes parts 1-17
9-
covering quantities and units in various domains.
10-
118
!!! info
129

1310
For a general introduction to systems of quantities and their importance, see
1411
[Systems of Quantities](../framework_basics/systems_of_quantities.md) in the
1512
Framework Basics section.
1613

14+
The ISQ is defined across the ISO/IEC 80000 series, which currently includes parts 1-17
15+
covering quantities and units in various domains.
16+
1717
**mp-units** provides comprehensive support for the ISQ, likely making it the first
1818
library (in any programming language) to model the complete ISO/IEC 80000 quantity
1919
specification.
@@ -252,7 +252,9 @@ both are lengths.
252252

253253
## References
254254

255-
- [ISO/IEC 80000 series](https://www.iso.org/standard/76921.html)
256-
- [SI Brochure (9th edition)](https://www.bipm.org/en/publications/si-brochure)
255+
- [ISQ Systems Reference](../../reference/systems_reference/systems/isq.md) - Complete
256+
list of quantities, dimensions, and hierarchies
257257
- [Systems of Quantities](../framework_basics/systems_of_quantities.md) - Framework basics
258258
- [Systems of Units](../framework_basics/systems_of_units.md) - Framework basics
259+
- [ISO/IEC 80000 series](https://www.iso.org/standard/76921.html)
260+
- [SI Brochure (9th edition)](https://www.bipm.org/en/publications/si-brochure)

docs/users_guide/systems/si.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -322,6 +322,8 @@ std::cout << kinetic_energy.in(J) << "\n"; // Energy in joules
322322
323323
## References
324324
325+
- [SI Systems Reference](../../reference/systems_reference/systems/si.md) - Complete
326+
list of units, prefixes, and point origins
327+
- [Systems of Units](../framework_basics/systems_of_units.md) - Framework basics
325328
- [SI Brochure (9th edition)](https://www.bipm.org/en/publications/si-brochure)
326329
- [International System of Quantities (ISQ)](isq.md)
327-
- [Systems of Units](../framework_basics/systems_of_units.md) - Framework basics

docs/users_guide/systems/strong_angular_system.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -175,3 +175,11 @@ Applying a perpendicular force of 500 N to a 20 cm long lever results in 100 N m
175175
You can find more information about this constant in [Quincey](../../reference/bibliography.md#Quincey).
176176

177177
[Try it live on Compiler Explorer](https://godbolt.org/z/qfxosv9YM){ .md-button }
178+
179+
## References
180+
181+
<!-- markdownlint-disable MD013 -->
182+
- [Angular Systems Reference](../../reference/systems_reference/systems/angular.md) - Complete list of quantities and units
183+
- [ISQ Angle Systems Reference](../../reference/systems_reference/systems/isq_angle.md) - ISQ with strong angular dimensions
184+
- [Quincey: Angles in the SI](../../reference/bibliography.md#Quincey) - Detailed proposal for solving the angle problem
185+
<!-- markdownlint-enable MD013 -->

docs/users_guide/systems/yard_pound.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -468,6 +468,11 @@ quantity land_area = 1 * usc::acre; // Acre is based on survey chains
468468

469469
## Further Reading
470470

471+
<!-- markdownlint-disable MD013 -->
472+
- [Yard-Pound Systems Reference](../../reference/systems_reference/systems/yard_pound.md) - Complete list of yard_pound units
473+
- [Imperial Systems Reference](../../reference/systems_reference/systems/imperial.md) - Complete list of imperial units
474+
- [USC Systems Reference](../../reference/systems_reference/systems/usc.md) - Complete list of US customary units
471475
- [The International Yard and Pound Agreement (1959)](https://www.ngs.noaa.gov/PUBS_LIB/FedRegister/FRdoc59-5442.pdf)
472476
- [United Kingdom Weights and Measures Act (1985)](https://www.legislation.gov.uk/ukpga/1985/72)
473477
- [NIST Special Publication 811: Guide for the Use of the International System of Units](https://www.nist.gov/pml/special-publication-811)
478+
<!-- markdownlint-enable MD013 -->

0 commit comments

Comments
 (0)