From 9ef5e2a92089c8c28d845e807d7cf34794b462a9 Mon Sep 17 00:00:00 2001 From: Joaquin Matres <4514346+joamatab@users.noreply.github.com> Date: Sun, 3 Dec 2023 08:38:28 -0800 Subject: [PATCH 1/2] add users to report version --- .github/ISSUE_TEMPLATE/bug_report.md | 26 +++++++++++++++++++++++++- README.md | 15 +++++++++++++-- 2 files changed, 38 insertions(+), 3 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 15bacd70..06f386c3 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -13,10 +13,34 @@ What's the bug? **To Reproduce** What's the code to reproduce the behavior? What commands or code did you write to get the error? You can add screenshots to help explain your problem. -Make sure you include the code for others to reproduce your issue. +Make sure you include the all code for others to reproduce your issue. **Expected behavior** What would you like to happen? **Suggested fix** How could we fix the bug? + +**Versions** +What version of gplugins and each gplugin are you using? Notice that we only may be able help you if you are using the latest version. +You can find the version by running: + +```python +from gdsfactory.config import print_version_plugins + +print_version_plugins() +``` + +And update to the latest version of all plugins by running: + +```bash +pip install "gdsfactory[full]" --upgrade +``` + +Or only the specific plugin you are reporting: + +```bash +pip install "gplugins[tidy3d]" --upgrade +``` + +Then copy paste the table so that we know which version of python and plugins you are using. diff --git a/README.md b/README.md index 09f1e15a..38e1edbe 100644 --- a/README.md +++ b/README.md @@ -28,15 +28,26 @@ gdsfactory plugins: You can install most plugins with: +```bash +pip install "gdsfactory[full]" --upgrade ``` + +or + +```bash pip install "gplugins[devsim,femwell,gmsh,schematic,meow,meshwell,ray,sax,tidy3d]" --upgrade ``` -Or install only the plugins you need with for example `pip install gplugins[schematic,femwell,meow,sax,tidy3d]` from the available plugins. +Or install only the plugins you need. For example: + +```bash +pip install gplugins[schematic,femwell,meow,sax,tidy3d]` + +``` ### Non-pip plugins -The following plugins require special installation without pip: +The following plugins require special installation as they can't be installed with `pip`: - For Meep and MPB you need to use `conda` or `mamba` on MacOS, Linux or [Windows WSL (Windows Subsystem for Linux)](https://learn.microsoft.com/en-us/windows/wsl/install) with `conda install pymeep=*=mpi_mpich_* -c conda-forge -y` - For Elmer, refer to [Elmer FEM – Installation](https://www.elmerfem.org/blog/binaries/) for installation or compilation instructions each platform. Gplugins assumes `ElmerSolver`, `ElmerSolver_mpi`, and `ElmerGrid` are available in your PATH environment variable. From a567ea3c6c659cc6fd1dd90c796b83727c3cd106 Mon Sep 17 00:00:00 2001 From: Joaquin Matres <4514346+joamatab@users.noreply.github.com> Date: Sun, 3 Dec 2023 08:42:48 -0800 Subject: [PATCH 2/2] fix kfactory install after bump --- pyproject.toml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pyproject.toml b/pyproject.toml index 27ad5bce..e12707a8 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -68,7 +68,7 @@ gmsh = [ "meshwell>=1.0.0,<1.1.0" ] klayout = [ - "kfactory[git,ipy]>=0.9.4,<0.10", + "kfactory[git,ipy]>=0.9.3,<0.10", "pyvis<=0.3.1" ] meow = [