Release 0.2

.clang-format

@@ -56,17 +56,25 @@ SpaceAfterCStyleCast: true
 PointerAlignment: Left
 
 # Includes
-IncludeBlocks: Regroup            # Regroup includes based on config
+IncludeBlocks: Regroup  # Regroup includes based on config
 IncludeCategories:
-  - Regex:           '(^"|\.hpp)'  # 'local' includes
-    Priority:        3
-    SortPriority:    0
-    CaseSensitive:   false
-  - Regex:           '\/'         # Library includes
-    Priority:        2
-    SortPriority:    0
-    CaseSensitive:   false
-  - Regex:           '.*'         # Everything else
-    Priority:        1
-    SortPriority:    0
-    CaseSensitive:   false
+  - Regex:          '^"[^/]+\.h"'                   # 'local' includes
+    Priority:       5
+  - Regex:          '^<GridKit\/'                   # Public project includes
+    Priority:       4
+    CaseSensitive:  true
+  - Regex:          '^<(nlohmann|magic_enum)'       # Library includes
+    Priority:       3
+    CaseSensitive:  true
+  - Regex:          '^<(idas|sun|kinsol|nvector)'   # Library includes
+    Priority:       3
+    CaseSensitive:  true
+  - Regex:          '^<(Ip[A-Za-z_]+\.hpp)'         # Ipopt includes
+    Priority:       3
+    CaseSensitive:  true
+  - Regex:          '^<[a-z_]+>'                    # STL includes
+    Priority:       2
+    CaseSensitive:  true
+  - Regex:          '^<[a-z_]+\.h>'                 # C standard headers
+    Priority:       1
+    CaseSensitive:  true

.cmake-format.py

@@ -0,0 +1,76 @@
+# -*- Python -*-
+
+with section("format"):
+
+    # How wide to allow formatted cmake files
+    line_width = 100
+
+    # How many spaces to tab for indent
+    tab_size = 2
+
+    # If true, separate flow control names from their parentheses with a space
+    separate_ctrl_name_with_space = False
+
+    # If true, separate function names from parentheses with a space
+    separate_fn_name_with_space = False
+
+    # If a statement is wrapped to more than one line, then dangle the closing
+    # parenthesis on its own line.
+    dangle_parens = False
+
+    # If a positional argument group contains more than this many arguments, then
+    # force it to a vertical layout.
+    max_pargs_hwrap = 3
+
+    # Force vertical alignment if command takes more than this number of lines
+    max_rows_cmdline = 1
+
+    # List of command names which should always be wrapped
+    always_wrap = ['configure_package_config_file',
+                   'list',
+                   'set_target_properties',
+                   'target_include_directories', 
+                   'target_link_libraries',
+                   'FILES',
+                   'HEADERS',
+                   'INCLUDE_DIRECTORIES',
+                   'LINK_LIBRARIES',
+                   'NAMES',
+                   'PATHS',
+                   'PATH_SUFFIXES',
+                   'SOURCES'
+                   ]
+
+with section("parse"):
+
+    # Formatting for custom macros
+    additional_commands = {
+        "gridkit_add_library": {
+            "pargs": 1,  # Number of initial positional arguments
+            "flags": [],
+            "kwargs": {
+                "SOURCES": "*",
+                "HEADERS": "*",
+                "LINK_LIBRARIES": "*",
+                "INCLUDE_DIRECTORIES": "*",
+                "COMPILE_OPTIONS": "*",
+            }
+        },
+        "enzyme_build_object": {
+            "flags": [],
+            "kwargs": {
+                "NAME": 1,
+                "SOURCES": "*",
+                "LINK_LIBRARIES": "*",
+                "INCLUDE_DIRECTORIES": "*",
+            }
+        }
+    }
+
+with section("markup"):
+
+    # Globally disable comment markup processing
+    enable_markup = False
+
+    # Do not reflow the first comment block in each file
+    first_comment_is_literal = True

.devcontainer/Dockerfile

@@ -0,0 +1,32 @@
+FROM ubuntu:24.04
+
+RUN apt update -y && apt install -y --no-install-recommends\
+	gcc \
+	g++ \
+	gdb \
+	make \
+	cmake \
+	ninja-build \
+	git \
+	ssh \
+	ca-certificates \
+	libopenblas-dev \
+	&& apt clean && rm -rf /var/lib/apt/lists/*
+
+# Install SuiteSparse for klu
+RUN git clone --single-branch --depth 1 --branch v7.10.2 https://github.com/DrTimothyAldenDavis/SuiteSparse.git /tmp/suitesparse && \
+	cd /tmp/suitesparse && \
+	mkdir -p build && cd build && \
+	cmake -G Ninja -DCMAKE_BUILD_TYPE=RelWithDebInfo \
+		-DSUITESPARSE_ENABLE_PROJECTS="klu" .. && \
+	ninja install && \
+	rm -rf /tmp/suitesparse
+
+# Install sundials using klu from previous step
+RUN git clone --single-branch --depth 1 --branch v7.4.0 https://github.com/LLNL/sundials.git /tmp/sundials && \
+	cd /tmp/sundials && \
+	mkdir -p build && cd build && \
+	cmake -G Ninja -DCMAKE_BUILD_TYPE=RelWithDebInfo \
+		-DENABLE_KLU=ON .. && \
+	ninja install && \
+	rm -rf /tmp/sundials

.devcontainer/devcontainer.json

@@ -0,0 +1,12 @@
+{
+	"build": {
+		"dockerfile": "Dockerfile"
+	},
+	"customizations": {
+		"vscode": {
+			"extensions": [
+				"ms-vscode.cpptools"
+			]
+		}
+	}
+}

.editorconfig

@@ -0,0 +1,15 @@
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[{CMakeLists.txt,*.{cpp,hpp,tpp,sh,h,cu,hip,cmake}}]
+indent_style = space
+indent_size = 2
+
+[*.{json,m}]
+indent_style = space
+indent_size = 4

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,58 @@
+name: "\U0001FAB2 Bug report"
+description: "Bug in GridKit™ code"
+title: "Bug: "
+labels: [bug]
+body:
+  - type: textarea
+    id: reproduce
+    attributes:
+      label: "Description how to reproduce the bug"
+      description: "Please provide launch command and the output when you encounter bug."
+      value: |
+        <!-- Include short error output as needed, see example below. -->        
+        ```
+        $ ./gridkit_app
+        ( your output ...)
+        ```
+        <!-- If the error output is long, attach a file or include it in
+             a block that can be closed, see below. -->
+        <details>
+
+        ```
+        $ ./gridkit_app
+        ( your output ...)
+        ```
+
+        </details>
+    validations:
+      required: true
+
+  - type: input
+    id: gridkit-version
+    attributes:
+      label: "GridKit™ version"
+      description: |
+        Please include the version of GridKit™ which demonstrates the problem.
+        If building from source on a non-tagged version, please include the commit hash.
+    validations:
+      required: true
+
+  - type: textarea
+    id: sys-info
+    attributes:
+      label: "System and environment details"
+      description: |
+        Please include details about your system, such as:
+        - Dependencies and their versions  
+        - Operating system  
+        - Compiler(s)  
+        - Hardware backends (CUDA, HIP)  
+    validations:
+      required: true
+
+
+  - type: textarea
+    id: additional_information
+    attributes:
+      label: "Additional information"
+      description: "Upload additional debugging information, such as backtrace."

.github/ISSUE_TEMPLATE/build_error.yml

@@ -0,0 +1,47 @@
+name: "\U0001F4A5 Build error"
+description: "Unable to build GridKit™"
+title: "Build issue: "
+labels: [cmake]
+body:
+  - type: textarea
+    id: reproduce
+    attributes:
+      label: "Build error message(s)"
+      description: "Instructions how to reproduce build failure and the error output."
+      value: |
+        <!-- Include build output (from cmake, make or ninja commands). -->        
+        ```console
+        $ make
+        ( some output ...)
+        ```
+    validations:
+      required: true
+
+  - type: input
+    id: gridkit-version
+    attributes:
+      label: "GridKit™ version"
+      description: |
+        Please include the version of GridKit™ which demonstrates the problem.
+        If building from source on a non-tagged version, please include the commit hash.
+    validations:
+      required: true
+
+  - type: textarea
+    id: information
+    attributes:
+      label: "System and environment details"
+      description: |
+        Please include details about your system, such as:
+        - Dependencies and their versions  
+        - Operating system  
+        - Compiler(s)  
+        - Hardware backends (CUDA, HIP)  
+    validations:
+      required: true
+
+  - type: textarea
+    id: additional_information
+    attributes:
+      label: "Additional information"
+      description: "Upload build logs or provide any additional context about the issue."

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1 @@
+blank_issues_enabled: true

.github/ISSUE_TEMPLATE/feature_request.yml

@@ -0,0 +1,26 @@
+name: "\U0001F38A Feature request"
+description: Suggest adding a feature that is not yet in GridKit™
+labels: [feature]
+body:
+  - type: textarea
+    id: summary
+    attributes:
+      label: Summary
+      description: Please add a concise summary of your suggestion here.
+    validations:
+      required: true
+  - type: textarea
+    id: rationale
+    attributes:
+      label: Rationale
+      description: Is your feature request related to a problem? Please describe it!
+  - type: textarea
+    id: description
+    attributes:
+      label: Description
+      description: Describe the solution you'd like and the alternatives you have considered.
+  - type: textarea
+    id: additional_information
+    attributes:
+      label: Additional information
+      description: Add any other context about the feature request here.

.github/ISSUE_TEMPLATE/test_error.yml

@@ -0,0 +1,50 @@
+name: "\U0001F4A5 Tests error"
+description: "Some GridKit™ tests are failing"
+title: "Testing issue: "
+labels: [testing]
+body:
+  - type: textarea
+    id: reproduce
+    attributes:
+      label: "Failed test outputs or steps to reproduce the failure(s)"
+      description: |
+        Fill in the failing test output, errors,  
+        or steps to reproduce the failure(s).
+      value: |
+        <!-- Include output of `ctest -VV --rerun-failed`. -->        
+        ```console
+        $ ctest -VV --rerun-failed
+        ( failed tests output ...)
+        ```
+    validations:
+      required: true
+
+  - type: input
+    id: gridkit-version
+    attributes:
+      label: "GridKit™ version"
+      description: |
+        Please include the version of GridKit™ which demonstrates the problem.
+        If building from source on a non-tagged version, please include the commit hash.
+    validations:
+      required: true
+
+  - type: textarea
+    id: information
+    attributes:
+      label: "System and environment details"
+      description: |
+        Please include details about your system, such as:
+        - Dependencies and their versions  
+        - Operating system  
+        - Compiler(s)  
+        - Hardware backends (CUDA, HIP)  
+    validations:
+      required: true
+
+
+  - type: textarea
+    id: additional_information
+    attributes:
+      label: "Additional information"
+      description: "Upload test logs or provide any additional context about the issue."