generated from virtual-labs/ph3-exp-template
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Browse files
Browse the repository at this point in the history
…on the link to test your code.
- Loading branch information
0 parents
commit ef259c3
Showing
205 changed files
with
27,265 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,99 @@ | ||
# Steps to Create an Experiment | ||
Welcome to the experiment development process for developers involved in the Virtual Labs project. This guide will help you create an experiment designed to explain the lab topic. | ||
|
||
## Verify and Understand the Experiment Repositories | ||
Begin by thoroughly reviewing and understanding the structure and purpose of the experiment repositories. For more details visit [here](https://vlead.vlabs.ac.in/development/#development-process) | ||
|
||
## Repository Creation | ||
The VLEAD team will create a GitHub repository for each experiment. The write access to these repositories is a must to be able to create, edit or modify the experiment. You can refer to this [example repository](https://github.com/virtual-labs-cms/exp-template) to get familiar with the structure and format. | ||
|
||
## Branch Structure | ||
Each repository will contain four branches: | ||
* **dev** (development) | ||
* **testing** (end-to-end testing) | ||
* **gh-pages** (for GitHub Pages hosting) | ||
* **main** (production-ready) | ||
Developers are required to work exclusively in the dev branch. Once the dev branch has been fully tested, it should be merged into the testing branch. This will automatically deploy the experiment and user interface to GitHub Pages for testing. The link to the deployed page can be found in the 'About' section of the experiment repository. | ||
|
||
## Content for Experiment Development | ||
The content for each experiment should be organized across the designated pages. Please maintain the existing file names and only populate the current files with the content of your experiment. | ||
|
||
1. ### aim.md | ||
This file outlines the broad, general, and long-term intentions for developing the experiment. There can be multiple objectives for teaching an experiment in an online format. Clearly state these intentions to provide a solid understanding of the experiment’s goals. | ||
|
||
2. ### experiment-name.md | ||
The name of the experiment will serve as the title for each page. Ensure the title is precise, simple, and easily understandable for students. A well-chosen name helps learners quickly grasp the focus of the experiment. | ||
|
||
3. ### pretest.json and posttest.json | ||
These files are used to assess learners' understanding via multiple-choice, single-answer quizzes: | ||
|
||
* **Pretest:** To assess prerequisite knowledge before beginning the experiment. | ||
* **Posttest:** To evaluate the understanding gained after completing the experiment. | ||
* **Learning Unit Quizzes:** To test knowledge specific to each section of the content. | ||
Refer to this [example](https://eerc01-iiith.vlabs.ac.in/exp/compression-test-experiment/) for the correct format of pretest and posttest pages. | ||
|
||
The quiz is structured in a JSON file format. The quiz questions must be represented as an array of objects. Each object corresponds to a question. The quiz consists of multiple questions, each defined as an object with the following attributes: | ||
* **question:** The text of the question to be presented to the user. | ||
* **answers:** A set of key-value pairs representing the answer options. The keys (e.g., a, b, c, d) represent the option labels, and the values are the actual answer choices. | ||
* **correctAnswer:** The correct answer, indicated by the corresponding option label (a, b, c, or d). | ||
|
||
Example: | ||
|
||
``` | ||
"questions" : [ | ||
{ | ||
"question" : "What is 1+2 ?", | ||
"answers" : | ||
{ | ||
"a" : 1, | ||
"b" : 2, | ||
"c" : 3, | ||
"d" : 4 | ||
}, | ||
"correctAnswer" : c | ||
} | ||
] | ||
``` | ||
For more details about populating the pretest and posttest json files, please click [here](https://github.com/virtual-labs/ph3-lab-mgmt/blob/dev/docs/quiz.md). | ||
|
||
**Note** | ||
- Please ensure that your JSON files are validated through a JSON validator like https://jsonlint.com/ for smoother debugging. | ||
|
||
4. ### theory.md | ||
This file should contain the theoretical principles or statements that explain the facts or phenomena behind the experiment. Use graphs, tables, images, and other illustrative tools where necessary. You may also incorporate LaTeX for mathematical or scientific notations, as demonstrated in this [example](https://virtual-labs.github.io/exp-adder-circuit-iiith/procedure.html). | ||
|
||
5. ### procedure.md | ||
This file outlines the step-by-step instructions for completing the experiment. You may include graphs, tables, images, and other visual aids to enhance clarity. Refer to this [example](https://virtual-labs.github.io/exp-adder-circuit-iiith/procedure.html) for guidance on formatting and structuring the procedure section. | ||
|
||
6. ### simulation folder | ||
The simulation folder contains the essential files needed to power the experiment's interactive simulation. This is where you upload all the necessary files for the simulation to function correctly. | ||
|
||
Please follow these guidelines: | ||
|
||
**File Structure:** Organize your files into appropriate subfolders such as: | ||
* css – for stylesheets | ||
* js – for JavaScript files | ||
* images – for images used in the simulation | ||
|
||
Ensure that all the file types correspond to the implementation needs of the simulation. | ||
|
||
**index.html requirement:** | ||
For the simulation page to work, the main HTML file must be named index.html. No other names are permitted for the main HTML file for simulation. | ||
|
||
7. ### reference.md | ||
This section lists all sources and references used in the development of the experiment. Properly citing sources provides students with a better understanding of the topic and encourages further reading. | ||
|
||
### Do’s and Don’ts: | ||
**Do’s:** | ||
* Always use the dev branch for development and merge changes into the testing branch after testing. The main branch should only contain thoroughly tested code. | ||
* Follow best practices in the development process, as outlined in [here](https://vlead.vlabs.ac.in/development/#best-practices). | ||
* For the simulation page to work, the main HTML file must be named index.html | ||
|
||
**Don’ts:** | ||
* Avoid adding unnecessary files to the repository. | ||
* Never delete the gh-pages branch, as it is critical for the automatic deployment of the experiment and its user interface to GitHub Pages for testing purposes. | ||
|
||
For more information on the development process, refer to | ||
* [Virtual Labs Onboarding Process](https://vlead.vlabs.ac.in/development/#onboarding-process) | ||
* [Virtual Labs Development Process](https://vlead.vlabs.ac.in/development/#development-process) | ||
* [Virtual Labs Hosting Process](https://vlead.vlabs.ac.in/development/#hosting-process) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
<h2> AIM: To find density, specific gravity and specific weight. </h2> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,30 @@ | ||
=/pretest.json | ||
{ | ||
_: [], | ||
f: [ | ||
'/home/runner/work/exp-density-gravity-weight-iitb/exp-density-gravity-weight-iitb/experiment/pretest.json' | ||
], | ||
files: [ | ||
'/home/runner/work/exp-density-gravity-weight-iitb/exp-density-gravity-weight-iitb/experiment/pretest.json' | ||
], | ||
c: 'assessment', | ||
contentTypes: 'assessment', | ||
'content-types': 'assessment', | ||
'$0': 'validate' | ||
} | ||
Validated true | ||
=/posttest.json | ||
{ | ||
_: [], | ||
f: [ | ||
'/home/runner/work/exp-density-gravity-weight-iitb/exp-density-gravity-weight-iitb/experiment/posttest.json' | ||
], | ||
files: [ | ||
'/home/runner/work/exp-density-gravity-weight-iitb/exp-density-gravity-weight-iitb/experiment/posttest.json' | ||
], | ||
c: 'assessment', | ||
contentTypes: 'assessment', | ||
'content-types': 'assessment', | ||
'$0': 'validate' | ||
} | ||
Validated true |
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,97 @@ | ||
.slidecontainer { | ||
text-align: center; | ||
} | ||
|
||
.slider { | ||
width: 10%; | ||
} | ||
|
||
.text-box { | ||
padding: 7px 20px; | ||
margin: 8px 0; | ||
box-sizing: border-box; | ||
width: 14%; | ||
} | ||
|
||
.legend { list-style: none; } | ||
.legend li { padding-bottom : 1.5vw; width: 20vw; } | ||
.legend span { border: 0.1vw solid black; float: left; border-radius: 50%;} | ||
.legend .grey { background-color: grey; } | ||
.legend .green { background-color: #a4c652; } | ||
.legend .black { background-color: black; } | ||
|
||
.button-input { | ||
border-radius: 50vw; | ||
background-color: #288ec8; | ||
border: none; | ||
color: white; | ||
padding: 1%; | ||
margin-left: 1%; | ||
margin-right: 1%; | ||
padding-bottom: 1%; | ||
padding-top: 1%; | ||
padding-left: 2%; | ||
padding-right: 2%; | ||
} | ||
|
||
.button-input:hover { | ||
background-color:gray; | ||
cursor:pointer; | ||
} | ||
|
||
.comment-box { | ||
position: relative; | ||
padding: 1vw; | ||
width: 30vw; | ||
text-align: center; | ||
} | ||
|
||
.instruction-box { | ||
position: relative; | ||
width: 100%; | ||
transition: width 0.2s ease-out; | ||
border: 0.1vw solid grey; | ||
z-index : 10; | ||
} | ||
|
||
.collapsible { | ||
background-color: Transparent; | ||
color: "grey"; | ||
cursor: pointer; | ||
width: 100%; | ||
border: none; | ||
text-align: center; | ||
outline: none; | ||
font-weight: bold; | ||
padding-top: 1%; | ||
padding-bottom: 1%; | ||
} | ||
|
||
.collapsible::-moz-focus-inner { | ||
border: 0; | ||
} | ||
|
||
.active, .collapsible:hover { | ||
background-color: "white"; | ||
} | ||
|
||
/*The unicode \25BE is for ▾ (Dropdown arrow) */ | ||
.collapsible:after { | ||
content: "\25BE"; | ||
color: "grey"; | ||
font-weight: bold; | ||
float: right; | ||
margin-left: 5px; | ||
} | ||
|
||
.active:after { | ||
content: "\25B4"; | ||
} | ||
|
||
.content { | ||
padding: 0 1.8vw; | ||
max-height: 0; | ||
overflow: hidden; | ||
transition: max-height 0.2s ease-out; | ||
background-color: "white"; | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,104 @@ | ||
.slidecontainer { | ||
text-align: center; | ||
} | ||
|
||
.slider { | ||
width: 10%; | ||
} | ||
|
||
.text-box { | ||
padding: 7px 20px; | ||
margin: 8px 0; | ||
box-sizing: border-box; | ||
width: 14%; | ||
} | ||
|
||
.legend{ | ||
font-size: 1.4vw; | ||
} | ||
.legend { list-style: none; } | ||
.legend li { padding-bottom : 1.5vw; width: 20vw; } | ||
.legend span { border: 0.1vw solid black; float: left; width: 2vw; height: 2vw; margin-right : 0.5vw; border-radius: 50%;} | ||
.legend .grey { background-color: grey; } | ||
.legend .green { background-color: #a4c652; } | ||
.legend .black { background-color: black; } | ||
|
||
.button-input { | ||
border-radius: 50vw; | ||
background-color: #288ec8; | ||
border: none; | ||
color: white; | ||
padding: 1%; | ||
font-size: 1.3vw; | ||
margin-left: 1%; | ||
margin-right: 1%; | ||
padding-bottom: 1%; | ||
padding-top: 1%; | ||
padding-left: 2%; | ||
padding-right: 2%; | ||
} | ||
|
||
.button-input:hover { | ||
background-color:gray; | ||
cursor:pointer; | ||
} | ||
|
||
.comment-box { | ||
position: relative; | ||
padding: 1vw; | ||
width: 30vw; | ||
font-size: 1.5vw; | ||
text-align: center; | ||
} | ||
|
||
.instruction-box { | ||
position: relative; | ||
width: 100%; | ||
transition: width 0.2s ease-out; | ||
border: 0.1vw solid grey; | ||
font-size: 1.5vw; | ||
z-index : 10; | ||
} | ||
|
||
.collapsible { | ||
background-color: Transparent; | ||
color: "grey"; | ||
cursor: pointer; | ||
width: 100%; | ||
border: none; | ||
text-align: center; | ||
outline: none; | ||
font-size: 1.5vw; | ||
font-weight: bold; | ||
padding-top: 1%; | ||
padding-bottom: 1%; | ||
} | ||
|
||
.collapsible::-moz-focus-inner { | ||
border: 0; | ||
} | ||
|
||
.active, .collapsible:hover { | ||
background-color: "white"; | ||
} | ||
|
||
.collapsible:after { | ||
content: '\25BE'; | ||
color: "grey"; | ||
font-weight: bold; | ||
float: right; | ||
margin-left: 5px; | ||
} | ||
|
||
.active:after { | ||
content: "\25B4"; | ||
} | ||
|
||
.content { | ||
padding: 0 1.8vw; | ||
max-height: 0; | ||
overflow: hidden; | ||
transition: max-height 0.2s ease-out; | ||
background-color: "white"; | ||
} | ||
|
Large diffs are not rendered by default.
Oops, something went wrong.
Oops, something went wrong.