Skip to content

Commit

Permalink
Merge pull request #263 from gdsfactory/ensure_latest_version
Browse files Browse the repository at this point in the history
ask users to report version and fix kfactory pin
  • Loading branch information
joamatab authored Dec 3, 2023
2 parents 5ae84e2 + a567ea3 commit 2e66608
Show file tree
Hide file tree
Showing 3 changed files with 39 additions and 4 deletions.
26 changes: 25 additions & 1 deletion .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
15 changes: 13 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -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 = [
Expand Down

0 comments on commit 2e66608

Please sign in to comment.