From 143bfb1f87866f82e9dfda515a678048d1be7688 Mon Sep 17 00:00:00 2001 From: Luke Morris <70283489+lukem12345@users.noreply.github.com> Date: Sat, 17 Feb 2024 18:00:55 -0500 Subject: [PATCH] Update stale docs landing page --- docs/src/index.md | 20 ++++++++++++++++---- 1 file changed, 16 insertions(+), 4 deletions(-) diff --git a/docs/src/index.md b/docs/src/index.md index 4f0280a0..f169f0d6 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -1,9 +1,21 @@ # Decapodes.jl -Decapodes are a graphical tool for the composition of physical systems. -Ultimately, this library will include tooling which takes advantage of the -formalization of physical theories described by DEC provided by -[CombinatorialSpaces.jl](https://algebraicjulia.github.io/CombinatorialSpaces.jl/dev/). +Decapodes.jl is a framework for developing, composing, and simulating physical systems. + +Decapodes.jl is the synthesis of Applied Category Theory (ACT) techniques for formalizing and composing physics equations, and Discrete Exterior Calculus (DEC) techniques for formalizing differential operators. +[CombinatorialSpaces.jl](https://algebraicjulia.github.io/CombinatorialSpaces.jl/dev/) hosts tools for discretizing space and defining DEC operators on simplicial complexes, and [DiagrammaticEquations.jl](https://github.com/AlgebraicJulia/DiagrammaticEquations.jl) hosts tooling for representing the equations as formal ACT diagrams. This repository combines these two packages, compiling diagrams down to simulatable code. + +By combining the power of ACT and the DEC, we seek to improve the scientific computing workflow. Decapodes simulations are [hierarchically composable](https://algebraicjulia.github.io/Decapodes.jl/dev/budyko_sellers_halfar/), generalize over [any type of manifold](https://algebraicjulia.github.io/Decapodes.jl/dev/ice_dynamics/), and are [performant and accurate](https://www.cise.ufl.edu/~luke.morris/cism.html) with a declarative domain specific language (DSL) that is [human-readable](https://algebraicjulia.github.io/Decapodes.jl/dev/klausmeier/#Model-Representation). + +![Grigoriev Ice Cap Dynamics](https://algebraicjulia.github.io/Decapodes.jl/dev/grigoriev.gif) + +# NOTE + +This library is currently under active development, and so is not yet at a +point where a constant API/behavior can be assumed. That being said, if this +project looks interesting/relevant please contact us and +[let us know](https://www.algebraicjulia.org/#contributing)! + # Getting started