pfem-framerotation 0.0.1__tar.gz

pfem_framerotation-0.0.1/.gitignore

@@ -0,0 +1,23 @@
+# Virtual environments
+.venv/
+venv/
+env/
+
+# Python bytecode / build artifacts
+__pycache__/
+*.pyc
+*.egg-info/
+build/
+dist/
+
+# Sphinx documentation build output
+docs/build/
+docs/_build/
+
+# Solver outputs
+Output.ogl
+
+# Editors / OS
+.vscode/
+.idea/
+.DS_Store

pfem_framerotation-0.0.1/.readthedocs.yaml

@@ -0,0 +1,16 @@
+version: 2
+
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.11"
+
+sphinx:
+  configuration: docs/source/conf.py
+
+python:
+  install:
+    - method: pip
+      path: .
+      extra_requirements:
+        - docs

pfem_framerotation-0.0.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Arthur Álax de Araújo Albuquerque, Wanderlei Malaquias Pereira Junior
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

pfem_framerotation-0.0.1/PKG-INFO

@@ -0,0 +1,89 @@
+Metadata-Version: 2.5
+Name: pfem-framerotation
+Version: 0.0.1
+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).

pfem_framerotation-0.0.1/README.md

@@ -0,0 +1,54 @@
+# 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).

pfem_framerotation-0.0.1/README_DOCS.md

@@ -0,0 +1,90 @@
+# Documentação (Sphinx)
+
+A documentação é gerada com [Sphinx](https://www.sphinx-doc.org/) a partir
+das docstrings já escritas nas funções do pacote
+(`src/pfem_framerotation/core.py`), usando `autodoc` + `napoleon`
+(reconhece tanto docstrings estilo reST/`:param:` quanto estilo Google
+`Args:`/`Returns:`).
+
+Estrutura:
+
+```
+docs/
+├── Makefile / make.bat   # atalhos "make html" (Linux/macOS) e make.bat (Windows)
+├── requirements.txt      # dependências só de docs (usado pelo Read the Docs)
+└── source/
+    ├── conf.py           # configuração do Sphinx
+    ├── index.rst         # página inicial / índice
+    ├── installation.rst  # instruções de instalação
+    ├── quickstart.rst    # exemplo de uso rápido
+    └── api.rst           # referência da API (autodoc)
+```
+
+## 1. Instalar as dependências de documentação
+
+Usando [uv](https://docs.astral.sh/uv/) (veja [README_ENV.md](README_ENV.md)
+para instalar o uv e detalhes do ambiente):
+
+```bash
+uv sync --extra docs
+```
+
+## 2. Buildar a documentação localmente
+
+Com o ambiente sincronizado, rode o build via `uv run` (não precisa ativar a
+venv manualmente):
+
+```bash
+cd docs
+uv run make html          # Linux / macOS
+uv run make.bat html      # Windows
+```
+
+Ou, se preferir ativar a venv primeiro (`source ../.venv/bin/activate`),
+os comandos tradicionais também funcionam:
+
+```bash
+cd docs
+make html          # Linux / macOS
+make.bat html      # Windows
+```
+
+O resultado é gerado em `docs/build/html/index.html` — abra esse arquivo no
+navegador para conferir.
+
+Para gerar do zero (limpar cache e rebuildar):
+
+```bash
+make clean html
+```
+
+## 3. Atualizando a documentação
+
+* **Novas funções documentadas**: adicione uma entrada em
+  [`docs/source/api.rst`](docs/source/api.rst) com
+  `.. autofunction:: pfem_framerotation.nome_da_funcao` (ou deixe que a seção
+  `automodule:: pfem_framerotation.core` no final do arquivo capture
+  automaticamente qualquer função nova do módulo).
+* **Docstrings**: escreva no estilo reST (`:param nome:`, `:return:`) ou
+  estilo Google (`Args:`, `Returns:`) — ambos são renderizados corretamente.
+* **Páginas novas**: crie um `.rst` (ou `.md`, suportado via `myst-parser`)
+  dentro de `docs/source/` e adicione o nome do arquivo (sem extensão) na
+  `toctree` de [`index.rst`](docs/source/index.rst).
+
+## 4. Publicando ("subindo") a documentação
+
+Este repositório já inclui um [`.readthedocs.yaml`](.readthedocs.yaml) na
+raiz, pronto para hospedar a documentação em
+[Read the Docs](https://readthedocs.org/) (gratuito para projetos
+open source):
+
+1. Crie uma conta em readthedocs.org e conecte sua conta do GitHub.
+2. Importe o repositório `PFEM_FrameRotation`.
+3. O Read the Docs detecta o `.readthedocs.yaml` automaticamente e builda a
+   documentação a cada push feito na branch `main` (ou a cada tag/release).
+4. A URL pública terá o formato
+   `https://pfem-framerotation.readthedocs.io`.
+
+Alternativa: publicar como GitHub Pages usando o HTML gerado em
+`docs/build/html/` (ex.: via GitHub Actions rodando `make html` e fazendo
+deploy da pasta para a branch `gh-pages`).

pfem_framerotation-0.0.1/README_ENV.md

@@ -0,0 +1,132 @@
+# Ambiente de desenvolvimento (uv)
+
+Este projeto usa **Python 3.11** e declara suas dependências e metadados no
+[`pyproject.toml`](pyproject.toml) (padrão PEP 621), o mesmo arquivo usado
+para gerar o pacote publicado no PyPI (`pfem-framerotation`).
+
+Para criar e gerenciar o ambiente virtual usamos o
+[**uv**](https://docs.astral.sh/uv/), um gerenciador de projetos Python
+rápido (escrito em Rust) que substitui `pip` + `venv` + `pyenv` em uma única
+ferramenta. Com o uv você **não precisa nem ter o Python 3.11 pré-instalado**
+no seu sistema — ele baixa e gerencia a versão certa automaticamente com
+base no `requires-python` do `pyproject.toml`.
+
+## 1. Instalando o uv (uma única vez por máquina)
+
+```bash
+# Linux / macOS
+curl -LsSf https://astral.sh/uv/install.sh | sh
+
+# Windows (PowerShell)
+powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"
+
+# alternativa multiplataforma, se você já tem pip/pipx
+pipx install uv
+```
+
+Verifique a instalação:
+
+```bash
+uv --version
+```
+
+## 2. Criando o ambiente e instalando o projeto
+
+Na raiz do repositório, basta rodar `uv sync`. O uv lê o `pyproject.toml`,
+baixa o Python 3.11 se necessário, cria a pasta `.venv/` e instala o pacote
+(em modo editável) junto com suas dependências:
+
+```bash
+# apenas as dependências de uso (numpy, scipy)
+uv sync
+
+# + dependências para build da documentação (Sphinx)
+uv sync --extra docs
+
+# + dependências de desenvolvimento (build, twine, pytest)
+uv sync --extra dev
+
+# tudo de uma vez
+uv sync --all-extras
+```
+
+Isso também gera/atualiza o arquivo `uv.lock` (versões exatas resolvidas),
+que deve ser **versionado no git** para builds reprodutíveis — é o
+equivalente ao `pyproject.toml` "travado".
+
+A pasta `.venv/` já está no [`.gitignore`](.gitignore) e não deve ser
+versionada.
+
+## 3. Ativando o ambiente
+
+O `.venv/` criado pelo uv é uma venv padrão do Python, então os comandos de
+ativação de sempre funcionam normalmente:
+
+```bash
+# Linux / macOS (bash/zsh)
+source .venv/bin/activate
+
+# Windows (PowerShell)
+.venv\Scripts\Activate.ps1
+
+# Windows (cmd)
+.venv\Scripts\activate.bat
+```
+
+Quando ativa, o prompt do terminal passa a mostrar `(pfem-framerotation)` ou
+`(.venv)` no início da linha.
+
+**Alternativa (sem ativar manualmente):** prefixe qualquer comando com
+`uv run` e o uv usa o `.venv` do projeto automaticamente:
+
+```bash
+uv run python examples/run_local_example.py
+uv run pytest
+```
+
+Verifique que a instalação funcionou:
+
+```bash
+uv run python -c "import pfem_framerotation; print(pfem_framerotation.__version__)"
+# ou, com o ambiente já ativado:
+python -c "import pfem_framerotation; print(pfem_framerotation.__version__)"
+```
+
+## 4. Desativando o ambiente
+
+Se você ativou a venv manualmente (passo 3), desative com:
+
+```bash
+deactivate
+```
+
+Isso retorna o terminal ao Python do sistema. Se você usa apenas `uv run`,
+não há nada para desativar — cada comando já roda isolado no `.venv` do
+projeto.
+
+## 5. Adicionando/removendo dependências
+
+Em vez de editar o `pyproject.toml` manualmente, use:
+
+```bash
+uv add nome-do-pacote          # adiciona dependência de uso
+uv add --optional docs sphinx  # adiciona a um grupo opcional, ex.: "docs"
+uv add --dev pytest            # adiciona dependência de desenvolvimento
+uv remove nome-do-pacote       # remove
+```
+
+Esses comandos atualizam o `pyproject.toml`, o `uv.lock` e o `.venv`
+automaticamente.
+
+## 6. Removendo o ambiente (recomeçar do zero)
+
+```bash
+# Linux / macOS
+rm -rf .venv
+
+# Windows (PowerShell)
+Remove-Item -Recurse -Force .venv
+```
+
+e rode `uv sync` novamente (passo 2). O `uv.lock` pode ser mantido — ele
+garante que as mesmas versões serão reinstaladas.

pfem_framerotation-0.0.1/README_RELEASE.md

@@ -0,0 +1,132 @@
+# Como lançar uma nova versão (build + PyPI)
+
+Passo a passo para publicar uma nova versão do `pfem-framerotation`, sempre
+testando primeiro no **TestPyPI** antes do PyPI real.
+
+## 0. Pré-requisitos (uma vez só)
+
+* [uv](https://docs.astral.sh/uv/) instalado (veja [README_ENV.md](README_ENV.md)).
+* Conta em https://pypi.org/account/register/ e em
+  https://test.pypi.org/account/register/ (são contas **separadas**, cadastre
+  nas duas).
+* Um API token de cada uma (*Account settings → API tokens*). Guarde os dois
+  tokens com segurança (ex.: gerenciador de senhas); eles não devem ir para o
+  repositório.
+
+## 1. Atualize o changelog / confira o que vai entrar na versão
+
+```bash
+git log --oneline v0.0.1..HEAD   # ou desde a última tag/versão publicada
+```
+
+## 2. Bump de versão
+
+A versão do pacote vem de **um único lugar**:
+[`src/pfem_framerotation/__init__.py`](src/pfem_framerotation/__init__.py),
+na linha `__version__ = "0.0.1"`. O `pyproject.toml` lê esse valor
+automaticamente (`dynamic = ["version"]` + `[tool.hatch.version]`), então
+**não precisa editar o `pyproject.toml`**.
+
+```bash
+# edite manualmente __version__ em src/pfem_framerotation/__init__.py, por exemplo:
+# 0.0.1 -> 0.0.2  (correção de bug)
+# 0.0.1 -> 0.1.0  (nova funcionalidade)
+# 0.1.0 -> 1.0.0  (primeira versão estável / mudança incompatível)
+```
+
+Use [Versionamento Semântico](https://semver.org/lang/pt-BR/): `MAJOR.MINOR.PATCH`.
+
+Depois de editar, confira que o valor foi captado corretamente:
+
+```bash
+uv run python -c "import pfem_framerotation; print(pfem_framerotation.__version__)"
+```
+
+Commite o bump de versão:
+
+```bash
+git add src/pfem_framerotation/__init__.py
+git commit -m "chore: bump version to X.Y.Z"
+git tag vX.Y.Z
+```
+
+## 3. Limpe builds antigos e gere os artefatos
+
+```bash
+rm -rf dist/
+uv build
+```
+
+Isso gera `dist/pfem_framerotation-X.Y.Z.tar.gz` (sdist) e
+`dist/pfem_framerotation-X.Y.Z-py3-none-any.whl` (wheel).
+
+## 4. Valide os artefatos antes de subir
+
+```bash
+uv run --with twine twine check dist/*
+```
+
+Precisa aparecer `PASSED` para os dois arquivos. Se aparecer `FAILED`,
+corrija o problema (geralmente é o `readme`/metadados do `pyproject.toml`)
+antes de continuar.
+
+## 5. Suba para o TestPyPI primeiro
+
+```bash
+uv publish --publish-url https://test.pypi.org/legacy/ --token <seu-token-testpypi>
+```
+
+Confira a página gerada: `https://test.pypi.org/project/pfem-framerotation/`
+
+### Teste a instalação a partir do TestPyPI
+
+O TestPyPI não tem `numpy`/`scipy` publicados nele, então é preciso apontar
+as duas fontes: TestPyPI para o nosso pacote e o PyPI normal para as
+dependências.
+
+```bash
+uv run --python 3.11 --with pfem-framerotation \
+    --index https://test.pypi.org/simple/ \
+    --index https://pypi.org/simple/ \
+    --index-strategy unsafe-best-match \
+    python -c "import pfem_framerotation; print(pfem_framerotation.__version__)"
+```
+
+Se importar e mostrar a versão nova sem erro, está tudo certo.
+
+## 6. Suba para o PyPI real
+
+Só depois que o passo 5 funcionar:
+
+```bash
+uv publish --token <seu-token-pypi>
+```
+
+Confira: `https://pypi.org/project/pfem-framerotation/`
+
+### Teste final, como um usuário faria
+
+```bash
+uv run --python 3.11 --with pfem-framerotation python -c "import pfem_framerotation; print(pfem_framerotation.__version__)"
+# ou, fora de qualquer projeto:
+pip install pfem-framerotation
+```
+
+## 7. Depois de publicar
+
+```bash
+git push origin main --tags
+```
+
+## Lembretes importantes
+
+* **Uma versão publicada no PyPI é permanente** — não é possível reenviar o
+  mesmo número de versão (nem no PyPI, nem no TestPyPI), mesmo se você
+  apagar os arquivos localmente. Se algo der errado, corrija e publique
+  `X.Y.Z+1`. É possível "yank" (marcar como não recomendada) uma versão
+  quebrada, mas ela não desaparece do índice.
+* Para não digitar o token toda vez, exporte antes de rodar `uv publish`:
+  ```bash
+  export UV_PUBLISH_TOKEN=<seu-token>
+  ```
+* Nunca commite tokens no repositório.

pfem_framerotation-0.0.1/docs/Makefile

@@ -0,0 +1,19 @@
+# Minimal makefile for Sphinx documentation
+
+# You can set these variables from the command line, and also
+# from the environment, for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

pfem_framerotation-0.0.1/docs/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.https://www.sphinx-doc.org/
+	exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

pfem_framerotation-0.0.1/docs/requirements.txt

@@ -0,0 +1,3 @@
+sphinx>=7.2
+sphinx-rtd-theme>=2.0
+myst-parser>=2.0