crispim1411/distance

Função de cálculo de distância de um ponto a uma função dada por parâmetro. Criado ambiente isolado utilizando Poetry e código documentado utilizando Sphinx.

Configuração do Ambiente do Projeto

Código para retornar e plotar a distância entre um ponto e uma curva.

Overview sobre como rodar

1. Crie um ambiente virtual Python utilizando Poetry
2. Instale os pacotes requeridos
3. Instale a biblioteca de Python para plot
4. Execute o código

Procedimento de setup

1. Criar um ambiente com Poetry:
   • poetry init
   • poetry shell
2. Instalar os pacotes Numpy, Scipy e Matplotlib
   • poetry add numpy scipy matplotlib
3. Instalar python3-tk para plotagem
   • sudo apt install python3-tk -y
4. Executar
   • python3 distance

Uso

• Introduzir as coordenadas x,y do ponto e a função ao fim será retornada a distância e o gráfico da função.

  • A função pode ser polinomial, exponencial, senoidal, etc
  • A descrição dos elementos da funções seguem o formato da linguagem Python, então para representar um elemento de coeficiente 3 atrelado a um termo x de expoente 2 resultará 3*x**2

Documentar código

1. Instalar Sphinx
   • sudo apt install python3-sphinx
2. Iniciar
   • sphinx-quickstart
3. Configurar estrutura de documentação
   • arquivos conf.py e index.rst na pasta source
4. Construir documentação em html
   • sphinx-build -b html source build