Update documentation.lymd

[AbdullahKazi500]

Description Update:

Changed the tag to "Tutorial" to reflect the new functionality. Version Information:

Added a tag with "1.0" to indicate the version of the macro. Menu Path:

Updated the tag to kqcircuits_menu.end, ensuring the macro appears under the KQCircuits menu in the toolbar. Python Code for Opening Tutorial:

Replaced the existing Python code with code that opens the tutorial.oas file and applies the tutorial.lyp layer properties file. The code creates a new layout view, loads the .oas file, applies the layer properties, and fits the view to the content. fixes #90

[cla-bot[bot]]

Thank you for your pull request and welcome to our community.

We require contributors to sign our Contributor License Agreement (CLA), and it seems that the following contributors have not yet signed it: @AbdullahKazi500.

In order for us to review and merge your code, please sign the CLA at meetiqm.com.

Once you have signed the CLA, write a comment here and we'll verify. Please note that it may take some time for us to verify it.

[qpavsmi]

Could we actually have the tutorial be a separate macro from the opening the documentation website? So that the dropdown looks something like this?

In other words, we'd prefer if a new macro file is created for the tutorial functionality

[qpavsmi]

Are you able to download the files I attached in issue description ? Could you upload those files in your branch and then replace the path/to/ links in the macro to actual file paths in the repository? I would suggest the file locations to be klayout_package/python/scripts/resources/tutorial.oas and klayout_package/python/scripts/resources/tutorial.lyp

[qpavsmi]

@AbdullahKazi500 As posted here, please fill out the form at the following site: https://www.meetiqm.com/iqm-individual-contributor-license-agreement this is needed before we can merge contributions from people outside of IQM.

[AbdullahKazi500]

@AbdullahKazi500 As posted here, please fill out the form at the following site: https://www.meetiqm.com/iqm-individual-contributor-license-agreement this is needed before we can merge contributions from people outside of IQM.

CLA Signed

[AbdullahKazi500]

Could we actually have the tutorial be a separate macro from the opening the documentation website? So that the dropdown looks something like this?

In other words, we'd prefer if a new macro file is created for the tutorial functionality

Yes making a new macro file in the same patch

[cla-bot[bot]]

Thank you for your pull request and welcome to our community.

We require contributors to sign our Contributor License Agreement (CLA), and it seems that the following contributors have not yet signed it: @AbdullahKazi500.

In order for us to review and merge your code, please sign the CLA at meetiqm.com.

Once you have signed the CLA, write a comment here and we'll verify. Please note that it may take some time for us to verify it.

[AbdullahKazi500]

Thank you for your pull request and welcome to our community.

We require contributors to sign our Contributor License Agreement (CLA), and it seems that the following contributors have not yet signed it: @AbdullahKazi500.

In order for us to review and merge your code, please sign the CLA at meetiqm.com.

Once you have signed the CLA, write a comment here and we'll verify. Please note that it may take some time for us to verify it.

I have signed it weird

[qpavsmi]

I have signed it weird

Don't worry about it :D the bot will keep spamming this. Once I clear this tomorrow morning my time the bot will stop doing that

[AbdullahKazi500]

I have signed it weird

Don't worry about it :D the bot will keep spamming this. Once I clear this tomorrow morning my time the bot will stop doing that

Thanks Pavel while downloading it shows me this error I think it would be good if you are able to add it also I have updated the code with the comments any thing which needs to be done

[qpavsmi]

@cla-bot check

[cla-bot[bot]]

The cla-bot has been summoned, and re-checked this pull request!

[AbdullahKazi500]

• Could you revert the file klayout_package/python/scripts/macros/0system/documentation.lym back to what it was? So that it runs webbrowser.open('https://iqm-finland.github.io/KQCircuits/index.html')
• The tutorial macro filename has parentheses ( for some reason, and is generically named KLayout Macro.lym. Could you name it tutorial.lym and place it under the path klayout_package/python/scripts/macros/0system/tutorial.lym?

Hi Pavel I haven't got my pull request merged to revert the changes I mean the file is still as it is if my PR gets merged it will get changed for this directory ------------------------------------------

klayout_package/python/scripts/macros/0system/documentation.lym

[AbdullahKazi500]

• Could you revert the file klayout_package/python/scripts/macros/0system/documentation.lym back to what it was? So that it runs webbrowser.open('https://iqm-finland.github.io/KQCircuits/index.html')
• The tutorial macro filename has parentheses ( for some reason, and is generically named KLayout Macro.lym. Could you name it tutorial.lym and place it under the path klayout_package/python/scripts/macros/0system/tutorial.lym?

Renamed the file File

[qpavsmi]

Hi Pavel I haven't got my pull request merged to revert the changes I mean the file is still as it is if my PR gets merged it will get changed for this directory ------------------------------------------

klayout_package/python/scripts/macros/0system/documentation.lym

Are you able to move the tutorial.lym file to klayout_package/python/scripts/macros/0system/tutorial.lym directory, so that it is in the same directory as documentation.lym?

To revert documentation.lym you could just copy paste the original content and commit that:

<?xml version="1.0" encoding="utf-8"?>
<klayout-macro>
 <description>Online documentation</description>
 <version/>
 <category>pymacros</category>
 <prolog/>
 <epilog/>
 <doc/>
 <autorun>false</autorun>
 <autorun-early>false</autorun-early>
 <shortcut/>
 <show-in-menu>true</show-in-menu>
 <menu-path>kqcircuits_menu.end</menu-path>
 <interpreter>python</interpreter>
 <dsl-interpreter-name/>
 <text># This code is part of KQCircuits
# Copyright (C) 2021 IQM Finland Oy
#
# This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public
# License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later
# version.
#
# This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied
# warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License along with this program. If not, see
# https://www.gnu.org/licenses/gpl-3.0.html.
#
# The software distribution should follow IQM trademark policy for open-source software
# (meetiqm.com/iqm-open-source-trademark-policy). IQM welcomes contributions to the code.
# Please see our contribution agreements for individuals (meetiqm.com/iqm-individual-contributor-license-agreement)
# and organizations (meetiqm.com/iqm-organization-contributor-license-agreement).

"""Open the KQCircuits online documentation in the default web browser.
"""

import webbrowser
webbrowser.open('https://iqm-finland.github.io/KQCircuits/index.html')
</text>
</klayout-macro>

[AbdullahKazi500]

Hi Pavel I haven't got my pull request merged to revert the changes I mean the file is still as it is if my PR gets merged it will get changed for this directory ------------------------------------------

klayout_package/python/scripts/macros/0system/documentation.lym

Are you able to move the tutorial.lym file to klayout_package/python/scripts/macros/0system/tutorial.lym directory, so that it is in the same directory as documentation.lym?

To revert documentation.lym you could just copy paste the original content and commit that:

<?xml version="1.0" encoding="utf-8"?>
<klayout-macro>
 <description>Online documentation</description>
 <version/>
 <category>pymacros</category>
 <prolog/>
 <epilog/>
 <doc/>
 <autorun>false</autorun>
 <autorun-early>false</autorun-early>
 <shortcut/>
 <show-in-menu>true</show-in-menu>
 <menu-path>kqcircuits_menu.end</menu-path>
 <interpreter>python</interpreter>
 <dsl-interpreter-name/>
 <text># This code is part of KQCircuits
# Copyright (C) 2021 IQM Finland Oy
#
# This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public
# License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later
# version.
#
# This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied
# warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License along with this program. If not, see
# https://www.gnu.org/licenses/gpl-3.0.html.
#
# The software distribution should follow IQM trademark policy for open-source software
# (meetiqm.com/iqm-open-source-trademark-policy). IQM welcomes contributions to the code.
# Please see our contribution agreements for individuals (meetiqm.com/iqm-individual-contributor-license-agreement)
# and organizations (meetiqm.com/iqm-organization-contributor-license-agreement).

"""Open the KQCircuits online documentation in the default web browser.
"""

import webbrowser
webbrowser.open('https://iqm-finland.github.io/KQCircuits/index.html')
</text>
</klayout-macro>

Hi Pavel I am having an error committing to the directory

[AbdullahKazi500]

Hi Pavel I haven't got my pull request merged to revert the changes I mean the file is still as it is if my PR gets merged it will get changed for this directory ------------------------------------------

klayout_package/python/scripts/macros/0system/documentation.lym

Are you able to move the tutorial.lym file to klayout_package/python/scripts/macros/0system/tutorial.lym directory, so that it is in the same directory as documentation.lym?

To revert documentation.lym you could just copy paste the original content and commit that:

<?xml version="1.0" encoding="utf-8"?>
<klayout-macro>
 <description>Online documentation</description>
 <version/>
 <category>pymacros</category>
 <prolog/>
 <epilog/>
 <doc/>
 <autorun>false</autorun>
 <autorun-early>false</autorun-early>
 <shortcut/>
 <show-in-menu>true</show-in-menu>
 <menu-path>kqcircuits_menu.end</menu-path>
 <interpreter>python</interpreter>
 <dsl-interpreter-name/>
 <text># This code is part of KQCircuits
# Copyright (C) 2021 IQM Finland Oy
#
# This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public
# License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later
# version.
#
# This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied
# warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License along with this program. If not, see
# https://www.gnu.org/licenses/gpl-3.0.html.
#
# The software distribution should follow IQM trademark policy for open-source software
# (meetiqm.com/iqm-open-source-trademark-policy). IQM welcomes contributions to the code.
# Please see our contribution agreements for individuals (meetiqm.com/iqm-individual-contributor-license-agreement)
# and organizations (meetiqm.com/iqm-organization-contributor-license-agreement).

"""Open the KQCircuits online documentation in the default web browser.
"""

import webbrowser
webbrowser.open('https://iqm-finland.github.io/KQCircuits/index.html')
</text>
</klayout-macro>

I did this

To revert documentation.lym you could just copy paste the original content and commit that:

[qpavsmi]

I did this

To revert documentation.lym you could just copy paste the original content and commit that:

OK thanks. I'll take care of moving tutorial.py to correct directory and adding the .oas and .lyp files in the next commit. I'll come back to this in a couple of hours to make sure that you'll receive the bounty for this task.

[AbdullahKazi500]

I did this

To revert documentation.lym you could just copy paste the original content and commit that:

OK thanks. I'll take care of moving tutorial.py to correct directory and adding the .oas and .lyp files in the next commit. I'll come back to this in a couple of hours to make sure that you'll receive the bounty for this task.

Thanks Pavel I think you need to close the issue to assign the bounty

[qpavsmi]

Thanks Pavel I think you need to close the issue to assign the bounty

I know I'll do everything needed later this evening