-
Notifications
You must be signed in to change notification settings - Fork 21
Getting started with CONTROL‐CORE!
Hi and Welcome to the CONTROL-CORE wiki!
CONTROL-CORE is an Integrated Development Environment (IDE) for closed-loop neuromodulation control systems.
Are you new to CONTROL-CORE? Then you are in the right place. Let's get started. Here we will provide you with some helpful pointers to get started.
CONTROL-CORE is a collection of project repositories, working towards providing a modular IDE for control systems.
At the core is the concore repository. This repository!
concore is the protocol of CONTROL-CORE.
Here, we will learn how to write a concore study from a non-concore program.
Head to our ReadTheDocs and follow through the steps for Installation and use case.
concore-lite is a minimal tutorial repository. It provides a minimal complete example, an ideal place to get a quick understanding of CONTROL-CORE.
concore editor functions as the front end for concore.
Want to try concore-editor? Just open it in Chrome and test it out! Please note that only Chrome is officially supported. If you open concore editor in other browsers, certain functionality may not be readily available.
How to run concore editor to compose and run neuromodulation control systems? Please read the respective documentation here.
Please note the ReadTheDocs documentation source code is configured from here, a fork of the respective documentation repository at controlcore-project.
Want your changes in the ReadTheDocs? Send a pull request to that repository and alert Pradeeban. Once Pradeeban merges your pull request and clicks a button, your documentation will be live in the ReadTheDocs! Please make sure you are comfortable with the rst format before making such pull requests, so that your pull requests will be merged.
Reading the entire ReadTheDocs is a good idea too. However, please note that some of these pages may be actively developed. So, please tolerate any typos, and also feel free to send pull requests to fix those typos.
The Mediator is a cloud-based framework to facilitate inter-organization studies/workflows that span programs over the Internet.
To understand how Mediator is configured and used, you can go to the Mediator repository. The Mediator may go down occasionally (like, once in 4 months). The README has sufficient details on troubleshooting.
However, the exact information about the CONTROL-CORE Mediator deployment is in a private repository. This repository itself may be outdated. But some hard-coded URLs in the README, combined with the Mediator README, will serve as good learning material to finetune and troubleshoot the Mediator.
The CONTROL-CORE website is hosted on AWS, on the same server as the Mediator. However, the Website is largely empty.
Please do not attempt to modify the Mediator deployment, if you are familiar with the technology used. It is used only for the distributed executions over the Internet, and not needed for local executions. This also consists of two Docker instances of Kong and a Docker instances of Cassandra. Make sure to follow the steps carefully and to the point, if you have to restart the Mediator for any reason (most likely, if it has gone down on its own).
The Mediator implementation is probably too complex for its current purpose. It was intended to do much more than what it currently does. Previously we envisioned it to evolve into a server deployment of CONTROL-CORE and provide integrated log in and API keys from OSPARC. We are not considering those features at this point.
concore-studies repository is a place to curate community-contributed studies. For now, it may appear nearly empty. But it has the workflows configured. Please do not try to commit any studies to it manually. The contributions come from the community, using the CONTROL-CORE IDE, using the Contribute Action (by pushing the "Contribute" button in concore editor).
Please note that as of 2023 summer, CONTROL-CORE is a product of largely two research developers' part-time work and six Google Summer of Code contributors. If you find a bug, please create a bug report. Feel free to create a pull request if you have a fix.
Hope you will find CONTROL-CORE a pleasant IDE!