Metadata-Version: 2.1
Name: Cross-Sectional-Parameter-Calculation
Version: 0.1.0
Summary: 一个用以进行圆环截面参数计算的库，我主要是把它拿来算桩的相关问题
Author: ManiacsTraitor
Author-email: 2727671635@QQ.COM
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
License-File: LICENSE.txt

# 环形截面参数计算库

## 简介
这是一个用于计算环形几何属性的Python库，支持多种单位和常见计算，包括环形面积、惯性矩和回转半径。

## 安装
可以通过以下方式安装本库：

~~~markdown
```bash
pip install YourLibraryName
~~~

## 快速入门

### 导入库

在使用之前，首先需要导入库：

```python
from your_library import annular_area_mm2, annular_area_cm2, annular_area_m2, annular_moment_of_inertia_mm4, annular_moment_of_inertia_cm4, annular_moment_of_inertia_m4, annular_radius_of_gyration_mm, annular_radius_of_gyration_cm, annular_radius_of_gyration_m
```

### 计算环形面积

#### 单位为毫米（mm²）

```python
area_mm2 = annular_area_mm2(diameter_mm=100, thickness_mm=5)
print(f"环形面积（mm²）：{area_mm2}")
```

#### 单位为厘米（cm²）

```python
area_cm2 = annular_area_cm2(diameter_cm=10, thickness_cm=0.5)
print(f"环形面积（cm²）：{area_cm2}")
```

#### 单位为米（m²）

```python
area_m2 = annular_area_m2(diameter_m=0.1, thickness_m=0.005)
print(f"环形面积（m²）：{area_m2}")
```

### 计算环形惯性矩

#### 单位为立方毫米（mm⁴）

```python
moment_mm4 = annular_moment_of_inertia_mm4(diameter_mm=100, thickness_mm=5)
print(f"环形惯性矩（mm⁴）：{moment_mm4}")
```

#### 单位为立方厘米（cm⁴）

```python
moment_cm4 = annular_moment_of_inertia_cm4(diameter_cm=10, thickness_cm=0.5)
print(f"环形惯性矩（cm⁴）：{moment_cm4}")
```

#### 单位为米（m⁴）

```python
moment_m4 = annular_moment_of_inertia_m4(diameter_m=0.1, thickness_m=0.005)
print(f"环形惯性矩（m⁴）：{moment_m4}")
```

### 计算环形回转半径

#### 单位为毫米（mm）

```python
radius_mm = annular_radius_of_gyration_mm(diameter_mm=100, thickness_mm=5)
print(f"环形回转半径（mm）：{radius_mm}")
```

#### 单位为厘米（cm）

```python
radius_cm = annular_radius_of_gyration_cm(diameter_cm=10, thickness_cm=0.5)
print(f"环形回转半径（cm）：{radius_cm}")
```

#### 单位为米（m）

```python
radius_m = annular_radius_of_gyration_m(diameter_m=0.1, thickness_m=0.005)
print(f"环形回转半径（m）：{radius_m}")
```

## 函数说明

### 基础函数

- `annular_area_*`: 计算环形面积。
- `annular_moment_of_inertia_*`: 计算环形惯性矩。
- `annular_radius_of_gyration_*`: 计算环形回转半径。

### 输入参数

- `diameter_*`: 环形外径。
- `thickness_*`: 环形厚度。

### 注意事项

- 所有输入参数必须为正数。
- 单位转换函数支持`mm`（毫米）、`cm`（厘米）、`m`（米）。

## 许可证

本项目使用 [MIT 许可证](LICENSE.txt)

## 联系方式

如果有任何问题或建议，请联系 [2727671635@QQ.COM]。

## 致谢

感谢所有对本项目做出贡献的人！
