Skip to content

Commit 3cdc01b

Browse files
mpuszmpusz
committed
docs: IAU and astronomy systems documentation added
1 parent e4cd71e commit 3cdc01b

File tree

4 files changed

+365
-39
lines changed

4 files changed

+365
-39
lines changed

‎docs/reference/systems_overview.md‎

Lines changed: 30 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -9,21 +9,22 @@ see [System Definitions](../users_guide/systems/introduction.md) in the User's G
99
The following table lists all systems available in the library. The "Documented" column
1010
indicates systems with detailed User's Guide documentation.
1111

12-
| System | Quantities | Units | Description & Use Cases | Documented |
13-
|--------------------------------------------------------------------|:----------:|:-----:|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:----------:|
14-
| **[ISQ](../users_guide/systems/isq.md)** | ✓ | | International System of Quantities (from ISO/IEC 80000 series) - foundation for SI and other systems. Use when you need the full typed quantity hierarchy. | ✓ |
15-
| **[SI](../users_guide/systems/si.md)** | | ✓ | International System of Units - modern metric system, most widely used. Best for most engineering and scientific applications as the international standard. | ✓ |
16-
| **[CGS](../users_guide/systems/cgs.md)** | | ✓ | Centimetre-Gram-Second system - still used in some areas of physics and chemistry. Use when interfacing with legacy physics code or specific scientific domains. | ✓ |
17-
| **[Yard-Pound](../users_guide/systems/yard_pound.md)** | | ✓ | Base units system from the 1959 international yard and pound agreement. Foundation for Imperial and USC systems. Use directly when you need the common base units without regional extensions. | ✓ |
18-
| **[Imperial](../users_guide/systems/yard_pound.md)** | | ✓ | British Imperial system extending yard-pound with UK-specific units (stone, imperial gallon, long ton). Use when required by UK industry standards or regulations. | ✓ |
19-
| **[USC](../users_guide/systems/yard_pound.md)** | | ✓ | United States customary units extending yard-pound with US-specific units (US gallon, survey units, Fahrenheit). Use for aviation, construction, and other industries in the US. | ✓ |
20-
| **[`angular`](../users_guide/systems/strong_angular_system.md)** | ✓ | ✓ | Standalone strong angular system with dimensional angle and units. Use for rotational mechanics when you want explicit angle dimensions without the full ISQ hierarchy. | ✓ |
21-
| **[`isq_angle`](../users_guide/systems/strong_angular_system.md)** | ✓ | | ISQ amendment incorporating strong angular quantities. Use when you need both the ISQ quantity hierarchy and strong angular dimensions (e.g., for physically-correct torque units). | ✓ |
22-
| **[Natural](../users_guide/systems/natural_units.md)** | ✓ | ✓ | High-energy physics system where fundamental constants ($c$, $\hbar$, $k_B$) equal unity. Use for particle physics and cosmology calculations. | ✓ |
23-
| **IEC** | | ✓ | IEC-standardized units including electrical (var), telecommunications (erlang, baud), and information technology (bit, byte). Use for electrical engineering and IT applications. | |
24-
| **IAU** | | ✓ | International Astronomical Union system for astronomical applications. Use for astronomy and astrophysics calculations. | |
25-
| **Typographic** | | ✓ | Units used in typography and desktop publishing (points, picas, etc.). Use for font design and publishing applications. | |
26-
| **HEP** | | ✓ | High-energy physics units (barn, electronvolt, particle masses). Use for high-energy physics experiments. | |
12+
| System | Quantities | Units | Description & Use Cases | Documented |
13+
|--------------------------------------------------------------------|:----------:|:-----:|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:----------:|
14+
| **[ISQ](../users_guide/systems/isq.md)** | ✓ | | International System of Quantities (from ISO/IEC 80000 series) - foundation for SI and other systems. Use when you need the full typed quantity hierarchy. | ✓ |
15+
| **[SI](../users_guide/systems/si.md)** | | ✓ | International System of Units - modern metric system, most widely used. Best for most engineering and scientific applications as the international standard. | ✓ |
16+
| **[CGS](../users_guide/systems/cgs.md)** | | ✓ | Centimetre-Gram-Second system - still used in some areas of physics and chemistry. Use when interfacing with legacy physics code or specific scientific domains. | ✓ |
17+
| **[Yard-Pound](../users_guide/systems/yard_pound.md)** | | ✓ | Base units system from the 1959 international yard and pound agreement. Foundation for Imperial and USC systems. Use directly when you need the common base units without regional extensions. | ✓ |
18+
| **[Imperial](../users_guide/systems/yard_pound.md)** | | ✓ | British Imperial system extending yard-pound with UK-specific units (stone, imperial gallon, long ton). Use when required by UK industry standards or regulations. | ✓ |
19+
| **[USC](../users_guide/systems/yard_pound.md)** | | ✓ | United States customary units extending yard-pound with US-specific units (US gallon, survey units, Fahrenheit). Use for aviation, construction, and other industries in the US. | ✓ |
20+
| **[`angular`](../users_guide/systems/strong_angular_system.md)** | ✓ | ✓ | Standalone strong angular system with dimensional angle and units. Use for rotational mechanics when you want explicit angle dimensions without the full ISQ hierarchy. | ✓ |
21+
| **[`isq_angle`](../users_guide/systems/strong_angular_system.md)** | ✓ | | ISQ amendment incorporating strong angular quantities. Use when you need both the ISQ quantity hierarchy and strong angular dimensions (e.g., for physically-correct torque units). | ✓ |
22+
| **[Natural](../users_guide/systems/natural_units.md)** | ✓ | ✓ | High-energy physics system where fundamental constants ($c$, $\hbar$, $k_B$) equal unity. Use for particle physics and cosmology calculations. | ✓ |
23+
| **[IAU](../users_guide/systems/iau.md)** | | ✓ | International Astronomical Union standardized constants from official resolutions: nominal solar/planetary values (Resolution B3), astronomical unit (Resolution B2), CODATA 2018 gravitational constant and masses. Use for professional astronomy/astrophysics requiring IAU-standardized values. | ✓ |
24+
| **Astronomy** | | ✓ | Common astronomy utility units not standardized by IAU: light-year, lunar distance, jansky, sidereal day, Julian/tropical year, century, millennium, gaussian gravitational constant. Use for general astronomy calculations. | |
25+
| **IEC** | | ✓ | IEC-standardized units including electrical (var), telecommunications (erlang, baud), and information technology (bit, byte). Use for electrical engineering and IT applications. | |
26+
| **Typographic** | | ✓ | Units used in typography and desktop publishing (points, picas, etc.). Use for font design and publishing applications. | |
27+
| **HEP** | | ✓ | High-energy physics units (barn, electronvolt, particle masses). Use for high-energy physics experiments. | |
2728

2829
!!! note
2930

@@ -37,19 +38,20 @@ indicates systems with detailed User's Guide documentation.
3738
Each system can be included via its corresponding header:
3839

3940
```cpp
40-
#include <mp-units/systems/isq.h> // International System of Quantities
41-
#include <mp-units/systems/si.h> // International System of Units
42-
#include <mp-units/systems/cgs.h> // Centimetre-Gram-Second
43-
#include <mp-units/systems/angular.h> // Strong Angular System (standalone)
44-
#include <mp-units/systems/isq_angle.h> // Strong Angular System (ISQ amendment)
45-
#include <mp-units/systems/natural.h> // Natural Units
46-
#include <mp-units/systems/iec80000.h> // IEC information units
47-
#include <mp-units/systems/iau.h> // Astronomical units
48-
#include <mp-units/systems/yard_pound.h> // Yard-Pound base units (1959 international agreement)
49-
#include <mp-units/systems/imperial.h> // British Imperial units
50-
#include <mp-units/systems/usc.h> // US Customary units
51-
#include <mp-units/systems/typographic.h> // Typographic units
52-
#include <mp-units/systems/hep.h> // High-energy physics units
41+
#include <mp-units/systems/angular.h> // Strong Angular System (standalone)
42+
#include <mp-units/systems/astronomy.h> // Common astronomy utility units
43+
#include <mp-units/systems/cgs.h> // Centimetre-Gram-Second
44+
#include <mp-units/systems/hep.h> // High-energy physics units
45+
#include <mp-units/systems/iau.h> // IAU standardized astronomical constants
46+
#include <mp-units/systems/iec80000.h> // IEC information units
47+
#include <mp-units/systems/imperial.h> // British Imperial units
48+
#include <mp-units/systems/isq.h> // International System of Quantities
49+
#include <mp-units/systems/isq_angle.h> // Strong Angular System (ISQ amendment)
50+
#include <mp-units/systems/natural.h> // Natural Units
51+
#include <mp-units/systems/si.h> // International System of Units
52+
#include <mp-units/systems/typographic.h> // Typographic units
53+
#include <mp-units/systems/usc.h> // US Customary units
54+
#include <mp-units/systems/yard_pound.h> // Yard-Pound base units (1959 international agreement)
5355
```
5456

5557
For detailed information about each documented system, its quantities, units, and usage

0 commit comments

Comments
 (0)