Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 11 additions & 1 deletion .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -1,20 +1,30 @@
name: docs

on:
push:
branches: [main]
pull_request:

permissions:
contents: write

jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0 # the authors page is generated from the git history

- uses: actions/setup-python@v5
with:
python-version: "3.12"

- run: pip install -r docs/requirements.txt
- run: sphinx-build -b html docs/source docs/build/html

# Builds English, Spanish, Portuguese and Italian; warnings are errors (-W).
- run: python docs/tools/build_docs.py

- uses: peaceiris/actions-gh-pages@v4
if: github.ref == 'refs/heads/main'
with:
Expand Down
33 changes: 33 additions & 0 deletions .github/workflows/tests-all.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
name: tests-all

# The slow tests build the complete beam model of the example (about 167,000
# nodes). They are run on demand, not on every push.
on:
workflow_dispatch:

jobs:
matlab:
name: All tests (including slow)
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4

- name: Set up MATLAB
uses: matlab-actions/setup-matlab@v2
with:
release: R2023b

- name: Run the build (static analysis + all tests)
uses: matlab-actions/run-build@v2
with:
tasks: check testAll

- name: Keep the reports
if: always()
uses: actions/upload-artifact@v4
with:
name: reports-all
path: |
test-results/
code-coverage/
if-no-files-found: ignore
32 changes: 28 additions & 4 deletions .github/workflows/tests.yml
Original file line number Diff line number Diff line change
@@ -1,11 +1,35 @@
name: tests
on: [push, pull_request]

on:
push:
pull_request:

jobs:
matlab:
name: Code Analyzer and tests
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: matlab-actions/setup-matlab@v2
- uses: matlab-actions/run-command@v2

- name: Set up MATLAB
uses: matlab-actions/setup-matlab@v2
with:
command: addpath('tests'); run_tests
# The code uses name=value arguments, the arguments block, buildtool and
# dictionary, so R2022b is the oldest release that can run it.
release: R2023b

- name: Run the build (static analysis + fast tests with coverage)
uses: matlab-actions/run-build@v2
with:
tasks: check test

- name: Keep the reports
if: always()
uses: actions/upload-artifact@v4
with:
name: reports
path: |
test-results/
code-coverage/
code-issues/
if-no-files-found: ignore
258 changes: 37 additions & 221 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,225 +1,41 @@
# Byte-compiled / optimized / DLL files
# MATLAB
*.asv
*.m~
*.mex*
slprj/
codegen/
*.autosave
resources/project/

# LDEM simulation outputs (written to the working directory / output folder)
output/
LET.CON
LET.DIS
LET.POS
LET.ENE
LET.RES
Lei_Barra.TXT
Energia_Barra.TXT
BARI.txt
ANSYS*.MAC
*.vtu
*.pvd

# Test artifacts
test-results/
code-coverage/

# Python / Sphinx (docs)
docs/locale/**/*.mo
__pycache__/
*.py[codz]
*$py.class

# C extensions
*.so

# Distribution / packaging
.Python
build/
develop-eggs/
dist/
downloads/
eggs/
.eggs/
lib/
lib64/
parts/
sdist/
var/
wheels/
share/python-wheels/
*.egg-info/
.installed.cfg
*.egg
MANIFEST

# PyInstaller
# Usually these files are written by a python script from a template
# before PyInstaller builds the exe, so as to inject date/other infos into it.
*.manifest
*.spec

# Installer logs
pip-log.txt
pip-delete-this-directory.txt

# Unit test / coverage reports
htmlcov/
.tox/
.nox/
.coverage
.coverage.*
.cache
nosetests.xml
coverage.xml
*.cover
*.py.cover
*.lcov
.hypothesis/
.pytest_cache/
cover/

# Translations
*.mo
*.pot

# Django stuff:
*.log
local_settings.py
db.sqlite3
db.sqlite3-journal

# Flask stuff:
instance/
.webassets-cache

# Scrapy stuff:
.scrapy

# Sphinx documentation
.venv/
docs/build/
docs/_build/
BARR_ROMP.dat
SIM01.DAT
code-issues/
.buildtool/

# PyBuilder
.pybuilder/
target/

# Jupyter Notebook
.ipynb_checkpoints

# IPython
profile_default/
ipython_config.py

# pyenv
# For a library or package, you might want to ignore these files since the code is
# intended to run in multiple environments; otherwise, check them in:
# .python-version

# pipenv
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
# However, in case of collaboration, if having platform-specific dependencies or dependencies
# having no cross-platform support, pipenv may install dependencies that don't work, or not
# install all needed dependencies.
# Pipfile.lock

# uv
# Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
# This is especially recommended for binary packages to ensure reproducibility, and is more
# commonly ignored for libraries.
# uv.lock

# poetry
# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
# This is especially recommended for binary packages to ensure reproducibility, and is more
# commonly ignored for libraries.
# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
# poetry.lock
# poetry.toml

# pdm
# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
# pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
# https://pdm-project.org/en/latest/usage/project/#working-with-version-control
# pdm.lock
# pdm.toml
.pdm-python
.pdm-build/

# pixi
# Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
# pixi.lock
# Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
# in the .venv directory. It is recommended not to include this directory in version control.
.pixi/*
!.pixi/config.toml

# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
__pypackages__/

# Celery stuff
celerybeat-schedule*
celerybeat.pid

# Redis
*.rdb
*.aof
*.pid

# RabbitMQ
mnesia/
rabbitmq/
rabbitmq-data/

# ActiveMQ
activemq-data/

# SageMath parsed files
*.sage.py

# Environments
.env
.envrc
.venv
env/
venv/
ENV/
env.bak/
venv.bak/

# Spyder project settings
.spyderproject
.spyproject

# Rope project settings
.ropeproject

# mkdocs/Zensical documentation
/site

# mypy
.mypy_cache/
.dmypy.json
dmypy.json

# Pyre type checker
.pyre/

# pytype static type analyzer
.pytype/

# Cython debug symbols
cython_debug/

# PyCharm
# JetBrains specific template is maintained in a separate JetBrains.gitignore that can
# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
# and can be added to the global gitignore or merged into this file. For a more nuclear
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
# .idea/

# Abstra
# Abstra is an AI-powered process automation framework.
# Ignore directories containing user credentials, local state, and settings.
# Learn more at https://abstra.io/docs
.abstra/

# Visual Studio Code
# Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore that
# can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
# and can be added to the global gitignore or merged into this file. However, if you prefer, you
# could uncomment the following to ignore the entire vscode folder
# .vscode/
# Temporary file for partial code execution
tempCodeRunnerFile.py

# Ruff stuff:
.ruff_cache/

# PyPI configuration file
.pypirc

# Marimo
marimo/_static/
marimo/_lsp/
__marimo__/

# Streamlit
.streamlit/secrets.toml

# MATLAB / LDEM
*.asv
*.m~
# Documentation build
docs/build/
docs/source/_generated/
4 changes: 4 additions & 0 deletions .mailmap
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Merges the different identities of one person so that AUTHORS is correct.
Boris Rojo Tanzi <71112604+borisrojotanzi@users.noreply.github.com>
Boris Rojo Tanzi <71112604+borisrojotanzi@users.noreply.github.com> <borisrojotanzi@users.noreply.github.com>
Rodrigo Cavasotto Oscar Montanha <rodrigocavasotto@gmail.com>
9 changes: 9 additions & 0 deletions AUTHORS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Authors

Generated from the git history and `CITATION.cff` by `docs/tools/generate_authors.py`. Do not edit by hand.

| Name | Commits |
|------|---------|
| Boris Rojo Tanzi | 19 |
| Rodrigo Cavasotto Oscar Montanha | 7 |
| Ignacio Iturrioz | - |
Loading
Loading