Skip to content

Commit 5723138

Browse files
Update README.rst
1 parent bb8aaa9 commit 5723138

File tree

1 file changed

+19
-1
lines changed

1 file changed

+19
-1
lines changed

README.rst

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,20 @@ scicode-widgets
33

44
.. marker-package-description
55
6-
*scicode-widgets* is a widget library for the purpose of creating computational experiments for educational content. It is targeted to teach students how to code and interpret computational experiments while abstracting away technical details and boilerplate code that are not essential for the learning experience. The logic is purely written in Python to simplify the development process for scientific researchers as they are typically more comfortable with Python than JavaScript. Built on top of ipywidgets, the library provides a framework for building interactive educational applications.
6+
**scicode-widgets** (pip package name: ``pip install scwidgets``) is a Jupyter widget library.
7+
It is designed to assist in creating "computational experiments" aimed to teach students how to code and interpret computational experiments.
8+
**scicode-widgets** abstracts away technical details and boilerplate code that are not essential for the learning experience.
9+
10+
Built on top of ipywidgets, the library provides a framework for building interactive educational applications.
11+
The logic is purely written in Python, to simplify the development process for scientific teachers and researchers who are more comfortable with Python than with JavaScript.
12+
713

814
Getting started
915
---------------
1016

1117
Please continue with our `getting started page <https://scicode-widgets.readthedocs.io/en/latest/getting_started.html>`_.
1218

19+
1320
Features
1421
--------
1522

@@ -31,3 +38,14 @@ See `how you can integrate scwidgets with the nbgrader framework <https://scicod
3138

3239
* jupyterlab
3340
* notebook < 7
41+
42+
License
43+
-------
44+
45+
`scicode-widgets` are released under the open BSD 3-Clause License.
46+
See the `LICENSE.txt` file for more details.
47+
48+
Acknowledgements
49+
----------------
50+
51+
We acknowledge support from the `NCCR MARVEL <https://www.nccr-marvel.ch/>`_, funded by the Swiss National Science Foundation, and from the EPFL Open Science Fund via the `OSSCAR <https://www.osscar.org>`_ project.

0 commit comments

Comments
 (0)