[MAIN] Change workdir files, add docstring in functions
This commit is contained in:
42
README.md
42
README.md
@@ -2,16 +2,49 @@
|
||||
|
||||
Repositorio para códigos de fitting de distribuições de dados de chuva e clutter.
|
||||
|
||||
## Instalação
|
||||
## Gerenciamento de dependências
|
||||
|
||||
Este projeto usa [uv](https://docs.astral.sh/uv/) para gerenciar dependências e ambientes virtuais.
|
||||
|
||||
### Instalação do uv
|
||||
|
||||
```bash
|
||||
pip install -e .
|
||||
curl -LsSf https://astral.sh/uv/install.sh | sh
|
||||
```
|
||||
|
||||
### Configurar o ambiente
|
||||
|
||||
```bash
|
||||
# Cria o ambiente virtual e instala todas as dependências
|
||||
uv sync
|
||||
```
|
||||
|
||||
### Adicionar dependências
|
||||
|
||||
```bash
|
||||
# Adicionar um pacote ao projeto
|
||||
uv add <pacote>
|
||||
|
||||
# Adicionar dependência de desenvolvimento
|
||||
uv add --dev <pacote>
|
||||
```
|
||||
|
||||
### Executar scripts
|
||||
|
||||
```bash
|
||||
# Executar um script dentro do ambiente virtual
|
||||
uv run python scripts/meu_script.py
|
||||
|
||||
# Abrir o Jupyter
|
||||
uv run jupyter notebook
|
||||
```
|
||||
|
||||
As dependências do projeto estão declaradas em `pyproject.toml` e o lockfile `uv.lock` garante reprodutibilidade do ambiente.
|
||||
|
||||
## Uso nos notebooks
|
||||
|
||||
```python
|
||||
from clutter_chuva import Fitter
|
||||
from etc import Fitter
|
||||
from scipy.stats import gamma, weibull_min, lognorm
|
||||
|
||||
fitter = Fitter(
|
||||
@@ -27,8 +60,9 @@ fitter.histogram_with_fits().show()
|
||||
## Estrutura
|
||||
|
||||
```text
|
||||
clutter_chuva/ # pacote principal (importável nos notebooks)
|
||||
etc/ # pacote principal (importável nos notebooks)
|
||||
fitting/ # Fitter e DistributionSummary
|
||||
tools/ # funções de visualização (plots, CDF)
|
||||
notebooks/ # notebooks Jupyter
|
||||
scripts/ # scripts .py para execução em background
|
||||
data/ # dados (não versionados)
|
||||
|
||||
Reference in New Issue
Block a user