Merge pull request #57 from tomkimpson/tamasgal_comments

Comments from tamasgal
tomkimpson · Oct 4, 2023 · 5473e4c · 5473e4c
2 parents 8adfb85 + 139844d
commit 5473e4c
Show file tree

Hide file tree

Showing 3 changed files with 26 additions and 0 deletions.
diff --git a/Project.toml b/Project.toml
@@ -14,6 +14,17 @@ SciMLSensitivity = "1ed8b502-d754-442c-8d5d-10ac956f44a1"
 Tullio = "bc48ee85-29a4-5162-ae0b-a64e1601d4bc"
 Zygote = "e88e6eb3-aa80-5325-afca-941959d7151f"
 
+[compat]
+Combinatorics = "1"
+DifferentialEquations = "7"
+LaTeXStrings = "^1.3"
+Parameters = "^0.12"
+RecipesBase = "^1.3"
+SciMLSensitivity = "7"
+Tullio = "^0.3"
+Zygote = "^0.6"
+julia = "^1.6"  # according to the CI
+
 [extras]
 Distributions = "31c24e10-a181-5473-b8eb-7969acd0382f"
 Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"

diff --git a/docs/src/contributing.md b/docs/src/contributing.md
@@ -0,0 +1,13 @@
+# Contributing
+
+We welcome any contributions to this package. 
+
+Some recommended areas are:
+
+* Taking the [MPD Equations](MPD.md) beyond second order in the expansion.
+* Extension to general spin supplementary conditions, beyond Tulczyjew-Dixon.
+* Generalisation to arbitrary spacetime metrics, not just Kerr.
+* Calculation of gravitational waveforms using e.g. [numerical kludge](https://arxiv.org/abs/gr-qc/0607007) approach (or other).
+* Extension to hyperbolic systems, e.g. [Li et. al. 2021](https://arxiv.org/abs/2110.03494).
+
+Contributions in other areas are also more than welcome - please just [open a pull request](https://github.com/tomkimpson/RelativisticDynamics.jl/pulls) .
diff --git a/docs/src/index.md b/docs/src/index.md
@@ -47,6 +47,8 @@ For any questions or problems, please feel free to [open an issue](https://githu
 
 Contributions are always welcome - just [open a pull request](https://github.com/tomkimpson/RelativisticDynamics.jl/pulls).
 
+Some recommended areas to start contributing can be found on the [Contributing](contributing.md) page
+
 
 ## Acknowledgements 
 This work solving the MPD equations was originally motivated through interesting discussions with [Kinwah Wu](https://www.ucl.ac.uk/mssl/people/prof-kinwah-wu). The port to a modern, precision-flexible model in Julia was heavily inspired by [Milan Klöwer](https://github.com/milankl). Huge thanks to both.