Introduction GUI guide TUI guide

Download & install

1. Go to the libRainbow github webpage: Click here!
   
2. Find the “Open with GitHub Desktop” in the “code” dropdown.
3. Press “Open URL:x-github-client” in the following popup
4. Wait for the download to finish. Thereafter execute the installation program
5. Open the “GitHub desktop” app. Control that your working repository is the libRainbow 5.1 In Case your working repository is not libRainbow 5.2 Press “Sign-in” 5.2 Sign-in with your github account. Recommendation: Use firefox or chrome for the sign-in browser
6. Press “Authorize desktop”
7. Press “Open GitHubDesktop.exe”

8. Congratulation, you are done with the installation. If it does not work, don’t hesitate to contact the maintainer

9. Next: Before uploading your code, you need to create an issue and create a branch. The main branch is not for development.

Create Issue and Branch

1. First open “GitHub Desktop”. Then, Find the “Create issue on GitHub” button from the the “Repository” dropdown
2. Follow the link to the GitHub webpage.
   1. Write title. Describe the problem you are trying to solve in one sentence
   2. Write describtion. Elaborate on what your problem is. State any crucial assumptions.
   3. Assign Assignees
   4. Assign label
   5. Submit issue
3. Remember the issue number. The issue number will be needed for the branch name.
4. Find the “New branch” button in the “Branch” dropdown
5. Create branch page
   1. Name: Use the issue number: “< issue number >b””
   2. Make sure, that you branch from the main branch
   3. Press “Create branch”
6. Press “Publish branch”
7. Select your branch

Upload code

1. We have coded a new simulator that we want to submit to the libRAINBOW repository for this example.
   Therefore we start by navigating to the simulator folder. Then, if you have made another implementation, such as a mathematical module, you place it in the math folder. In the simulation folder, create a new folder with your implementation name. In this case, “new_simulator”.
   
2. Then, in your newly created folder, insert your implementation.
3. Open “GitHub Desktop”. Ensure that all your implementation is visible in “changed file”.
4. Write title use the format: < issue number >: your commit messages. Thereafter, write a short description. Then press “commit”.
5. Press “Push origin”
6. Return to the GitHub webpage. Press “Compare & pull results”
7. Define “pull results”
   1. Assign Reviewers
   2. Assign Assignees
   3. Assign Label
   4. Assign Issue
   5. Before merge -> All revierwers mus approve
   6. Before merge -> All tests must pass
   7. Then press “Squash and merge”
8. Next, adding unittest to your code.

Make Unittest

1. Consider the following module. We have created two functions for testing—a function that works and a function that fails. The “Correct” function “simulator_func” and the “Incorrect” function “simulator_func_error”.
2. First, insert the module in the correct folder. In this case libRAINBOW > python > isl > simulators > new_simulator
3. Then adding test. Navigate to the test folder.
   
4. In the test folder. Create a new folder, use the format: < test_< your name > >. In this case: test_new_simulator
5. Navigate to your newly created folder
6. Create a test file using the format < test_ < your name ». In this case test_new_simulator.
7. In your test file. Copy all the imports and sys.path.. To test your implementation, you need to import it: isl.simulators.< Your implementation folder >.< Simulator name> as sn. In this case:

    isl.simulators.new_simulators.brandNewSimulator as bns
   

   

8. We use the unittest framework, therefore you need to define a test class. First, inherit from the “unittest” module. Then every member function must start with the prefix “test_”. Third, give the self variable as parameter to all member functions. For adding the test.
9. For testing a Numpy array, start by importing the Numpy library. Then import “utils”. Finally, to test if two arrays are equal, use the “array_equal”.
10. Ensure that all your test and implementation is shown in “GitHub Desktop”
11. Make a commit to you branch. Use the same name format as before
12. Press “Push Origin”
13. In case of a test fail, click details.
14. If all test passed and all reviewers approves, you are allowed to merge

Documentation

1. Change to the “gh-pages” branch
2. Navigate to “_documentation_pages” folder
3. Copy paste the .template folder. Rename the copy using the format: < folder name >_< file name >_< function name >.md
4. The template should look like this
5. Type the needed information eg.