Improvements

.github/workflows/build-and-test.yml

@@ -5,9 +5,9 @@ jobs:
   build:
     runs-on: ${{ matrix.os }}
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v2
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v1
         with:
           python-version: ${{ matrix.python-version }}
       - name: Install dependencies
@@ -19,16 +19,16 @@ jobs:
           flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
           flake8 . --count --ignore=E501,E741,W503,W605 --max-complexity=12 --statistics
       - name: Run Tox
-        run: tox -e 'py${{ matrix.python-version }}'
+        run: tox -e py
     strategy:
       matrix:
         os: [ubuntu-latest, windows-latest, macos-latest]
-        python-version: ['3.7', '3.8', '3.9', '3.10', '3.11']
+        python-version: ['3.7', '3.8', '3.9', '3.10']
 name: build and test
 on:
   pull_request:
     branches:
       - master
   push:
     branches:
-      - master
+      - master

.sourcery.yaml

@@ -0,0 +1,2 @@
+refactor:
+  python_version: '3.7'

README.md

@@ -44,23 +44,3 @@ The documentation is hosted [online](https://simphonyphotonics.readthedocs.io/en
 
 Changelogs can be found in docs/changelog/. There is a changelog file for
 each released version of the software.
-
-## Bibtex citation
-
-```
-@article{DBLP:journals/corr/abs-2009-05146,
-  author    = {Sequoia Ploeg and
-               Hyrum Gunther and
-               Ryan M. Camacho},
-  title     = {Simphony: An open-source photonic integrated circuit simulation framework},
-  journal   = {CoRR},
-  volume    = {abs/2009.05146},
-  year      = {2020},
-  url       = {https://arxiv.org/abs/2009.05146},
-  eprinttype = {arXiv},
-  eprint    = {2009.05146},
-  timestamp = {Thu, 17 Sep 2020 12:49:52 +0200},
-  biburl    = {https://dblp.org/rec/journals/corr/abs-2009-05146.bib},
-  bibsource = {dblp computer science bibliography, https://dblp.org}
-}
-```

docs/source/index.rst

@@ -38,7 +38,6 @@ accessible through the sidebar navigation.
   tutorials/intro
   tutorials/mzi
   tutorials/filters
-  tutorials/layout_aware
 
 .. toctree::
   :hidden:

docs/source/reference/api.rst

@@ -8,11 +8,6 @@ API
   :inherited-members:
   :show-inheritance:
 
-.. automodule:: simphony.die
-  :members:
-  :inherited-members:
-  :show-inheritance:
-
 .. automodule:: simphony.formatters
   :members:
   :inherited-members:

docs/source/tutorials/intro.rst

@@ -133,8 +133,8 @@ order to preserve the original circuit.
 Let's run a simple sweep simulation on the circuit we have
 created: ::
 
-  from simphony.simulators import SweepSimulator
-  simulation = SweepSimulator(1500e-9, 1600e-9)
+  from simphony.simulators import SweepSimulation
+  simulation = SweepSimulation(1500e-9, 1600e-9)
   simulation.multiconnect(component1['input'], component2['pin2'])
   result = simulation.simulate()
 

examples/filters.py

@@ -5,8 +5,8 @@
 #
 # File: filters.py
 
-import matplotlib.gridspec as gridspec
 import matplotlib.pyplot as plt
+import matplotlib.gridspec as gridspec
 
 from simphony.libraries import siepic, sipann
 from simphony.simulators import SweepSimulator

examples/mzi.py

@@ -3,6 +3,7 @@
 # (see simphony/__init__.py for details)
 
 import matplotlib.pyplot as plt
+import numpy as np
 
 from simphony.libraries import siepic
 from simphony.simulation import Detector, Laser, Simulation