avisos doc

viniciusdutra314 · viniciusdutra314 · commit c55b982107d8 · 2025-01-26T19:19:37.000Z
diff --git a/docs/api.md b/docs/api.md
@@ -16,6 +16,6 @@ leia a secção [introdução](introducao.md)
     options:
       members_order: alphabetical
 
-::: LabIFSC2._regressões
+::: LabIFSC2._regressoes
     options:
       members_order: alphabetical
diff --git a/docs/index.md b/docs/index.md
@@ -16,6 +16,27 @@ Podemos copiar o resultado em formato \(\LaTeX\) e adicionarmos em nosso relató
 ```py title="Estimativa da gravidade (sem LabIFSC2)"
 --8<-- "tests/test_doc_gravidade_sem_LabIFSC2.py:5:14"
 ```
+
+## O que há de novo?
+O LabIFSC2 é uma modernização da antiga biblioteca [LabIFSC](https://github.com/gjvnq/LabIFSC), os desenvolvedores do LabIFSC2 não são os mesmos, porém queríamos deixar aqui nosso agradecimento por terem concebido uma solução tão elegante que agilizou a graduação de várias pessoas.
+
+
+Mesmo que a interface seja intencionalmente parecida a implementação é totalmente nova, para fazermos um resumo das melhorias estamos fazendo essa tabela.
+
+
+| Feature         | LabIFSC       | LabIFSC2      |
+|-----------------|---------------|---------------|
+| Propagação de erros | Linear      | Arbitrária (Monte Carlo)          |
+| Regressões        |   Linear    |  Linear,polinomial,exponencial e lei de potência | 
+| Unidades | Implementação autoral | Baseado no famoso [pint](https://pint.readthedocs.io/)
+| Constantes da natureza| ❌ | +350  definidas pela [CODATA(2022)](https://codata.org/initiatives/data-science-and-stewardship/fundamental-physical-constants/)
+| Operações com arrays| ❌ | Suportadas pelo [Numpy](numpy.org) 
+| Segurança de tipos (mypy)| ❌ | ✅ 
+| Docstrings em funções | ❌ | ✅
+| Suporte         | ❌ | Ativo         |
+| Documentação    | Parcial      | Completa      |
+
+
 ## Instalação
 A biblioteca está disponível no PyPI(Python Package Index), então ela pode ser instalada facilmente usando pip, atualmente é necessário ter uma versão do python igual ou superior a 3.10, para descobrir a versão do seu python digite `python --version` no terminal
 ```bash
@@ -24,7 +45,7 @@ pip install LabIFSC2
 Recomendamos você instalar o LabIFSC2 é um ambiente virtual, caso não saiba o que é isso, por favor 
 leia essa [secção](_instalacao.md)
 
-## Escopo de aplicação
+## Escopo
 A biblioteca tem a intenção de agilizar cálculos dos laboratórios de física do IFSC da USP de São Carlos:
 
 - Laboratório de Física I
@@ -36,24 +57,34 @@ A biblioteca tem a intenção de agilizar cálculos dos laboratórios de física
 
 Os critérios de comparação e formatação são baseadas na última versão da [apostila I](https://www.ifsc.usp.br/lef/index.php/apostilas/) atualmente a versão 2017 (caso já exista uma versão mais recente por favor nós avise).
 
+!!! warning
+    A propagação de incertezas recomendadas pela apostila 1 é somente uma aproximação linear do que seria
+    a propagação exata, por generalidade e um certo preciosismo do autor, o LabIFSC2 realiza uma propagação
+    por Monte Carlo que seria o que computacionalmente temos o mais próximo de exata.
+    
+    Por isso, em diversos casos, o LabIFSC (que implementa exatamente a apostila), dará incertezas diferentes do
+    LabIFSC2, geralmente incertezas maiores. Acredito que a maioria dos professores não se importaram com isso,
+    visto que é um método mais correto, mas é sempre importante estar ciente disso.
+
+
 É óbvio que a biblioteca se aplica a outros laboratórios e de outras universidades (principalmente por ter propagação de erros por Monte Carlo). 
-**Só por favor fique atento que talvez certas convenções sejam diferentes**
+**Só por favor fique atento que talvez certas convenções ou métodos sejam diferentes**
 
-## O que há de novo?
-O LabIFSC2 é uma modernização da antiga biblioteca [LabIFSC](https://github.com/gjvnq/LabIFSC), os desenvolvedores do LabIFSC2 não são os mesmos, porém queríamos deixar aqui nosso agradecimento por terem concebido uma solução tão elegante que agilizou a graduação de várias pessoas.
+## Recomendação pessoal
+Eu fiz o laboratório I, somente com calculadora científica, convertendo unidades, propagando os erros derivando na mão, mínimos
+quadrados usando tabelas e papel milimetrado.
 
+Somente no laboratório II, devido ao [Breno Pelegrin](https://github.com/brenopelegrin) eu comecei a me converter ao mundo da programação, e fazer o que eu acho acredito ser o mais fácil, relatórios em LaTeX (overleaf) e 
+cálculos em python (Google colab para fazer em várias pessoas).
 
-Mesmo que a interface seja intencionalmente parecida a implementação é totalmente nova, para fazermos um resumo das melhorias estamos fazendo essa tabela.
+Eu acredito que o meu primeiro semestre manual foi muito importante para a minha real compreensão de como esses cálculos
+são feitos, **eu sei como essas coisas funcionam**, tanto que eu consegui fazer uma biblioteca que implementa esses cálculos
+quase que do zero.
 
+A minha recomendação pessoal é que você NÃO utilize essa biblioteca ao menos que tenha uma noção de como ela funciona,
+eu não quero que por exemplo as funções `regressao_linear`,`comparar_medidas`,`intervalo_de_confianca`... Sejam coisas 
+mágicas que você utilize sem pensar.
 
-| Feature         | LabIFSC       | LabIFSC2      |
-|-----------------|---------------|---------------|
-| Propagação de erros | Linear      | Arbitrária (Monte Carlo)          |
-| Regressões        |   Linear    |  Linear,polinomial,exponencial e lei de potência | 
-| Unidades | Implementação autoral | Baseado no famoso [pint](https://pint.readthedocs.io/)
-| Constantes da natureza| ❌ | +350  definidas pela [CODATA(2022)](https://codata.org/initiatives/data-science-and-stewardship/fundamental-physical-constants/)
-| Operações com arrays| ❌ | Suportadas pelo [Numpy](numpy.org) 
-| Segurança de tipos (mypy)| ❌ | ✅ 
-| Docstrings em funções | ❌ | ✅
-| Suporte         | ❌ | Ativo         |
-| Documentação    | Parcial      | Completa      |
+Eu gostaria que ela fosse usada igual ao uso de uma calculadora para realizar operações com números de vários dígitos,
+**certamente você sabe como multiplicar `134,5` e `0.215` na mão**, só que não faz sentido perder horas calculando essas coisas,
+se você tem uma calculadora para isso.
diff --git a/docs/introducao.md b/docs/introducao.md
@@ -49,6 +49,14 @@ Esse comportamento pode ser visto nesse exemplo, preste atenção nas incertezas
 ```py title="Cálculo de IMC"
 --8<-- "tests/test_doc_medida_lista.py:7:10"
 ```
+## Medidas sem incerteza
+É possível criar medidas com incerteza zero, nesse caso, a biblioteca somente realizará as 
+conversões de unidade. Isso é interessante para um conjunto grande de medidas em que a incerteza
+é muito pequena, por exemplo, as medidas de voltagem de um osciloscópio, em que a precisão tempo 
+é enorme, é possível tratar os tempos como exatos, assim um grande ganho em performance é observado,
+visto que
+
+
 
 ## Comparando Medidas
 Se uma segunda pessoa afirmar que seu IMC é de (25 ± 0.1), podemos dizer que seus IMCs são equivalentes? Mesmo que \(25 \ne 24.5\), pela incerteza nas medidas podemos dizer que essa diferença está na margem de erro do experimento.
@@ -73,6 +81,18 @@ O critério usado é o da apostila:
 
 Intuitivamente, a comparação é feita pelo quanto os valores nominais são diferentes e quanta incerteza temos nas medidas.
 
+## Ordenando Medidas
+Em alguns momentos nós queremos usar o `max` ou `min` de um conjunto de medidas, imagine que você quer por exemplo
+determinar a voltagem/corrente máxima atingida por um circuito.
+
+Mesmo que existam incertezas, geralmente o que você se refere como min,max é em relação ao valor nominal, então
+a classe `Medida` implementa comparações < <= > >=, referentes aos valores nominais, assim é possível usar 
+funções do tipo `max`,`min` e `sort` de maneira direta.
+
+```py 
+--8<-- "tests/test_doc_sorted_list.py:5:13"
+```
+
 ## Intervalo de Confiança
 Como estamos falando de medidas experimentais, falamos de **intervalos** e não valores exatos. Objetos da classe `Medida` possuem um método chamado `intervalo_de_confiança`. Com ele, podemos especificar uma probabilidade `p` de estarmos representando os valores possíveis das Medidas.
 
@@ -94,6 +114,17 @@ Um exemplo concreto se encontra abaixo:
 
 ```py title="Conversão de unidades Medida"
 --8<-- "tests/test_doc_imc_cm.py:10:14"
+
+```
+
+
+## Dimensão
+Como unidades só são uma característica do print de uma medida, e não algo intrínseco, uma forma independente de unidade
+para caracterizar o que uma medida é de fato é sua dimensão. Uma velocidade por exemplo, independente se está em
+\(km/h\) ou \(m/s\), é um comprimento divido por um tempo. Você pode acessar esse atributo com `medida.dimensao`
+
+```py
+--8<-- "tests/test_doc_dimensao.py:5:6"
 ```
 
 [^1]:
