Create Experiment
Creating a GitHub Account
Make sure you have a GitHub. account. If you don't have one, you can sign up for free at GitHub.
Creating Experiment in Virtual Labs
Follow the instructions in the engineers forum repository to create an experiment in Virtual Labs: Engineers forum.
Creating Experiment in your organization
Create an experiment within your organization by following the steps outlined below.
Using Experiment GitHub Template
Access the experiment template directly by clicking on the provided link: template.
- You will be redirected to the template's page, where you'll find a green button labeled Use this template
- Click on Create a new repository.
Completing Git Template and Creating Repository
Fill up required details.
- Repository name should be experiment name.
- Name format exp-<expName>-<devInstituteName> e.g. exp-geometry-optimization-molecules-iiith
- Description about experiment. (Optional)
- Must select Include all branches.
- Click on Create repository from template
- Steup Secret Token.
Modifying Experiments
Click on the Modify Experiment tab in the navigation bar.
Setup Secret Token
Setting up new secret
- Go to repository page Setting > Secrets and variables > Actions.
- Click on New repository secret.
Creating new Secret
- Enter secret name as `ORG_OWNER_GITHUB_TOKEN`.
- Create Personal Access Token.
- Paste that token into Secret.
- Click on Add secret.
Setting up permissions for workflow
- Go to repository page Setting > Actions > General.
Giving read and write permissions
Select Read and write permissions under Workflow permissions heading ans save it.
Modify Experiment
Virtual Labs CMS
- Experiment Repository Name: Enter the name of the experiment repository under the "virtual-labs-cms" GitHub organization.
- Note: Ensure that you have the correct repository name and that it exists under the virtual-labs-cms organization and have collaborator access to this repository.
Your Organization
- Organization Name: Enter the name of your GitHub organization where the experiment repository resides.
- Experiment Repository Name: Enter the name of the experiment repository within your organization.
Accessing Experiment Editing Page via Authentication
- Fill up required details.
- Submit the above form.
- You will be redirected to an authentication page.
- If you are not already logged in, look for the Login with GitHub option.
- Click on Login with GitHub to authenticate yourself.
- Once authenticated, you will be redirected to the experiment editing page.
Navigation Buttons on Experiment Editing Page
The experiment editing page will always contain two fixed buttons located at the bottom right corner:
- Information Button: To access the help manual or additional information, click on the "i" icon. This button will open the help manual, providing guidance and assistance related to the experiment editing process.
- Deployment Button: To redirect the user to the deployment link for experiment. This will be updated after each change. It may take 1-2 minutes to update site.
- Home Button: To redirect the user to the landing page, click on the "Home" icon. This will take you back to the main page or starting point of the application.