README mais conciso e nome melhor pro notebook

This commit is contained in:
Érico Rolim 2018-06-10 03:28:36 -03:00
parent 73d2195b56
commit 8e6f2a83ce
4 changed files with 274 additions and 267 deletions

270
README.md
View File

@ -1,267 +1,7 @@
# Aluno de exatas
# Tutorial para o módulo *aluno_exatas*
## *aluno_exatas.fis\_exp*
Esse módulo tem como objetivo auxiliar o aluno que está cursando física experimental. Além de automatizar a propagação, permite gerar funções que facilitam a manipulação dos dados medidos.
### *aluno_exatas.fis\_exp.FisExp*
Essa classe é útil principalmente na propagação de incertezas.
#### Importando módulos úteis:
```python
import aluno_exatas.fis_exp as fe
import numpy as np
```
#### Inicializando o módulo
A variável `f` irá conter um objeto `FisExp` cuja função principal é `a+b*c`. Nesse objeto, pode ser achada a propagação de incertezas da função principal.
```python
f = fe.FisExp('a**2+b*c')
print ('Função principal: ', f.funcao)
print ('Variáveis da função principal: ', f.variaveis, '\n')
print ('Propagação de incertezas da função principal: ', f.propagacao)
print ('Incertezas da propagação de incertezas: ', list(f.incertezas.values()))
```
Função principal: a**2 + b*c
Variáveis da função principal: {c, b, a}
Propagação de incertezas da função principal: sqrt(4*a**2*u_a**2 + b**2*u_c**2 + c**2*u_b**2)
Incertezas da propagação de incertezas: [u_c, u_b, u_a]
#### Definindo valores conhecidos
Nesse caso, os valores de `a` e `b` são constantes, assim como as incertezas de `a` e `c`. Os valores desconhecidos são `c` e a incerteza de `b`.
```python
f.valores_conhecidos = {'a':4, 'b':2}
f.incertezas_conhecidas = {'a':1, 'c':2}
print ('Função com valores constantes substituídos: ', f.funcao_substituida)
print ('Propagação com valores constantes substituídos: ', f.propagacao_substituida)
```
Função com valores constantes substituídos: 2*c + 16
Propagação com valores constantes substituídos: sqrt(c**2*u_b**2 + 80)
#### Criação de funções
Agora são criadas funções para calcular o valor da função principal e da propagação em diferentes valores de `c` e `u_b`.
```python
f.gerar_funcao(['c'])
f.gerar_propagacao(['c','u_b'])
print ('Função principal avaliada em c=5:', f.funcao_gerada(5))
print ('Propagação avaliada em c=5, u_b=1', f.propagacao_gerada(5,1))
```
Função principal avaliada em c=5: 26
Propagação avaliada em c=5, u_b=1 10.246950765959598
Essas funções também podem ser utilizadas com valores armazenados em `numpy.arrays`, o que permite que sejam avaliadas em vários pontos. Quando os parâmetros das funções são vários `numpy.arrays`, a função é avaliada de forma sequencial, seguindo a sequência de cada array (portanto, os vetores precisam ter o mesmo tamanho).
```python
c = np.linspace(0,50,5)
u_b = np.array([1,1,2,2,1])
print ('Função principal avaliada em diferentes valores de c: ', f.funcao_gerada(c))
print ('Propagação avaliada em diferentes valores de c e u_b: ', f.propagacao_gerada(c, u_b))
```
Função principal avaliada em diferentes valores de c: [ 16. 41. 66. 91. 116.]
Propagação avaliada em diferentes valores de c e u_b: [ 8.94427191 15.37042615 50.7937004 75.5314504 50.7937004 ]
#### Funcionalidades extra
Se, por alguma razão, o usuário desejar integrar ou derivar a função principal, há funções que permitem isso.
```python
print ('Função derivada em relação a "a": ', f.derivar('a'))
print ('Função derivada em relação a "a", avaliada em a=1, derivada de índice 2: ', f.derivar('a', ponto_avaliado=1, indice=2))
print ('Função derivada em relação a "a", com valores conhecidos substituídos: ', f.derivar('a', substituir=True), '\n')
print ('Integral da função em relação a "a": ', f.integrar('a'))
print ('Integral da função em relação a "a", avaliada entre [0,5]: ', f.integrar('a', limites=[0,5]))
print ('Integral da função em relação a "c", avaliada entre [0,5], com valores conhecidos substituídos: ', f.integrar('c', limites=[0,5], substituir=True))
```
Função derivada em relação a "a": 2*a
Função derivada em relação a "a", avaliada em a=1, derivada de índice 2: 2
Função derivada em relação a "a", com valores conhecidos substituídos: 8
Integral da função em relação a "a": a**3/3 + a*b*c
Integral da função em relação a "a", avaliada entre [0,5]: 5*b*c + 125/3
Integral da função em relação a "c", avaliada entre [0,5], com valores conhecidos substituídos: 105
### *aluno_exatas.fis\_exp.MMQ*
Essa classe foi feita para facilitar a utilização do MMQ linear, com incertezas variáveis ou não.
#### Importação de módulos
O módulo `fis_exp` já foi importado, de forma que não é necessário importá-lo novamente.
#### Inicializando o módulo
O módulo pode ser inicializado de diferentes formas, dependendo de que tipo de MMQ se quer calcular.
```python
mmq_inc_iguais = fe.MMQ()
mmq_inc_varia = fe.MMQ(fe.Incertezas.variaveis)
```
#### Definição de valores
Os módulos podem receber `lists`, `numpy.ndarrays` ou números normais (no caso de `incerteza_y` para incertezas iguais).
```python
x = [0, 1, 2, 3, 4]
y = np.array([1, 3, 7, 8, 10])
mmq_inc_iguais.x_values = x
mmq_inc_iguais.y_values = y
mmq_inc_iguais.incertezas_y = 1
mmq_inc_varia.x_values = x
mmq_inc_varia.y_values = y
mmq_inc_varia.incertezas_y = [1, 1, 2, 1, 3]
```
#### Recebendo de volta os coeficientes
Os coeficientes da função na forma `y = a + b*x` são retornados no formato `[a,b]`, assim como as incertezas.
```python
coef_inc_iguais, incert_inc_iguais = mmq_inc_iguais.coeficientes()
coef_inc_varia, incert_inc_varia = mmq_inc_varia.coeficientes()
print ('Coeficientes da função com incerteza constante: ', coef_inc_iguais)
print ('Incertezas dos coeficientes da função com incerteza constante:', incert_inc_iguais, '\n')
print ('Coeficientes da função com incerteza variável: ', coef_inc_varia)
print ('Incertezas dos coeficientes da função com incerteza variável:', incert_inc_varia)
```
Coeficientes da função com incerteza constante: [1.2 2.3]
Incertezas dos coeficientes da função com incerteza constante: [0.77459667 0.31622777]
Coeficientes da função com incerteza variável: [1.01265823 2.36075949]
Incertezas dos coeficientes da função com incerteza variável: [0.65822785 0.14556962]
## *aluno_exatas.calc_num*
Esse módulo tem como objetivo auxiliar o aluno que está cursando cálculo numérico. Contém funções que implementam conceitos aprendidos em aula.
#### Importando módulos úteis:
```python
import aluno_exatas.calc_num as cn
import numpy as np
```
### Métodos de aproximações sucessivas para achar zero de funções
#### Definindo a função que será usada e sua derivada
A definição da derivada é necessária para o método de Newton.
```python
def f(x):
return x+np.cos(x)
def flinha(x):
return 1-np.sin(x)
```
#### Definindo aproximações iniciais para os métodos da secante, newton e bissecção
* O método da secante precisa apenas da própria função e de duas aproximações para a raiz;
* O método de Newton precisa da função, sua derivada, e uma aproximação inicial;
* O método da bissecção precisa própria função e de duas aproximações para o intervalo que contém a raiz.
```python
x_secante = 0.0
xo_secante = 1.0
x_newton = 1.0
a_bi = -1.0
b_bi = 0.0
print('Função inicial avaliada nas aproximações iniciais:')
print('f(-1) =', f(-1))
print('f(0) =', f(0))
print('f(1) =', f(1))
```
Função inicial avaliada nas aproximações iniciais:
f(-1) = -0.45969769413186023
f(0) = 1.0
f(1) = 1.5403023058681398
#### Testando cada um dos métodos
Os métodos irão rodar por 9 iterações e será possível observar a qualidade da aproximação de cada um.
O método da secante, que é sujeito a erros por estar realizando divisão por 0, evita isso retornando os mesmos valores de `x` e `xo` que foram utilizados como entrada da função.
```python
for i in range(10):
x_secante, xo_secante = cn.metodo_secante(f, x_secante, xo_secante)
x_newton = cn.metodo_newton(f, flinha, x_newton)
a_bi, b_bi = cn.metodo_bisseccao(f, a_bi, b_bi)
print('Raiz encontrada pelo método da secante:')
print('x =', x_secante, '| xo =', xo_secante)
print('f(x) =', f(x_secante), '| f(xo) =', f(xo_secante))
print('\nRaiz encontrada pelo método de Newton:')
print('x =', x_newton)
print('f(x) =', f(x_newton))
print('\nIntervalo encontrado pelo método da bissecção:')
print('Raiz está entre:', (a_bi, b_bi))
print('f(a) =', f(a_bi), '| f(b) =', f(b_bi))
```
Raiz encontrada pelo método da secante:
x = -0.7390851332151607 | xo = -0.7390851332151607
f(x) = 0.0 | f(xo) = 0.0
Raiz encontrada pelo método de Newton:
x = -0.7390851332151607
f(x) = 0.0
Intervalo encontrado pelo método da bissecção:
Raiz está entre: (-0.7392578125, -0.73828125)
f(a) = -0.0002890091467900868 | f(b) = 0.001345149751805108
Esse é um módulo que tem como objetivo auxiliar alunos de exatas com os trabalhos do seu curso. Atualmente, contém funções para os seguintes assuntos:
* Física experimental: esse é o módulo mais desenvolvido, contém funções relacionadas à propagação de incertezas e manipulação dos dados utilizados, inclusive através do Método dos Mínimos Quadrados;
* Cálculo numérico: esse módulo não tem muitas funções, mas busca implementar conceitos explorados na matéria. Não está completo, e só recomendo usar as funções depois de ter entendido bem o que elas fazem e como fazem.
O tutorial para o módulo pode ser encontrado no formato Jupyter Notebook [aqui]("tutorial_aluno_exatas.ipynb") e no formato Markdown [aqui](tutorial_aluno_exatas.md).

View File

@ -1,5 +1,5 @@
jupyter nbconvert --to markdown 'Tutorial aluno_exatas.ipynb'
mv 'Tutorial aluno_exatas.md' ./README.md
jupyter nbconvert --to markdown 'tutorial_aluno_exatas.ipynb'
#mv 'Tutorial aluno_exatas.md' ./README.md
python3 setup.py sdist bdist_wheel
python3 -m twine upload dist/*

267
tutorial_aluno_exatas.md Normal file
View File

@ -0,0 +1,267 @@
# Tutorial para o módulo *aluno_exatas*
## *aluno_exatas.fis\_exp*
Esse módulo tem como objetivo auxiliar o aluno que está cursando física experimental. Além de automatizar a propagação, permite gerar funções que facilitam a manipulação dos dados medidos.
### *aluno_exatas.fis\_exp.FisExp*
Essa classe é útil principalmente na propagação de incertezas.
#### Importando módulos úteis:
```python
import aluno_exatas.fis_exp as fe
import numpy as np
```
#### Inicializando o módulo
A variável `f` irá conter um objeto `FisExp` cuja função principal é `a+b*c`. Nesse objeto, pode ser achada a propagação de incertezas da função principal.
```python
f = fe.FisExp('a**2+b*c')
print ('Função principal: ', f.funcao)
print ('Variáveis da função principal: ', f.variaveis, '\n')
print ('Propagação de incertezas da função principal: ', f.propagacao)
print ('Incertezas da propagação de incertezas: ', list(f.incertezas.values()))
```
Função principal: a**2 + b*c
Variáveis da função principal: {c, b, a}
Propagação de incertezas da função principal: sqrt(4*a**2*u_a**2 + b**2*u_c**2 + c**2*u_b**2)
Incertezas da propagação de incertezas: [u_c, u_b, u_a]
#### Definindo valores conhecidos
Nesse caso, os valores de `a` e `b` são constantes, assim como as incertezas de `a` e `c`. Os valores desconhecidos são `c` e a incerteza de `b`.
```python
f.valores_conhecidos = {'a':4, 'b':2}
f.incertezas_conhecidas = {'a':1, 'c':2}
print ('Função com valores constantes substituídos: ', f.funcao_substituida)
print ('Propagação com valores constantes substituídos: ', f.propagacao_substituida)
```
Função com valores constantes substituídos: 2*c + 16
Propagação com valores constantes substituídos: sqrt(c**2*u_b**2 + 80)
#### Criação de funções
Agora são criadas funções para calcular o valor da função principal e da propagação em diferentes valores de `c` e `u_b`.
```python
f.gerar_funcao(['c'])
f.gerar_propagacao(['c','u_b'])
print ('Função principal avaliada em c=5:', f.funcao_gerada(5))
print ('Propagação avaliada em c=5, u_b=1', f.propagacao_gerada(5,1))
```
Função principal avaliada em c=5: 26
Propagação avaliada em c=5, u_b=1 10.246950765959598
Essas funções também podem ser utilizadas com valores armazenados em `numpy.arrays`, o que permite que sejam avaliadas em vários pontos. Quando os parâmetros das funções são vários `numpy.arrays`, a função é avaliada de forma sequencial, seguindo a sequência de cada array (portanto, os vetores precisam ter o mesmo tamanho).
```python
c = np.linspace(0,50,5)
u_b = np.array([1,1,2,2,1])
print ('Função principal avaliada em diferentes valores de c: ', f.funcao_gerada(c))
print ('Propagação avaliada em diferentes valores de c e u_b: ', f.propagacao_gerada(c, u_b))
```
Função principal avaliada em diferentes valores de c: [ 16. 41. 66. 91. 116.]
Propagação avaliada em diferentes valores de c e u_b: [ 8.94427191 15.37042615 50.7937004 75.5314504 50.7937004 ]
#### Funcionalidades extra
Se, por alguma razão, o usuário desejar integrar ou derivar a função principal, há funções que permitem isso.
```python
print ('Função derivada em relação a "a": ', f.derivar('a'))
print ('Função derivada em relação a "a", avaliada em a=1, derivada de índice 2: ', f.derivar('a', ponto_avaliado=1, indice=2))
print ('Função derivada em relação a "a", com valores conhecidos substituídos: ', f.derivar('a', substituir=True), '\n')
print ('Integral da função em relação a "a": ', f.integrar('a'))
print ('Integral da função em relação a "a", avaliada entre [0,5]: ', f.integrar('a', limites=[0,5]))
print ('Integral da função em relação a "c", avaliada entre [0,5], com valores conhecidos substituídos: ', f.integrar('c', limites=[0,5], substituir=True))
```
Função derivada em relação a "a": 2*a
Função derivada em relação a "a", avaliada em a=1, derivada de índice 2: 2
Função derivada em relação a "a", com valores conhecidos substituídos: 8
Integral da função em relação a "a": a**3/3 + a*b*c
Integral da função em relação a "a", avaliada entre [0,5]: 5*b*c + 125/3
Integral da função em relação a "c", avaliada entre [0,5], com valores conhecidos substituídos: 105
### *aluno_exatas.fis\_exp.MMQ*
Essa classe foi feita para facilitar a utilização do MMQ linear, com incertezas variáveis ou não.
#### Importação de módulos
O módulo `fis_exp` já foi importado, de forma que não é necessário importá-lo novamente.
#### Inicializando o módulo
O módulo pode ser inicializado de diferentes formas, dependendo de que tipo de MMQ se quer calcular.
```python
mmq_inc_iguais = fe.MMQ()
mmq_inc_varia = fe.MMQ(fe.Incertezas.variaveis)
```
#### Definição de valores
Os módulos podem receber `lists`, `numpy.ndarrays` ou números normais (no caso de `incerteza_y` para incertezas iguais).
```python
x = [0, 1, 2, 3, 4]
y = np.array([1, 3, 7, 8, 10])
mmq_inc_iguais.x_values = x
mmq_inc_iguais.y_values = y
mmq_inc_iguais.incertezas_y = 1
mmq_inc_varia.x_values = x
mmq_inc_varia.y_values = y
mmq_inc_varia.incertezas_y = [1, 1, 2, 1, 3]
```
#### Recebendo de volta os coeficientes
Os coeficientes da função na forma `y = a + b*x` são retornados no formato `[a,b]`, assim como as incertezas.
```python
coef_inc_iguais, incert_inc_iguais = mmq_inc_iguais.coeficientes()
coef_inc_varia, incert_inc_varia = mmq_inc_varia.coeficientes()
print ('Coeficientes da função com incerteza constante: ', coef_inc_iguais)
print ('Incertezas dos coeficientes da função com incerteza constante:', incert_inc_iguais, '\n')
print ('Coeficientes da função com incerteza variável: ', coef_inc_varia)
print ('Incertezas dos coeficientes da função com incerteza variável:', incert_inc_varia)
```
Coeficientes da função com incerteza constante: [1.2 2.3]
Incertezas dos coeficientes da função com incerteza constante: [0.77459667 0.31622777]
Coeficientes da função com incerteza variável: [1.01265823 2.36075949]
Incertezas dos coeficientes da função com incerteza variável: [0.65822785 0.14556962]
## *aluno_exatas.calc_num*
Esse módulo tem como objetivo auxiliar o aluno que está cursando cálculo numérico. Contém funções que implementam conceitos aprendidos em aula.
#### Importando módulos úteis:
```python
import aluno_exatas.calc_num as cn
import numpy as np
```
### Métodos de aproximações sucessivas para achar zero de funções
#### Definindo a função que será usada e sua derivada
A definição da derivada é necessária para o método de Newton.
```python
def f(x):
return x+np.cos(x)
def flinha(x):
return 1-np.sin(x)
```
#### Definindo aproximações iniciais para os métodos da secante, newton e bissecção
* O método da secante precisa apenas da própria função e de duas aproximações para a raiz;
* O método de Newton precisa da função, sua derivada, e uma aproximação inicial;
* O método da bissecção precisa própria função e de duas aproximações para o intervalo que contém a raiz.
```python
x_secante = 0.0
xo_secante = 1.0
x_newton = 1.0
a_bi = -1.0
b_bi = 0.0
print('Função inicial avaliada nas aproximações iniciais:')
print('f(-1) =', f(-1))
print('f(0) =', f(0))
print('f(1) =', f(1))
```
Função inicial avaliada nas aproximações iniciais:
f(-1) = -0.45969769413186023
f(0) = 1.0
f(1) = 1.5403023058681398
#### Testando cada um dos métodos
Os métodos irão rodar por 9 iterações e será possível observar a qualidade da aproximação de cada um.
O método da secante, que é sujeito a erros por estar realizando divisão por 0, evita isso retornando os mesmos valores de `x` e `xo` que foram utilizados como entrada da função.
```python
for i in range(10):
x_secante, xo_secante = cn.metodo_secante(f, x_secante, xo_secante)
x_newton = cn.metodo_newton(f, flinha, x_newton)
a_bi, b_bi = cn.metodo_bisseccao(f, a_bi, b_bi)
print('Raiz encontrada pelo método da secante:')
print('x =', x_secante, '| xo =', xo_secante)
print('f(x) =', f(x_secante), '| f(xo) =', f(xo_secante))
print('\nRaiz encontrada pelo método de Newton:')
print('x =', x_newton)
print('f(x) =', f(x_newton))
print('\nIntervalo encontrado pelo método da bissecção:')
print('Raiz está entre:', (a_bi, b_bi))
print('f(a) =', f(a_bi), '| f(b) =', f(b_bi))
```
Raiz encontrada pelo método da secante:
x = -0.7390851332151607 | xo = -0.7390851332151607
f(x) = 0.0 | f(xo) = 0.0
Raiz encontrada pelo método de Newton:
x = -0.7390851332151607
f(x) = 0.0
Intervalo encontrado pelo método da bissecção:
Raiz está entre: (-0.7392578125, -0.73828125)
f(a) = -0.0002890091467900868 | f(b) = 0.001345149751805108