Refactor for COMPAS 2

.github/workflows/build.yml

@@ -9,16 +9,17 @@ on:
       - main
 
 jobs:
-  build:
+  Build:
     if: "!contains(github.event.pull_request.labels.*.name, 'docs-only')"
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        os: [ubuntu-latest, macos-latest, windows-latest]
-        python: ['3.8', '3.9', '3.10']
+        os: [macos-latest, windows-latest, ubuntu-latest]
+        python: ["3.9", "3.10", "3.11", "3.12"]
 
     steps:
-      - uses: compas-dev/compas-actions.build@v3
+      - uses: compas-dev/compas-actions.build@v4
         with:
+          invoke_lint: true
+          invoke_test: true
           python: ${{ matrix.python }}
-          invoke_lint: true

.github/workflows/docs.yml

@@ -5,7 +5,7 @@ on:
     branches:
       - main
     tags:
-      - 'v*'
+      - "v*"
   pull_request:
     branches:
       - main
@@ -14,9 +14,6 @@ jobs:
   docs:
     runs-on: ubuntu-latest
     steps:
-      - uses: compas-dev/compas-actions.docs@v2
+      - uses: compas-dev/compas-actions.docs@v4
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
-          use_conda: true
-          use_virtual_display: true
-          use_latex: true

.github/workflows/pr-checks.yml

@@ -0,0 +1,21 @@
+name: verify-pr-checklist
+on:
+  pull_request:
+    types: [assigned, opened, synchronize, reopened, labeled, unlabeled]
+    branches:
+      - main
+      - master
+
+jobs:
+  build:
+    name: Check Actions
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v1
+      - name: Changelog check
+        uses: Zomzog/[email protected]
+        with:
+          fileName: CHANGELOG.md
+          checkNotification: Simple
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/release.yml

@@ -1,7 +1,7 @@
 on:
   push:
     tags:
-      - 'v*'
+      - "v*"
 
 name: Create Release
 
@@ -10,21 +10,21 @@ jobs:
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        os: [ubuntu-latest, macos-latest, windows-latest]
-        python: ['3.8', '3.9', '3.10']
+        os: [macos-latest, windows-latest, ubuntu-latest]
+        python: ["3.9", "3.10", "3.11", "3.12"]
 
     steps:
-      - uses: compas-dev/compas-actions.build@v3
+      - uses: compas-dev/compas-actions.build@v4
         with:
-          python: ${{ matrix.python }}
           invoke_lint: true
-          check_import: true
+          invoke_test: true
+          python: ${{ matrix.python }}
 
-  publish:
+  Publish:
     needs: build
     runs-on: ubuntu-latest
     steps:
-      - uses: compas-dev/compas-actions.publish@v2
+      - uses: compas-dev/compas-actions.publish@v3
         with:
           pypi_token: ${{ secrets.PYPI }}
           github_token: ${{ secrets.GITHUB_TOKEN }}

docs/api/compas_tno.algorithms.rst

@@ -1,2 +1,65 @@
+********************************************************************************
+compas_tno.algorithms
+********************************************************************************
 
-.. automodule:: compas_tno.algorithms
+.. currentmodule:: compas_tno.algorithms
+
+
+Equilibrium
+===========
+
+.. autosummary::
+    :toctree: generated/
+    :nosignatures:
+
+    equilibrium_fdm
+    vertical_equilibrium_fdm
+    q_from_qid
+    q_from_variables
+    xyz_from_q
+    xyz_from_xopt
+    weights_from_xyz
+    weights_from_xyz_dict
+    compute_reactions
+    equilibrium_residual
+
+
+Independents
+============
+
+.. autosummary::
+    :toctree: generated/
+    :nosignatures:
+
+    find_independents_backward
+    find_independents_forward
+    find_independents_QR
+    find_independents
+    independents_exclude
+    independents_include
+    inds_incl_excl
+    check_independents
+    check_horizontal_loads
+
+
+Smoothing
+=========
+
+.. autosummary::
+    :toctree: generated/
+    :nosignatures:
+
+    constrained_smoothing
+    apply_sag
+
+
+Graphic Statics
+===============
+
+.. autosummary::
+    :toctree: generated/
+    :nosignatures:
+
+    form_update_with_parallelisation
+    force_update_from_form
+    reciprocal_from_form

docs/api/compas_tno.analysis.rst

@@ -1,2 +1,26 @@
+********************************************************************************
+compas_tno.analysis
+********************************************************************************
+
+.. currentmodule:: compas_tno.analysis
+
+Classes
+=======
+
+.. autosummary::
+    :toctree: generated/
+    :nosignatures:
+
+    Analysis
+
+Routines
+========
+
+.. autosummary::
+    :toctree: generated/
+    :nosignatures:
+
+    limit_analysis_GSF
+    thk_minmax_GSF
+    max_n_minmax_GSF
 
-.. automodule:: compas_tno.analysis

docs/api/compas_tno.diagrams.rst

@@ -1,2 +1,52 @@
+********************************************************************************
+compas_tno.diagrams
+********************************************************************************
 
-.. automodule:: compas_tno.diagrams
+.. currentmodule:: compas_tno.diagrams
+
+
+Classes
+=======
+
+.. autosummary::
+    :toctree: generated/
+
+    FormDiagram
+    ForceDiagram
+    FormGraph
+
+
+Rectangular diagrams
+====================
+
+.. autosummary::
+    :toctree: generated/
+
+    create_cross_form
+    create_cross_diagonal
+    create_cross_with_diagonal
+    create_fan_form
+    create_ortho_form
+    create_parametric_form
+
+
+Circular diagrams
+=================
+
+.. autosummary::
+    :toctree: generated/
+
+    create_circular_radial_form
+    create_circular_radial_spaced_form
+    create_circular_spiral_form
+
+
+Linear diagrams
+===============
+
+.. autosummary::
+    :toctree: generated/
+
+    create_arch_form_diagram
+    create_linear_form_diagram
+    create_linear_form_diagram_sp_ep

docs/api/compas_tno.optimisers.rst

@@ -1,2 +1,14 @@
+********************************************************************************
+compas_tno.optimisers
+********************************************************************************
 
-.. automodule:: compas_tno.optimisers
+.. currentmodule:: compas_tno.optimisers
+
+Classes
+=======
+
+.. autosummary::
+    :toctree: generated/
+    :nosignatures:
+
+    Optimiser