mirror of
https://gitlab.com/MisterBiggs/aero-astro-calc.git
synced 2025-06-15 14:46:49 +00:00
pimped out readme
This commit is contained in:
parent
6460344bc5
commit
db0de0dc4b
35
README.md
35
README.md
@ -2,17 +2,44 @@
|
||||
|
||||
A small python library with functions to assist engineers.
|
||||
|
||||
## Usage
|
||||
## Getting Started
|
||||
|
||||
### Code:
|
||||
- Install using pip:
|
||||
|
||||
```
|
||||
pip install aero-astro-calc
|
||||
```
|
||||
|
||||
- Import into your Python project
|
||||
|
||||
```python
|
||||
from aero_astro_calc import PlaneStress
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
Make plane stress object:
|
||||
|
||||
```python
|
||||
stress = PlaneStress(80, -40, 25)
|
||||
```
|
||||
|
||||
View the stress on a 2D plane:
|
||||
|
||||
```python
|
||||
stress.plane()
|
||||
```
|
||||
|
||||
### Output:
|
||||

|
||||
|
||||

|
||||
View Mohr's circle of the stresses:
|
||||
|
||||
```python
|
||||
stress.mohr()
|
||||
```
|
||||
|
||||

|
||||
|
||||
## Contact
|
||||
|
||||
Anson Biggs - [anson@ansonbiggs.com](mailto:anson@ansonbiggs.com) - [@Anson_3D](https://twitter.com/Anson_3D)
|
||||
|
BIN
images/MohrsCircle.png
Normal file
BIN
images/MohrsCircle.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 27 KiB |
Before Width: | Height: | Size: 12 KiB After Width: | Height: | Size: 12 KiB |
Loading…
x
Reference in New Issue
Block a user