Skip to content

Commit 80dc30d

Browse files
committed
Minor edits in README
1 parent 9f065ab commit 80dc30d

File tree

1 file changed

+8
-5
lines changed

1 file changed

+8
-5
lines changed

README.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,9 @@ Small library (currently only one class) for uncertainty calculations and error
66

77
The uncertainty calculations are in accordance with gaussian’s propagation, as calculated by an analytical method:
88

9-
![equation](https://latex.codecogs.com/png.latex?%5Cdpi%7B120%7D%20%5CDelta_f%20%3D%20%5Csqrt%7B%5Cleft%28%5Cfrac%7B%5Cpartial%20f%7D%7B%5Cpartial%20x%7D%5Cright%29%5E2%7B%5CDelta_x%7D%5E2%20+%20%5Cleft%28%5Cfrac%7B%5Cpartial%20f%7D%7B%5Cpartial%20y%7D%5Cright%29%5E2%7B%5CDelta_y%7D%5E2%20+%20%5Cleft%28%5Cfrac%7B%5Cpartial%20f%7D%7B%5Cpartial%20z%7D%5Cright%29%5E2%7B%5CDelta_z%7D%5E2%20+%20...%7D)
9+
<p align="center">
10+
<img src="https://latex.codecogs.com/svg.latex?%5Cdpi%7B120%7D%20%5CDelta_f%20%3D%20%5Csqrt%7B%5Cleft%28%5Cfrac%7B%5Cpartial%20f%7D%7B%5Cpartial%20x%7D%5Cright%29%5E2%7B%5CDelta_x%7D%5E2%20&plus;%20%5Cleft%28%5Cfrac%7B%5Cpartial%20f%7D%7B%5Cpartial%20y%7D%5Cright%29%5E2%7B%5CDelta_y%7D%5E2%20&plus;%20%5Cleft%28%5Cfrac%7B%5Cpartial%20f%7D%7B%5Cpartial%20z%7D%5Cright%29%5E2%7B%5CDelta_z%7D%5E2%20&plus;%20...%7D">
11+
</p>
1012

1113
Made by and for Physics Laboratory students in IFSC, who can't use uncertainties.py because of mean’s absolute deviation used in its calculation.
1214

@@ -22,25 +24,26 @@ To get this library on google colaboratory:
2224

2325
## Usage
2426

25-
Just import with `from labfis import labfloat` and create an *labfloat* object as:
27+
Just import with `from labfis import labfloat` and create an *labfloat* object, as this exemple below:
2628

27-
```
29+
```py
2830
>>> from labfis import labfloat
2931
>>> a = labfloat(1,3)
3032
>>> b = labfloat(2,4)
3133
>>> a*b
3234
(2 ± 7)
3335
```
36+
Check the Wiki for more details
3437

3538
## Instalation
3639

37-
Intstall master releases with:
40+
Intstall main releases with:
3841

3942
```
4043
pip install labfis
4144
```
4245

43-
Install development releases with:
46+
Install development version with:
4447

4548
```
4649
pip install git+https://github.com/phisgroup/labfis.py/tree/development

0 commit comments

Comments
 (0)