Merge pull request #416 from RocketPy-Team/rel/v1.0.0

REL: The v1.0.0 is finally out
RocketPy-Team · Sep 23, 2023 · 2a8f00c · 2a8f00c
2 parents 171e61f + 1c57c28
commit 2a8f00c
Show file tree

Hide file tree

Showing 280 changed files with 280,224 additions and 155,282 deletions.
diff --git a/.github/auto-assign.yml b/.github/auto-assign.yml
@@ -4,16 +4,19 @@ addReviewers: true
 # Set to 'author' to add PR's author as a assignee
 addAssignees: author
 
-# A list of reviewers to be added to PRs (GitHub user  name)
+# A list of reviewers to be added to PRs (GitHub user name)
 reviewers:
   - Gui-FernandesBR
   - giovaniceotto
   - MateusStano
-
+  - phmbressan
+
 # A number of reviewers added to the PR
 # Set 0 to add all the reviewers (default: 0)
 numberOfReviewers: 0
 
 # A list of keywords to be skipped the process if PR's title include it
 skipKeywords:
   - wip
+  - work in progress
+  - draft
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
@@ -4,52 +4,35 @@
 
 ## Pull request type
 
-Please check the type of change your PR introduces:
-
-- [ ] Code base additions (bugfix, features)
-- [ ] Code maintenance (refactoring, formatting, renaming, tests)
-- [ ] ReadMe, Docs and GitHub maintenance
+- [ ] Code changes (bugfix, features)
+- [ ] Code maintenance (refactoring, formatting, tests)
+- [ ] ReadMe, Docs and GitHub updates
 - [ ] Other (please describe):
 
-## Pull request checklist
-
-Please check if your PR fulfills the following requirements, depending on the type of PR:
-
-- ReadMe, Docs and GitHub maintenance:
-
-  - [ ] Spelling has been verified
-  - [ ] Code docs are working correctly 
+## Checklist
 
-- Code base maintenance (refactoring, formatting, renaming):
+- [ ] Tests for the changes have been added (if needed)
+- [ ] Docs have been reviewed and added / updated
+- [ ] Lint (`black rocketpy/ tests/`) has passed locally 
+- [ ] All tests (`pytest --runslow`) have passed locally
 
-  - [ ] Docs have been reviewed and added / updated if needed
-  - [ ] Lint (`black rocketpy`) has passed locally and any fixes were made
-  - [ ] All tests (`pytest --runslow`) have passed locally
-
-- Code base additions (for bug fixes / features):
-
-  - [ ] Tests for the changes have been added
-  - [ ] Docs have been reviewed and added / updated if needed
-  - [ ] Lint (`black rocketpy`) has passed locally and any fixes were made
-  - [ ] All tests (`pytest --runslow`) have passed locally
-
-## What is the current behavior?
-<!-- Please describe the current behavior that you are modifying, or link to a relevant issue. -->
+## Current behavior
+<!-- Describe current behavior or link to an issue. -->
 
 Enter text here...
 
-## What is the new behavior?
-<!-- Please describe the behavior or changes that are being added by this PR. -->
+## New behavior
+<!-- Describe changes introduced by this PR. -->
 
 Enter text here...
 
-## Does this introduce a breaking change?
+## Breaking change
 <!-- If this introduces a breaking change, please describe the impact and migration path for existing applications below. -->
 
 - [ ] Yes
 - [ ] No
 
-## Other information
-<!-- Any other information that is important to this PR such as screenshots of how the component looks before and after the change. -->
+## Additional information
+<!-- Include any relevant details or screenshots. -->
 
-Enter text here...
+Enter text here...
diff --git a/.github/workflows/auto-assign-projects b/.github/workflows/auto-assign-projects
diff --git a/.github/workflows/auto-assign.yml b/.github/workflows/auto-assign.yml
@@ -1,7 +1,5 @@
-name: Auto Assign Issues and PRs once opened
+name: Auto Assign PRs once opened
 on:
-  issues:
-    types: [opened]
   pull_request:
     types: [opened]
 jobs:

diff --git a/.github/workflows/publish-to-pypi.yml b/.github/workflows/publish-to-pypi.yml
@@ -12,23 +12,22 @@ permissions:
 
 jobs:
   deploy:
-
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v3
-    - name: Set up Python
-      uses: actions/setup-python@v3
-      with:
-        python-version: '3.7'
-    - name: Install dependencies
-      run: |
-        python -m pip install --upgrade pip
-        pip install build
-    - name: Build package
-      run: python -m build
-    - name: Publish package
-      uses: pypa/gh-action-pypi-publish@27b31702a0e7fc50959f5ad993c78deac1bdfc29
-      with:
-        user: __token__
-        password: ${{ secrets.PYPI_API_TOKEN }}
+      - uses: actions/checkout@v3
+      - name: Set up Python
+        uses: actions/setup-python@v3
+        with:
+          python-version: "3.8"
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install build
+      - name: Build package
+        run: python -m build
+      - name: Publish package
+        uses: pypa/gh-action-pypi-publish@27b31702a0e7fc50959f5ad993c78deac1bdfc29
+        with:
+          user: __token__
+          password: ${{ secrets.PYPI_API_TOKEN }}
diff --git a/.github/workflows/test_pytest.yaml b/.github/workflows/test_pytest.yaml
@@ -1,16 +1,16 @@
 name: PyTest
 
-on:  
+on:
   pull_request:
     types: [opened, synchronize, reopened, ready_for_review]
     paths:
-      - '**.py'
+      - "**.py"
 
 jobs:
   fail_if_pull_request_is_draft:
-      if: github.event.pull_request.draft == true
-      runs-on: ubuntu-18.04
-      steps:
+    if: github.event.pull_request.draft == true
+    runs-on: ubuntu-18.04
+    steps:
       - name: Fails in order to indicate that pull request needs to be marked as ready to review and unit tests workflow needs to pass.
         run: exit 1
   run_pytest_and_doctest:
@@ -22,23 +22,28 @@ jobs:
           - macos-latest
           - windows-latest
         python-version:
-          - 3.7
+          - 3.8
           - 3.11
     steps:
-    - uses: actions/checkout@v2
-    - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v2
-      with:
-        python-version: ${{ matrix.python-version }}
-    - name: Install dependencies
-      run: |
-        python -m pip install --upgrade pip
-        pip install -r requirements_test.txt
-    - name: Build RocketPy
-      run: |
-        pip install -e .
-    - name: Test with pytest
-      run: |
-        pytest
-        cd rocketpy
-        pytest --doctest-modules
+      - uses: actions/checkout@v2
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v2
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+      - name: Build RocketPy (without optional dependencies)
+        run: |
+          pip install .
+      - name: Import rocketpy in python and test if it works
+        run: |
+          python -c "import sys, rocketpy; print(f'{rocketpy.__name__} running on Python {sys.version}')"
+      - name: Install optional dependencies
+        run: |
+          pip install -r requirements-tests.txt
+      - name: Test with pytest
+        run: |
+          pytest
+          cd rocketpy
+          pytest --doctest-modules
diff --git a/.gitignore b/.gitignore
@@ -1,8 +1,11 @@
-Byte-compiled / optimized / DLL files
+# Byte-compiled / optimized / DLL files
 __pycache__/
-*.py[co]
+*.py[cod]
 *$py.class
 
+# C extensions
+*.so
+
 # Distribution / packaging
 .Python
 build/
@@ -17,6 +20,7 @@ parts/
 sdist/
 var/
 wheels/
+share/python-wheels/
 *.egg-info/
 .installed.cfg
 *.egg
@@ -42,8 +46,10 @@ htmlcov/
 nosetests.xml
 coverage.xml
 *.cover
+*.py,cover
 .hypothesis/
 .pytest_cache/
+cover/
 
 # Translations
 *.mo
@@ -53,6 +59,7 @@ coverage.xml
 *.log
 local_settings.py
 db.sqlite3
+db.sqlite3-journal
 
 # Flask stuff:
 instance/
@@ -65,6 +72,7 @@ instance/
 docs/_build/
 
 # PyBuilder
+.pybuilder/
 target/
 
 # Jupyter Notebook
@@ -75,10 +83,38 @@ profile_default/
 ipython_config.py
 
 # pyenv
-.python-version
-
-# celery beat schedule file
+#   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
+
+# 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
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.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
 
 # SageMath parsed files
 *.sage.py
@@ -91,6 +127,8 @@ venv/
 ENV/
 env.bak/
 venv.bak/
+.venv*
+venv*
 
 # Spyder project settings
 .spyderproject
@@ -107,22 +145,28 @@ venv.bak/
 .dmypy.json
 dmypy.json
 
-# big weather
-CuritibaRioSaoPauloEnsemble_2018_ERA-5.nc
-CuritibaRioSaoPaulo_2018_ERA-5.nc
-CuritibaRioSaoPaulo_2017_ERA-5.nc
-CuritibaRioSaoPaulo_2016_ERA-5.nc
-CuritibaRioSaoPaulo_2015_ERA-5.nc
-fetchCuritibaRioSaoPaulo.py
-fetchCuritibaRioSaoPauloEnsemble.py
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
 
-# docs
+# Docs
 *.docx
 *.pdf
 
-# VS Code
+# VSCode project settings
 .vscode/
 
-# Tests
-naboI/
+# 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/
 
+# Mac
+.DS_Store
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -13,10 +13,14 @@ build:
 
 # Build documentation in the docs/ directory with Sphinx
 sphinx:
-   configuration: docs/conf.py
+  configuration: docs/conf.py
 
 # Optionally declare the Python requirements required to build your docs
 python:
-   install:
-   - requirements: docs/requirements.txt
-   - requirements: requirements.txt
+  install:
+    - requirements: docs/requirements.txt
+    - requirements: requirements.txt
+    - method: pip
+      path: .
+      extra_requirements:
+        - all