@@ -21,7 +21,8 @@ s-parameters with the classes, without so many file i/o and parsing algorithms.
21
21
This package is still under development. It initially began as an extension to
22
22
[ SiEPIC-Tools] ( https://github.com/lukasc-ubc/SiEPIC-Tools ) , but was ported here
23
23
once it became large enough to be considered its own stand-alone project. There
24
- is a repository, [ SiEPIC-Simphony] ( https://github.com/sequoiap/SiEPIC-Simphony ) ,
24
+ is a repository forked from lukasc-ubc/SiEPIC-Tools,
25
+ [ SiEPIC-Tools] ( https://github.com/sequoiap/SiEPIC-Tools ) ,
25
26
that integrates Simphony with SiEPIC-Tools and KLayout in order to perform
26
27
photonic circuit simulations using a layout-driven design methodology.
27
28
@@ -37,7 +38,7 @@ Python 2 (January 1, 2020), no future compatability is planned.
37
38
## Documentation
38
39
39
40
Documentation is built on Sphinx. They can be built using the default files by
40
- navigation to the docs directory and running:
41
+ navigating to the docs directory and running:
41
42
42
43
```
43
44
make html
@@ -47,9 +48,9 @@ The docs are written in reST. There is a nice syntax guide with guidelines that
47
48
we follow in the documentation
48
49
[ here] ( https://thomas-cokelaer.info/tutorials/sphinx/rest_syntax.html ) . The
49
50
majority of the documentation is generated from python docstrings written using
50
- NumPy documentation format.
51
+ the NumPy documentation format.
51
52
52
- The changelogs can be found in docs/changelog/. There is a changelog file for
53
+ Changelogs can be found in docs/changelog/. There is a changelog file for
53
54
each released version of the software.
54
55
55
56
## Tests
@@ -66,7 +67,7 @@ from the toplevel directory.
66
67
## Developers
67
68
68
69
This package is available on PyPI and updates are regularly pushed as "minor"
69
- or "micro" versions. Before submitting any pull requests, however, you should
70
+ or "micro" (patch) versions. Before submitting any pull requests, however, you should
70
71
ensure that a pip installation of your updated package installs and functions
71
72
properly. To test this, try installing your package locally by removing all
72
73
installed versions of Simphony (by running ``` pip uninstall simphony ```
@@ -94,16 +95,17 @@ is released on PyPI, the package should have a pull request opened to its
94
95
corresponding release branch (release-MAJOR.MINOR.x). The hierarchy is then
95
96
as follows:
96
97
97
- - release. * (stable branch)
98
+ - release- * . * .x (stable branch)
98
99
- master (integration and final testing)
99
100
- feature-name (feature development and bug fixes)
100
101
101
102
Even if you are the lone developer, we follow the methodology [ here] ( https://softwareengineering.stackexchange.com/a/294048 ) .
102
103
103
104
Be sure to update the version number manually before pushing each new version
104
105
to PyPI. Also be sure to amend the changelog. Versions can be pushed to PyPI
105
- using the command :
106
+ using the commands :
106
107
107
108
```
109
+ python3 setup.py sdist bdist_wheel
108
110
python3 -m twine upload dist/*
109
111
```
0 commit comments