startup

.github/CODE_OF_CONDUCT.md

@@ -0,0 +1,3 @@
+# Code of Conduct
+
+Don't be a jerk!

.github/CONTRIBUTING.md

@@ -0,0 +1,28 @@
+# Contributing
+
+Contributors can open issues or create pull requests.
+
+## Issues
+
+Contributors can open new issues on the GitHub repository [here](https://github.com/mrbuche/Conspire.jl/issues). An issue can either report an existing bug, or request a new feature. Contributors should ensure that their candidate issue does not match an existing open issue before opening it. If a closely-related but incomplete open issue exists, contributors should comment on the existing open issue.
+
+### Bug Reports
+
+A new bug report can be opened [here](https://github.com/mrbuche/Conspire.jl/issues/new?template=bug_report.md).
+
+### Feature Requests
+
+A new feature request can be opened [here](https://github.com/mrbuche/Conspire.jl/issues/new?template=feature_request.md). Feature requests that are deemed feasible will be considered by the developers, and could even be addressed by a contributor through a pull request. Feature requests that are deemed infeasible will likely be denied.
+
+## Pull Requests
+
+Contributors can propose changes to the code in the repository by creating a pull request as follows:
+
+- Fork the base repository [here](https://github.com/mrbuche/Conspire.jl/fork).
+- Clone the forked repository, make changes, and push them back to the fork.
+- Create a pull request between the base and forked repositories [here](https://github.com/mrbuche/Conspire.jl/pulls).
+- Wait for the pull request to be either approved or dismissed. Approval and subsequent merging of pull requests is contingent upon:
+
+  - The tests are all passing, resulting in a high (desirably, complete) code coverage, and any changes are properly tested.
+  - The documentation is successfully built, and any changes are properly documented.
+  - The changes provide an appropriate and substantial improvement to the repository.

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,38 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Desktop (please complete the following information):**
+ - OS: [e.g. iOS]
+ - Browser [e.g. chrome, safari]
+ - Version [e.g. 22]
+
+**Smartphone (please complete the following information):**
+ - Device: [e.g. iPhone6]
+ - OS: [e.g. iOS8.1]
+ - Browser [e.g. stock browser, safari]
+ - Version [e.g. 22]
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.github/SECURITY.md

@@ -0,0 +1,5 @@
+# Security Policy
+
+## Reporting a Vulnerability
+
+If there are any vulnerabilities, do not hesitate to report them, but please report them privately.

.github/dependabot.yml

@@ -0,0 +1,6 @@
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "daily"

.github/pull_request_template.md

@@ -0,0 +1,15 @@
+# Pull Request Template
+
+This template should be used for making any pull requests.
+
+## Goal
+
+Here, describe the goal of the pull request, i.e. what does it seek to address? Does this pull request fix an existing bug, or create a new feature? Why are the changes proposed by this pull request necessary?
+
+## Specifics
+
+Here, describe the specific changes to the repository suggested by this pull request. Which modules/methods/etc. were added or edited, and why? Have any new dependencies been introduced, and why?
+
+## Verification
+
+Here, describe steps taken to verify that the pull request is up to the standards of the repository. Were the suggested changes fully documented and tested, and do they match the existing code style? How exactly was this verification completed?

.github/workflows/Docs.yml

@@ -0,0 +1,63 @@
+name: Docs
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+  release:
+    types: [ "published" ]
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+concurrency:
+  group: "Docs"
+  cancel-in-progress: true
+jobs:
+  Build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Get last release
+        id: last_release
+        uses: InsonusK/[email protected]
+        with:
+          myToken: ${{ github.token }}
+          view_top: 1
+      - name: Julia
+        uses: julia-actions/setup-julia@v2
+        with:
+          version: '1.9'
+      - name: Dependencies
+        run: julia --color=yes -e 'using Pkg; Pkg.add(["DocStringExtensions", "Documenter"])'
+      - name: Checkout stable
+        uses: actions/checkout@v4
+        with:
+          ref: ${{ steps.last_release.outputs.tag_name }}
+      - name: Stable
+        run: |
+          julia --color=yes -e 'using Pkg; Pkg.develop(path="."); Pkg.build("Conspire")'
+          julia --color=yes docs/make.jl
+          mkdir -p ../_site/stable/
+          cp -r docs/build/* ../_site/stable/
+      - name: Checkout latest
+        uses: actions/checkout@v4
+      - name: Latest
+        run: |
+          julia --color=yes -e 'using Pkg; Pkg.develop(path="."); Pkg.build("Conspire")'
+          julia --color=yes docs/make.jl
+          mkdir -p ../_site/latest/
+          cp -r docs/build/* ../_site/latest/
+      - name: Upload
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: ../_site/
+  Deploy:
+    if: github.event_name != 'pull_request'
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: Build
+    steps:
+      - id: deployment
+        uses: actions/deploy-pages@v4

.github/workflows/TagBot.yml

@@ -0,0 +1,33 @@
+name: TagBot
+on:
+  issue_comment:
+    types:
+      - created
+  workflow_dispatch:
+    inputs:
+      lookback:
+        default: 3
+permissions:
+  actions: read
+  checks: read
+  contents: write
+  deployments: read
+  issues: read
+  discussions: read
+  packages: read
+  pages: read
+  pull-requests: read
+  repository-projects: read
+  security-events: read
+  statuses: read
+jobs:
+  TagBot:
+    if: github.event_name == 'workflow_dispatch' || github.actor == 'JuliaTagBot'
+    runs-on: ubuntu-latest
+    steps:
+      - uses: JuliaRegistries/TagBot@v1
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          # Edit the following line to reflect the actual name of the GitHub Secret containing your private key
+          ssh: ${{ secrets.DOCUMENTER_KEY }}
+          # ssh: ${{ secrets.NAME_OF_MY_SSH_PRIVATE_KEY_SECRET }}

.github/workflows/Test.yml

@@ -0,0 +1,21 @@
+name: Test
+on:
+  pull_request:
+    branches: [ main ]
+jobs:
+  Julia:
+    strategy:
+      fail-fast: false
+      matrix:
+        julia-version: [1.10.0, 1.11.0]
+        os: [macos-latest, ubuntu-latest]
+    runs-on: ${{ matrix.os }}
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Julia
+        uses: julia-actions/setup-julia@v2
+        with:
+          version: ${{ matrix.julia-version }}
+      - name: Test
+        run: julia --color=yes -e 'using Pkg; Pkg.develop(path="."); Pkg.build("Conspire"); Pkg.test("Conspire")'

.gitignore

@@ -0,0 +1,5 @@
+deps/build.log
+deps/conspire_wrapper/Cargo.lock
+deps/conspire_wrapper/target/
+docs/build/
+.vscode

Project.toml

@@ -0,0 +1,29 @@
+name = "Conspire"
+uuid = "e166284d-f01f-4403-abd1-910b06ed061e"
+authors = ["Michael R. Buche <[email protected]>"]
+version = "0.1.0"
+
+[deps]
+DocStringExtensions = "ffbed154-4ef7-542d-bbb7-c09d3a79fcae"
+
+[compat]
+Aqua = "0"
+DocStringExtensions = "0.9"
+Documenter = "1"
+JET = "0"
+JuliaFormatter = "1"
+LinearAlgebra = "1"
+Test = "1"
+julia = "1"
+
+[extras]
+Aqua = "4c88cf16-eb10-579e-8560-4a9242c79595"
+Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
+JET = "c3a54625-cd67-489e-a8e7-0a5a0ff4e31b"
+JuliaFormatter = "98e50ef6-434e-11e9-1051-2b60c6c9e899"
+LinearAlgebra = "37e2e46d-f89d-539d-b4ee-838fcccc9c8e"
+Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
+
+[targets]
+docs = ["Documenter", "DocStringExtensions"]
+test = ["Aqua", "JET", "JuliaFormatter", "LinearAlgebra", "Test"]

deps/build.jl

@@ -0,0 +1,3 @@
+cd("conspire_wrapper")
+run(`cargo clippy --release -- -D warnings`)
+run(`cargo build --release`)

deps/conspire_wrapper/Cargo.toml

@@ -0,0 +1,21 @@
+[package]
+authors = ["Michael R. Buche <[email protected]>"]
+categories = ["mathematics", "science"]
+description = "c o n s p i r e"
+edition = "2021"
+keywords = ["conspire", "mrbuche"]
+license = "GPL-3.0"
+name = "conspire_wrapper"
+version = "0.1.0"
+
+[dependencies]
+conspire = { features = ["constitutive"], git = "https://github.com/mrbuche/conspire.rs.git", rev = "a0ea82466d9e1b6cb4711ef121dde926673dc50f" }
+
+[lib]
+crate-type = ["cdylib"]
+
+[profile.release]
+codegen-units = 1
+lto = true
+panic = "abort"
+strip = "symbols"