This pull request updates the README and introduces a requirements.txt file to make setup easier. Further launch scripts are introduced to make launching consistent.
Node-JS has been dropped as a dependency, as it seems like most jupyter labs plugins no longer require it.
Structural Changes
The Notebook directory is moved into the project folder, but ignored using .gitignore, so that related files are close to each other. (This can be changed and I'm absolutely open for discussion on this point).
Templating
This pull request introduces the use of a templating plugins for jupyter labs. Effectively, the user is provided with a selection of notebooks, which are copied into their current directory, where they may be modified. This should increase usability, as working examples are provided, requiring only minimal changes to perform the measurements.
This should also reduce the severity of loosing a notebook, as it can be easily recreated. Further, this opens up the possibility of treating the actual notebooks as disposable. I think this is most important, as we could now focus on only supporting the template notebooks. Changes to Qkit would only need to be verified with respect to the templates, and only the templates would need to be updated, as the actual measurement notebooks can be easily recreated.
Driver Updates
Due to me not basing this update on master, this also includes the implementation of the RS SGS100A driver.
Updated Documentation and Launch-Scripts
This pull request updates the README and introduces a
requirements.txtfile to make setup easier. Further launch scripts are introduced to make launching consistent.Node-JS has been dropped as a dependency, as it seems like most jupyter labs plugins no longer require it.
Structural Changes
The Notebook directory is moved into the project folder, but ignored using .gitignore, so that related files are close to each other. (This can be changed and I'm absolutely open for discussion on this point).
Templating
This pull request introduces the use of a templating plugins for jupyter labs. Effectively, the user is provided with a selection of notebooks, which are copied into their current directory, where they may be modified. This should increase usability, as working examples are provided, requiring only minimal changes to perform the measurements.
This should also reduce the severity of loosing a notebook, as it can be easily recreated. Further, this opens up the possibility of treating the actual notebooks as disposable. I think this is most important, as we could now focus on only supporting the template notebooks. Changes to Qkit would only need to be verified with respect to the templates, and only the templates would need to be updated, as the actual measurement notebooks can be easily recreated.
Driver Updates
Due to me not basing this update on master, this also includes the implementation of the RS SGS100A driver.