Merge remote-tracking branch 'origin/master' into development

Author: hlouzada

.github/workflows/pythonpublish.yml

@@ -1,37 +1,30 @@
-# This workflows will upload a Python Package using pypa/gh-action-pypi-publish@master when a release is created
+# This workflow will upload a Python Package using Twine when a release is created
 # For more information see: https://help.github.com/en/actions/language-and-framework-guides/using-python-with-github-actions#publishing-to-package-registries
 
-name: Publish Python 🐍 distributions 📦 to PyPI and TestPyPI
+name: Publish Python 🐍 distributions 📦 to PyPI
 
 on:
   release:
     types: [created]
 
 jobs:
-  build-n-publish:
-    name: Build and publish Python 🐍 distributions 📦 to PyPI and TestPyPI
-    runs-on: ubuntu-18.04
+  deploy:
+
+    runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@master
-    - name: Set up Python 3.x
-      uses: actions/setup-python@v1
+    - uses: actions/checkout@v2
+    - name: Set up Python
+      uses: actions/setup-python@v2
       with:
-        python-version: 3.x
+        python-version: '3.x'
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
-        pip install setuptools wheel
-    - name: Build a binary wheel and a source tarball
+        pip install setuptools wheel twine
+    - name: Build and publish
+      env:
+        TWINE_USERNAME: __token__
+        TWINE_PASSWORD: ${{ secrets.pypi_password }}
       run: |
         python setup.py sdist bdist_wheel
-    - name: Publish distribution 📦 to Test PyPI
-      uses: pypa/gh-action-pypi-publish@master
-      with:
-        user: __token__
-        password: ${{ secrets.test_pypi_password }}
-        repository_url: https://test.pypi.org/legacy/
-    - name: Publish distribution 📦 to PyPI
-      uses: pypa/gh-action-pypi-publish@master
-      with:
-        user: __token__
-        password: ${{ secrets.pypi_password }}
+        twine upload dist/*

README.md

@@ -1,17 +1,33 @@
 # labfis.py
 
-[![Travis - CI](https://img.shields.io/travis/com/phisgroup/labfis.py/development?style=for-the-badge)](https://travis-ci.com/phisgroup/labfis.py) [![PyPI](https://img.shields.io/pypi/v/labfis?style=for-the-badge)](https://pypi.org/project/labfis/) [![License](https://img.shields.io/github/license/phisgroup/labfis.py?style=for-the-badge)](https://github.com/phisgroup/labfis.py/blob/master/LICENSE)
+[![Travis - CI](https://img.shields.io/travis/com/phisgroup/labfis.py/master?style=for-the-badge)](https://travis-ci.com/phisgroup/labfis.py) [![PyPI](https://img.shields.io/pypi/v/labfis?style=for-the-badge)](https://pypi.org/project/labfis/) [![License](https://img.shields.io/github/license/phisgroup/labfis.py?style=for-the-badge)](https://github.com/phisgroup/labfis.py/blob/master/LICENSE)
 
 ## Description
 
-Small library (currently only one class) for uncertainty calculations and error propagation.
+Small library for uncertainty calculations and error propagation.
 
-The uncertainty calculations are in accordance with gaussian’s propagation, as calculated by an analytical method:
+### Error propagation:
+
+The uncertainty is calculated analytically in accordance with the gaussian propagation:
 
 <p align="center">
 <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">
 </p>
 
+
+### To compare two labfloats it is used the following methods:
+
+Assuming:  
+<img src="https://latex.codecogs.com/svg.image?%5Cbg_white%20%5Cinline%20labfloat(x_i,%5Csigma_i)%5Cequiv%20x_i%20%5Cpm%20%5Csigma_i">
+
+- If they are equal they must satisfy:  
+<img src="https://latex.codecogs.com/svg.image?%5Cbg_white%20%5Cinline%20%5Cleft%7Cx_1%20-%20x_2%5Cright%7C%20%3C%202(%5Csigma_1%20&plus;%20%5Csigma_2)">
+ 
+- If they are different they must satisfy:  
+<img src="https://latex.codecogs.com/svg.image?%5Cbg_white%20%5Cinline%20%5Cleft%7Cx_1%20-%20x_2%5Cright%7C%20%3E%203(%5Csigma_1%20&plus;%20%5Csigma_2)">
+
+> **_NOTE:_**  Two labfloats can be not different and not equal at the same time by these methods.
+
 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.
 
 ## Usage
@@ -57,3 +73,5 @@ pip install git+https://github.com/phisgroup/labfis.py@development
  11. ["Strategies for Variance Estimation"](http://www.sagepub.com/upm-data/6427_Chapter_4__Lee_%28Analyzing%29_I_PDF_6.pdf)  (PDF). p. 37. Retrieved  2013-01-18.
  12. Harris, Daniel C. (2003), [_Quantitative chemical analysis_](https://books.google.com/books?id=csTsQr-v0d0C&pg=PA56)(6th ed.), Macmillan, p. 56, [ISBN](https://en.wikipedia.org/wiki/ISBN_(identifier) "ISBN (identifier)")  [978-0-7167-4464-1](https://en.wikipedia.org/wiki/Special:BookSources/978-0-7167-4464-1 "Special:BookSources/978-0-7167-4464-1")
  13. ["Error Propagation tutorial"](http://www.foothill.edu/psme/daley/tutorials_files/10.%20Error%20Propagation.pdf)  (PDF).  _Foothill College_. October 9, 2009. Retrieved  2012-03-01.
+ 14. Helene,  O.;  Vanin,  V.. Tratamento  estatístico  de  dados  em  física experimental. São Paulo: Editora Edgard Blücher, 1981.
+ 15. Vuolo,  J.  E.. Fundamentos  da  teoria  de  erros.  2.  ed.  São  Paulo:  Editora Edgard Blücher, 1993. 

labfis/uncertainty.py

@@ -223,7 +223,7 @@ def uncertainty(self):
         return self._uncertainty
 
     def __getitem__(self, idx):
-        vals = (self.uncertainty, self.mean)
+        vals = (self.mean, self.uncertainty)
         return vals[idx]
 
     def __pos__(self):