Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Point-and-click workflow tutorial outdated #11

Closed
jkotilahti opened this issue May 11, 2022 · 29 comments · Fixed by #17
Closed

Point-and-click workflow tutorial outdated #11

jkotilahti opened this issue May 11, 2022 · 29 comments · Fixed by #17
Labels
documentation Improvements or additions to documentation unitaryhack-bounty

Comments

@jkotilahti
Copy link
Member

With new KLayout and KQCircuits versions some things have changed so that parts of "point-and-click" workflow tutorial don't work as described or are confusing. At least:

  • Part 4.4-5.4: Not easy to select qubit because waveguide cells are selected instead.
    • Alternative way to select a qubit is to drag a selection box around it. Pressing "q" can then be used to open the "object properties" window.
  • Part 6.5: The button is now a magnifying glass instead of "...".
    • Can mention both, so that both older and new KLayout versions can be used
  • Part 7.1: Ground grid is not visible by default, should tell to unhide it in the layers list.

The end result should be such that everything works when following exactly the instructions in the tutorial.

@jkotilahti jkotilahti added documentation Improvements or additions to documentation good first issue Good for newcomers unitaryhack-bounty and removed good first issue Good for newcomers labels May 11, 2022
@fred5825
Copy link

fred5825 commented Jun 8, 2022

@jkotilahti Hi I can try to give this a shot would you be available to talk some more about this?

@jkotilahti
Copy link
Member Author

Hi @fred5825, feel free to ask questions here or https://github.com/iqm-finland/KQCircuits/discussions, or contact me in unitaryfund discord (same username).

@fred5825
Copy link

@jkotilahti Hi thank you I just sent you a discord invite.

@fred5825
Copy link

@jkotilahti please let me know if you have sometime to chat on discord.

@jkotilahti
Copy link
Member Author

Thanks, answered in discord.

@fred5825
Copy link

Hi I was wondering
Screen Shot 2022-06-11 at 12 12 23 AM
which one should I install for this issue

@fred5825
Copy link

Hi I was wondering which one should I install for this issue
Screen Shot 2022-06-11 at 12 12 23 AM

Sorry formatting was wrong with the first one

@fred5825
Copy link

Hi for some reason I am unable to download the software this is the message that I get:
Screen Shot 2022-06-13 at 1 18 27 AM

@jkotilahti
Copy link
Member Author

Hi @fred5825

For installation I suggest using "developer setup" instead of "Salt package".

To run klayout on macOS despite that error message, the following should hopefully work:

image

@fred5825
Copy link

Hi @jkotilahti I am trying to follow part 1.3 but the drag and drop does not work.
Screen Shot 2022-06-14 at 4 55 28 PM

@fred5825
Copy link

I don't know if its because I am on mac but a lot of the things mention are not part of my user interface

@fred5825
Copy link

But I went ahead and already correct the errors specified in the issue.

@jkotilahti
Copy link
Member Author

Hi @fred5825,

I am trying to follow part 1.3 but the drag and drop does not work.

Did you make sure you are running KLayout in "edit mode" as described in part 1.1 of the tutorial? If not, then the drag and drop won't work. If you are running KLayout in edit mode and it still doesn't work, could you describe in more detail what happens when you try to drag-and-drop?

I don't know if its because I am on mac but a lot of the things mention are not part of my user interface

Some of them could be because of changes in new KLayout versions, so it's good if you modify the tutorial to explain also how it works for you :) We can check in the review if they are only because of mac or not.

@fred5825
Copy link

Hi @jkotila I am trying to follow the instructions but I don't see a Set up in file
Screen Shot 2022-06-15 at 7 32 29 PM
hti

@fred5825
Copy link

@jkotilahti sorry about the formatting above but yeah for some reason I don't see the option Setup in file.

@jkotilahti
Copy link
Member Author

jkotilahti commented Jun 16, 2022

Hi @fred5825, it sounds a bit strange that there is no "Setup" in "File" menu (in top menu of KLayout). Maybe you could check also other menus in KLayout top menu and see if you could find the "editing mode" option somewhere. (you could also show me some screenshot of the "File" menu and maybe some other menus in your KLayout, it could help to find it)

But if you can't find this option from the KLayout application, then another way to change it is to find the klayoutrc file. By default this file is in ~/.klayout, but could be somewhere else depending on your setup. Then in this file, change the line <edit-mode>false</edit-mode> into <edit-mode>true</edit-mode>.

@fred5825
Copy link

Screen Shot 2022-06-16 at 2 41 20 PM

@fred5825
Copy link

I found the edit mode its actually in the preferences tab on mac not file, I can change that too in the walkthrough

@fred5825
Copy link

Screen Shot 2022-06-16 at 6 32 05 PM

@fred5825
Copy link

@jkotilahti Hi I don't see partial in tools like part 3.4 says.

@fred5825
Copy link

@jkotilahti never mind I was looking at the wrong thing, sorry

@fred5825
Copy link

Screen Shot 2022-06-16 at 7 09 48 PM

@fred5825
Copy link

@jkotilahti Hi I am at this step its part 6.6 but I don't see the option Swissmon I see other options but not that.

@fred5825
Copy link

@jkotilahti Expect from what I mention above I have done, and ready to create the pull request.

@jkotilahti
Copy link
Member Author

Sounds good @fred5825. The reason why you couldn't find Swissmon is that it was moved from "Element Library" to "Qubit Library". So the part 6.4 should also be changed to have "Qubit Library" instead of "Element Library", then part 6.6 should also work.

@fred5825
Copy link

@jkotilahti it works I will recreate pull request right now.

@jkotilahti
Copy link
Member Author

Great! We will probably review it next week.

@fred5825
Copy link

Hi @jkotilahti the account @Renaud2002 is still me, thats my personal account its where I want to make contributions and the pull request has been opened.

@fred5825
Copy link

@jkotilahti yeah please don't hesitate to let me know if there is any changes I need to add, thank you.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation unitaryhack-bounty
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants