Skip to content

Commit 6ebd746

Browse files
committed
Change draw_semicircle to draw_arc
1 parent 3e6dda3 commit 6ebd746

5 files changed

Lines changed: 60 additions & 60 deletions

File tree

PLOTDRAW_README.md

Lines changed: 36 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1-
# Plot Draw v0.2.0
1+
# Plot Draw v0.2.1
22

33
This library is designed to provide a set of functions for drawing various types of plots, arrows, segments, and shapes using Matplotlib. These functions allow for customized plotting and annotation of graphical elements.
44

55
## General
66

77
### blank_canvas
88

9-
[**[Source]**](https://github.com/MecSimCalc/MecSimCalc-utils/blob/v0.2.0/mecsimcalc/plot_draw.py#L7C1-L49C14)
9+
[**[Source]**](https://github.com/MecSimCalc/MecSimCalc-utils/blob/v0.2.1/mecsimcalc/plot_draw.py#L7C1-L49C14)
1010

1111
```python
1212
blank_canvas(
@@ -48,14 +48,14 @@ def main(inputs):
4848
```
4949

5050
<div style={{textAlign: 'center'}}>
51-
![white canvas](./images/blank_canvas.png)
51+
5252
</div>
5353

5454
## lines and arrows
5555

5656
### draw_line
5757

58-
[**[Source]**](https://github.com/MecSimCalc/MecSimCalc-utils/blob/v0.2.0/mecsimcalc/plot_draw.py#L52C1-L110C1)
58+
[**[Source]**](https://github.com/MecSimCalc/MecSimCalc-utils/blob/v0.2.1/mecsimcalc/plot_draw.py#L52C1-L110C1)
5959

6060
```python
6161
draw_line(
@@ -95,12 +95,12 @@ def main(inputs):
9595
```
9696

9797
<div style={{textAlign: 'center'}}>
98-
![segment](./images/draw_line.png)
98+
9999
</div>
100100

101101
### draw_arrow
102102

103-
[**[Source]**](https://github.com/MecSimCalc/MecSimCalc-utils/blob/v0.2.0/mecsimcalc/plot_draw.py#L112C1-L190C1)
103+
[**[Source]**](https://github.com/MecSimCalc/MecSimCalc-utils/blob/v0.2.1/mecsimcalc/plot_draw.py#L112C1-L190C1)
104104

105105
```python
106106
draw_arrow(
@@ -154,12 +154,12 @@ def main(inputs):
154154
#### Output:
155155

156156
<div style={{textAlign: 'center'}}>
157-
![Arrow](./images/draw_arrow.png)
157+
158158
</div>
159159

160160
### draw_double_arrowhead
161161

162-
[**[Source]**](https://github.com/MecSimCalc/MecSimCalc-utils/blob/v0.2.0/mecsimcalc/plot_draw.py#L192C1-L269C6)
162+
[**[Source]**](https://github.com/MecSimCalc/MecSimCalc-utils/blob/v0.2.1/mecsimcalc/plot_draw.py#L192C1-L269C6)
163163

164164
```python
165165
draw_double_arrowhead(
@@ -199,12 +199,12 @@ def main(inputs):
199199
```
200200

201201
<div style={{textAlign: 'center'}}>
202-
![double arrowhead](./images/draw_double_arrowhead.png)
202+
203203
</div>
204204

205205
### vertical_arrow_rain
206206

207-
[**[Source]**](https://github.com/MecSimCalc/MecSimCalc-utils/blob/v0.2.0/mecsimcalc/plot_draw.py#L272C1-L348C10)
207+
[**[Source]**](https://github.com/MecSimCalc/MecSimCalc-utils/blob/v0.2.1/mecsimcalc/plot_draw.py#L272C1-L348C10)
208208

209209
```python
210210
vertical_arrow_rain(
@@ -250,12 +250,12 @@ def main(inputs):
250250
```
251251

252252
<div style={{textAlign: 'center'}}>
253-
![vertical arrow rain](./images/vertical_arrow_rain.png)
253+
254254
</div>
255255

256256
### horizontal_arrow_rain
257257

258-
[**[Source]**](https://github.com/MecSimCalc/MecSimCalc-utils/blob/v0.2.0/mecsimcalc/plot_draw.py#L351C1-L427C1)
258+
[**[Source]**](https://github.com/MecSimCalc/MecSimCalc-utils/blob/v0.2.1/mecsimcalc/plot_draw.py#L351C1-L427C1)
259259

260260
```python
261261
horizontal_arrow_rain(
@@ -301,14 +301,14 @@ def main(inputs):
301301
```
302302

303303
<div style={{textAlign: 'center'}}>
304-
![horizontal arrow rain](./images/horizontal_arrow_rain.png)
304+
305305
</div>
306306

307307
## Shapes
308308

309309
### draw_circle
310310

311-
[**[Source]**](https://github.com/MecSimCalc/MecSimCalc-utils/blob/v0.2.0/mecsimcalc/plot_draw.py#L429C1-L468C58)
311+
[**[Source]**](https://github.com/MecSimCalc/MecSimCalc-utils/blob/v0.2.1/mecsimcalc/plot_draw.py#L429C1-L468C58)
312312

313313
```python
314314
draw_circle(
@@ -348,15 +348,15 @@ def main(inputs):
348348
```
349349

350350
<div style={{textAlign: 'center'}}>
351-
![arrow](./images/draw_circle.png)
351+
352352
</div>
353353

354-
### draw_semicircle
354+
### draw_arc
355355

356-
[**[Source]**](https://github.com/MecSimCalc/MecSimCalc-utils/blob/v0.2.0/mecsimcalc/plot_draw.py#L471C1-L557C10)
356+
[**[Source]**](https://github.com/MecSimCalc/MecSimCalc-utils/blob/v0.2.1/mecsimcalc/plot_draw.py#L471C1-L557C10)
357357

358358
```python
359-
draw_semicircle(
359+
draw_arc(
360360
radius,
361361
start_angle,
362362
end_angle,
@@ -397,18 +397,18 @@ import mecsimcalc as msc
397397
import mecsimcalc.plot_draw as plot_draw
398398

399399
def main(inputs):
400-
plot_draw.draw_semicircle(5, 0, 90, degrees=True)
400+
plot_draw.draw_arc(5, 0, 90, degrees=True)
401401
plot = msc.print_plot(plt)
402402
return {'plot': plot}.
403403
```
404404

405405
<div style={{textAlign: 'center'}}>
406-
![quarter circle arc](./images/draw_semicircle.png)
406+
407407
</div>
408408

409409
### draw_rounded_rectangle
410410

411-
[**[Source]**](https://github.com/MecSimCalc/MecSimCalc-utils/blob/v0.2.0/mecsimcalc/plot_draw.py#L560C1-L643C25)
411+
[**[Source]**](https://github.com/MecSimCalc/MecSimCalc-utils/blob/v0.2.1/mecsimcalc/plot_draw.py#L560C1-L643C25)
412412

413413
```python
414414
draw_rounded_rectangle(
@@ -450,14 +450,14 @@ def main(inputs):
450450
```
451451

452452
<div style={{textAlign: 'center'}}>
453-
![rounded rectangle](./images/draw_rounded_rectangle.png)
453+
454454
</div>
455455

456456
## Axes
457457

458458
### draw_two_axes
459459

460-
[**[Source]**](https://github.com/MecSimCalc/MecSimCalc-utils/blob/v0.2.0/mecsimcalc/plot_draw.py#L646C1-L755C14)
460+
[**[Source]**](https://github.com/MecSimCalc/MecSimCalc-utils/blob/v0.2.1/mecsimcalc/plot_draw.py#L646C1-L755C14)
461461

462462
```python
463463
draw_two_axes(
@@ -505,12 +505,12 @@ def main(inputs):
505505
```
506506

507507
<div style={{textAlign: 'center'}}>
508-
![two axes](./images/draw_two_axes.png)
508+
509509
</div>
510510

511511
### draw_two_inclined_axes
512512

513-
[**[Source]**](https://github.com/MecSimCalc/MecSimCalc-utils/blob/v0.2.0/mecsimcalc/plot_draw.py#L758C1-L873C14)
513+
[**[Source]**](https://github.com/MecSimCalc/MecSimCalc-utils/blob/v0.2.1/mecsimcalc/plot_draw.py#L758C1-L873C14)
514514

515515
```python
516516
draw_two_inclined_axes(
@@ -558,12 +558,12 @@ def main(inputs):
558558
```
559559

560560
<div style={{textAlign: 'center'}}>
561-
![2 inclined axes](./images/draw_two_inclined_axes.png)
561+
562562
</div>
563563

564564
### draw_three_axes
565565

566-
[**[Source]**](https://github.com/MecSimCalc/MecSimCalc-utils/blob/v0.2.0/mecsimcalc/plot_draw.py#L876C1-L1005C1)
566+
[**[Source]**](https://github.com/MecSimCalc/MecSimCalc-utils/blob/v0.2.1/mecsimcalc/plot_draw.py#L876C1-L1005C1)
567567

568568
```python
569569
draw_three_axes(
@@ -605,12 +605,12 @@ def main(inputs):
605605
```
606606

607607
<div style={{textAlign: 'center'}}>
608-
![three axes](./images/draw_three_axes.png)
608+
609609
</div>
610610

611611
### draw_three_axes_rotated
612612

613-
[**[Source]**](https://github.com/MecSimCalc/MecSimCalc-utils/blob/v0.2.0/mecsimcalc/plot_draw.py#L1007C1-L1145C14)
613+
[**[Source]**](https://github.com/MecSimCalc/MecSimCalc-utils/blob/v0.2.1/mecsimcalc/plot_draw.py#L1007C1-L1145C14)
614614

615615
```python
616616
draw_three_axes_rotated(
@@ -657,14 +657,14 @@ def main(inputs):
657657
```
658658

659659
<div style={{textAlign: 'center'}}>
660-
![three axes rotated](./images/draw_three_axes_rotated.png)
660+
661661
</div>
662662

663663
## Calculations
664664

665665
### calculate_midpoint
666666

667-
[**[Source]**](https://github.com/MecSimCalc/MecSimCalc-utils/blob/v0.2.0/mecsimcalc/plot_draw.py#L1148C1-L1180C40)
667+
[**[Source]**](https://github.com/MecSimCalc/MecSimCalc-utils/blob/v0.2.1/mecsimcalc/plot_draw.py#L1148C1-L1180C40)
668668

669669
```python
670670
calculate_midpoint(
@@ -705,7 +705,7 @@ def main(inputs):
705705

706706
### calculate_intersection_point
707707

708-
[**[Source]**](https://github.com/MecSimCalc/MecSimCalc-utils/blob/v0.2.0/mecsimcalc/plot_draw.py#L1183C1-L1248C1)
708+
[**[Source]**](https://github.com/MecSimCalc/MecSimCalc-utils/blob/v0.2.1/mecsimcalc/plot_draw.py#L1183C1-L1248C1)
709709

710710
```python
711711
calculate_intersection_point(
@@ -751,7 +751,7 @@ def main(inputs):
751751

752752
### calculate_arrow_endpoint
753753

754-
[**[Source]**](https://github.com/MecSimCalc/MecSimCalc-utils/blob/v0.2.0/mecsimcalc/plot_draw.py#L1249C1-L1291C1)
754+
[**[Source]**](https://github.com/MecSimCalc/MecSimCalc-utils/blob/v0.2.1/mecsimcalc/plot_draw.py#L1249C1-L1291C1)
755755

756756
```python
757757
calculate_arrow_endpoint(
@@ -795,7 +795,7 @@ def main(inputs):
795795

796796
### calculate_angle
797797

798-
[**[Source]**](https://github.com/MecSimCalc/MecSimCalc-utils/blob/v0.2.0/mecsimcalc/plot_draw.py#L1293C1-L1333C1)
798+
[**[Source]**](https://github.com/MecSimCalc/MecSimCalc-utils/blob/v0.2.1/mecsimcalc/plot_draw.py#L1293C1-L1333C1)
799799

800800
```python
801801
calculate_angle(
@@ -837,7 +837,7 @@ def main(inputs):
837837

838838
### get_arc_points
839839

840-
[**[Source]**](https://github.com/MecSimCalc/MecSimCalc-utils/blob/v0.2.0/mecsimcalc/plot_draw.py#L1335C1-L1387C16)
840+
[**[Source]**](https://github.com/MecSimCalc/MecSimCalc-utils/blob/v0.2.1/mecsimcalc/plot_draw.py#L1335C1-L1387C16)
841841

842842
```python
843843
get_arc_points(
@@ -883,5 +883,5 @@ def main(inputs):
883883
```
884884

885885
<div style={{textAlign: 'center'}}>
886-
![arc points](./images/get_arc_points.png)
886+
887887
</div>

PyTests/test_plot_draw.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ def run_all_functions():
3737
assert calculate_midpoint((0, 0), (1, 1)) == (0.5, 0.5)
3838

3939
# Draw an arc of a circumference
40-
draw_semicircle(radius=0.5, start_angle=0, end_angle=np.pi / 2)
40+
draw_arc(radius=0.5, start_angle=0, end_angle=np.pi / 2)
4141

4242
blank_canvas()
4343

0 commit comments

Comments
 (0)