Metadata-Version: 2.5
Name: pfem-framerotation
Version: 0.0.2
Summary: Positional Finite Element Method (PFEM) solver for 2D frame structures with finite rotations.
Project-URL: Homepage, https://github.com/wmpjrufg/PFEM_FrameRotation
Project-URL: Repository, https://github.com/wmpjrufg/PFEM_FrameRotation
Project-URL: Issues, https://github.com/wmpjrufg/PFEM_FrameRotation/issues
Author: Arthur Álax de Araújo Albuquerque
Author-email: Wanderlei Malaquias Pereira Junior <wanderlei.malaquias.pereira.jr@gmail.com>
License-Expression: MIT
License-File: LICENSE
Keywords: civil engineering,finite element method,frame structures,nonlinear analysis,positional FEM,structural analysis
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Education
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: Mathematics
Requires-Python: >=3.11
Requires-Dist: numpy>=1.24
Requires-Dist: scipy>=1.10
Provides-Extra: dev
Requires-Dist: build>=1.0; extra == 'dev'
Requires-Dist: pytest>=7.4; extra == 'dev'
Requires-Dist: twine>=5.0; extra == 'dev'
Provides-Extra: docs
Requires-Dist: myst-parser>=2.0; extra == 'docs'
Requires-Dist: sphinx-rtd-theme>=2.0; extra == 'docs'
Requires-Dist: sphinx>=7.2; extra == 'docs'
Description-Content-Type: text/markdown

# PFEM_FrameRotation

[![PyPI](https://img.shields.io/pypi/v/pfem-framerotation.svg)](https://pypi.org/project/pfem-framerotation/)
[![Python](https://img.shields.io/badge/python-3.11%2B-blue.svg)](https://www.python.org/downloads/)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)

**pfem-framerotation** é um solver de **Elementos Finitos Posicionais (PFEM)**
para pórticos planos com **rotações finitas**, resolvido por
**Newton-Raphson**. Desenvolvido no Departamento de Estruturas — Escola de
Engenharia Civil e Ambiental (EECA), Universidade Federal de Goiás (UFG).

## Instalação

```bash
pip install pfem-framerotation
```

Requer Python 3.11+. Para configurar um ambiente de desenvolvimento local a
partir do código-fonte usando [uv](https://docs.astral.sh/uv/) (criação,
ativação/desativação do ambiente), veja [README_ENV.md](README_ENV.md).

## Uso rápido

```python
from pfem_framerotation import reading_file, newton_raphson  # e demais funções

# veja o passo a passo completo em examples/pfem_framerotation_quickstart.ipynb
```

* **Notebook de exemplo (Google Colab):**
  [`examples/pfem_framerotation_quickstart.ipynb`](examples/pfem_framerotation_quickstart.ipynb)
  — resolve uma viga em balanço passo a passo, pronto para rodar no Colab.
* **Script de exemplo local:**
  [`examples/run_local_example.py`](examples/run_local_example.py)

## Documentação

A documentação completa da API (gerada com Sphinx a partir das docstrings) e
as instruções para buildar/publicar a documentação estão em
[README_DOCS.md](README_DOCS.md).

## Lançando uma nova versão

Passo a passo de bump de versão, build e publicação no TestPyPI/PyPI está em
[README_RELEASE.md](README_RELEASE.md).

## Autores

* Prof. Arthur Álax de Araújo Albuquerque
* Prof. Wanderlei Malaquias Pereira Junior

## Licença

Distribuído sob a licença [MIT](LICENSE).