Skip to content

Commit 8b16528

Browse files
committed
Update README and changelogs for v0.2.0 release
1 parent dfee074 commit 8b16528

File tree

3 files changed

+41
-8
lines changed

3 files changed

+41
-8
lines changed

README.md

+9-7
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,8 @@ s-parameters with the classes, without so many file i/o and parsing algorithms.
2121
This package is still under development. It initially began as an extension to
2222
[SiEPIC-Tools](https://github.com/lukasc-ubc/SiEPIC-Tools), but was ported here
2323
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),
2526
that integrates Simphony with SiEPIC-Tools and KLayout in order to perform
2627
photonic circuit simulations using a layout-driven design methodology.
2728

@@ -37,7 +38,7 @@ Python 2 (January 1, 2020), no future compatability is planned.
3738
## Documentation
3839

3940
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:
4142

4243
```
4344
make html
@@ -47,9 +48,9 @@ The docs are written in reST. There is a nice syntax guide with guidelines that
4748
we follow in the documentation
4849
[here](https://thomas-cokelaer.info/tutorials/sphinx/rest_syntax.html). The
4950
majority of the documentation is generated from python docstrings written using
50-
NumPy documentation format.
51+
the NumPy documentation format.
5152

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
5354
each released version of the software.
5455

5556
## Tests
@@ -66,7 +67,7 @@ from the toplevel directory.
6667
## Developers
6768

6869
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
7071
ensure that a pip installation of your updated package installs and functions
7172
properly. To test this, try installing your package locally by removing all
7273
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
9495
corresponding release branch (release-MAJOR.MINOR.x). The hierarchy is then
9596
as follows:
9697

97-
- release.* (stable branch)
98+
- release-*.*.x (stable branch)
9899
- master (integration and final testing)
99100
- feature-name (feature development and bug fixes)
100101

101102
Even if you are the lone developer, we follow the methodology [here](https://softwareengineering.stackexchange.com/a/294048).
102103

103104
Be sure to update the version number manually before pushing each new version
104105
to PyPI. Also be sure to amend the changelog. Versions can be pushed to PyPI
105-
using the command:
106+
using the commands:
106107

107108
```
109+
python3 setup.py sdist bdist_wheel
108110
python3 -m twine upload dist/*
109111
```

docs/changelog/0.1.5-changelog.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
## [0.1.5] - 2019-06-2 (Scheduled)
1+
## [0.1.5] - 2019-06-2
22

33
### Added
44
- Waveguide parameters now calculated based off new regression model provided by Easton Potokar.

docs/changelog/0.2.0-changelog.md

+31
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
## [0.2.0] - 2019-08-7
2+
3+
Due to a complete code overhaul, this version is incompatible with previous
4+
versions of Simphony. Typically, when a release is incompatible, the MAJOR
5+
version number is bumped. However, since this software is still in the first
6+
stages of development, bumping the MINOR version symbolizes major changes
7+
until the version 1 is officially released.
8+
9+
### Added
10+
- Since we only need two of the 'connect' algorithms from scikit-rf, they were
11+
brought over into this library to reduce the number of dependencies.
12+
- Added test cases using the pytest framework
13+
- Models are now cached during simulation to avoid repeating calculations
14+
- Logging is now the method of choice for getting info messages from the program
15+
- Simulation runtime is now logged at the INFO level
16+
- Documentation! Built using Sphinx.
17+
18+
### Changed
19+
- Simphony is now segmented into three modules: core, simulation, and DeviceLibrary
20+
- New component implementation methods (simphony.core.base.ComponentModel)
21+
- Rebuilt device library to match new component implementations
22+
- Device library no long reads data files for s-parameters, as they've been
23+
converted and are now stored as .npz files.
24+
- [#5](https://github.com/sequoiap/simphony/pull/5): ENHANCEMENT: Framework
25+
rebuild, allows for easier implementation of custom component models and
26+
libraries.
27+
28+
### Removed
29+
- Dependencies on scikit-rf, jsons, and matplotlib have been removed.
30+
- Netlist export functionality no longer exists since netlists can be
31+
scripted in Python.

0 commit comments

Comments
 (0)