Welcome to the NeuroPlatform documentation!#
Introduction#
This documentation will guide through the basics of using FinalSpark’s NeuroPlatform.
The first part focuses on basic usage of the platform : stimulating organoids, fetching data from the platform and reading spikes for closed-loop experiments.
The second part lists several utilities that you may find useful in your experiments, whether for setting up your parameters or empowering your data analysis.
Hint
Every tutorial page can be downloaded as a Jupyter notebook.
Click on the “Download as .ipynb” button at the top right of the page. This will allow you to test the sample code on your provided machine.
Questions and support#
If you have questions or issues, please try to prioritize GitHub or Discord, so discussions can benefit the community.
Please see our publication for further details on our setup in Frontiers in Artificial Intelligence.
You may also contact us directly if you have specific questions or requests, or for support on your experiments.
Contributing#
All NeuroPlatform users are welcome to contribute to this documentation, which is built upon jupyter-book.
Hint
Try the “Repository” button at the top right of the page to access the GitHub repository, open issues or suggest changes to the current page you are reading.
Contributing is as simple as adding your jupyter notebooks with markdown cells and some formatting.
See the official jupyter-book documentation for more information.
If you have any questions, please reach out to us and we will help you deploy your documentation changes.
How to contribute#
If possible, please use the provided pre-commit hook to ensure that the documentation is formatted correctly before committing changes.
Installing pre-commit
Install pre-commit by running the following command:
pip install pre-commit
or use your preferred package manager.
Then, run the following command to install the pre-commit hook:
pre-commit install
Then, create a new branch and open a pull request to request updates to the documentation.