SiPANN 2.0.0

Installation

SiPANN is distributed on PyPI and can be installed with pip:

pip install SiPANN

git clone https://github.com/contagon/SiPANN.git
pip install -e SiPANN/

References

SiPANN is based on a variety of methods found in various papers, including:

[1] A. Hammond, E. Potokar, and R. Camacho, “Accelerating silicon photonic parameter extraction using artificial neural networks,” OSA Continuum 2, 1964-1973 (2019).

Bibtex citation

@misc{SiP-ANN_2019,
        title={SiP-ANN},
        author={Easton Potokar, Alec M. Hammond, Ryan M. Camacho},
        year={2019},
        publisher={GitHub},
        howpublished={{https://github.com/contagon/SiP-ANN}}
}

Releasing

Make sure you have committed a changelog file titled “[major].[minor].[patch]-changelog.md” before bumping version.

To bump version prior to a release, run one of the following commands:

bumpversion major
bumpversion minor
bumpversion patch

This will automatically create a git tag in the repository with the corrresponding version number and commit the modified files (where version numbers were updated). Pushing the tags (a manual process) to the remote will automatically create a new release. Releases are automatically published to PyPI and GitHub when git tags matching the “v*” pattern are created (e.g. “v0.2.1”), as bumpversion does.

To view the tags on the local machine, run git tag. To push the tags to the remote server, you can run git push origin <tagname>.

For code quality, please run isort and black before committing (note that the latest release of isort may not work through VSCode’s integrated terminal, and it’s safest to run it separately through another terminal).