diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d9a8033e5b97ec9625d8a68dab7ff4f3d497286b..3be4b6797fbd9f7a271710b306c42edb9d31b31c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -15,7 +15,6 @@ where we have laid out how you can go about making your contribution. You can reach out in the following ways: -* [Discussions](https://github.com/arbor-sim/arbor/discussions). Any questions or remarks regarding using Arbor -for your research are welcome. +* [Discussions](https://github.com/arbor-sim/arbor/discussions). We encourage you to use the discussion board for help with modelling. Any other questions or remarks regarding using Arbor for your research are of course also welcome. * [Gitter](https://gitter.im/arbor-sim/community). If you're interested in developing Arbor itself, get in touch on Gitter. * [Email](mailto:contact@arbor-sim.org). diff --git a/doc/contrib/index.rst b/doc/contrib/index.rst index 62b77007e14460692e74690d4c8bee3f14f0ae27..72c1aca3ae86edd039b03bdab0c51555627f6d8d 100644 --- a/doc/contrib/index.rst +++ b/doc/contrib/index.rst @@ -34,6 +34,17 @@ repository and nearly all of its infrastructure. - Make sure you have a `GitHub account <https://github.com/signup/free>`__. +.. _contribindex-model: + +Model +~~~~~ + +Sharing research and findings that used Arbor is the best contribution you can make to the project. + +- We encourage the use of our Github Discussions board for public discussions on modelling: `Github Discussions <https://github.com/arbor-sim/arbor/discussions>`_. + +- Users can share their models by adding them to the model collection on GitHub at `arbor-contrib <https://github.com/arbor-contrib/>`_. + .. _contribindex-discuss: Start a discussion diff --git a/doc/index.rst b/doc/index.rst index 8ccc3e4950c3c942ab3b3002fce7f0b2c4d760bd..c03fecff123d3c471f5af506754fbe7bd390bdec 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -110,6 +110,12 @@ A full list of our software attributions can be found `here <https://github.com/ concepts/spike_source_cell concepts/benchmark_cell +.. toctree:: + :caption: Modelling: + :maxdepth: 1 + + modelling/index + .. toctree:: :caption: File formats: :maxdepth: 1 diff --git a/doc/modelling/index.rst b/doc/modelling/index.rst new file mode 100644 index 0000000000000000000000000000000000000000..d2f0bdb4ac6541b2f60c15ef12713cda38b102ed --- /dev/null +++ b/doc/modelling/index.rst @@ -0,0 +1,10 @@ +.. _modelling-overview: + +Modelling +========= + +Arbor is feature complete for real world modeling, and the user community is busy collaborating with us to build complex models. Best practices, tips, tricks and howtos will be documented here as the community gains experience. + +In the meantime, we encouraged the use of our Github Discussions board for public discussions on modelling: `Github Discussions <https://github.com/arbor-sim/arbor/discussions>`_. + +Under the `arbor-contrib <https://github.com/arbor-contrib/>`_ organisation, some users have already shared their models. You can peruse these at your leisure, and of course add yours if you like to share! `Please contact us <https://docs.arbor-sim.org/en/stable/contrib/index.html#get-in-touch>`_ to have your model added to our list.