Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Advertise GH Discussions for modelling #1793

Merged
merged 2 commits into from
Jan 5, 2022
Merged

Advertise GH Discussions for modelling #1793

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3deaea1
Advertise GH Discussions for modelling
brenthuisman Dec 21, 2021
37687ce
review
brenthuisman Jan 5, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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).
11 changes: 11 additions & 0 deletions doc/contrib/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 actual science done with Arbor is the best contribution possible!

- 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.

.. _contribindex-discuss:

Start a discussion
Expand Down
6 changes: 6 additions & 0 deletions doc/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
10 changes: 10 additions & 0 deletions doc/modelling/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
.. _modelling-overview:

Modelling
=========

Arbor is a new project, and our first serious users are getting their hands dirty writing the first non-toy models. With time, best practices, tips and tricks and a collection of howtos for common features should become apparent, and will then be shown here.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Is better marketing, and closer to the truth!

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Weeeellllll, feature complete is a very strong claim, but it's better marketing for sure!

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Well, it is not possible to ever be feature complete, because there are always more features that can be added. However Arbor has sufficient features to be used for modern complex models (if not all of them).


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.