Skip to content

Commit

Permalink
updates for new release
Browse files Browse the repository at this point in the history
  • Loading branch information
scottprahl committed Jan 5, 2021
1 parent 96cf03f commit 2a40f12
Show file tree
Hide file tree
Showing 9 changed files with 19 additions and 16 deletions.
6 changes: 6 additions & 0 deletions CHANGELOG.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
Changelog
==========

v0.6.0 (1/5/2021)
------------------
* improve help()
* improve sphinx docs
* new names

v0.5.0 (5/25/2020)
------------------
* sphinx docs
Expand Down
1 change: 1 addition & 0 deletions MANIFEST.in
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ exclude .gitignore
exclude Makefile
exclude docs/*.ipynb
exclude docs/index.rst
exclude docs/ofiber.rst
exclude docs/conf.py
exclude release.txt
exclude todo.rst
6 changes: 4 additions & 2 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -39,12 +39,14 @@ lint:
-pep257 ofiber/graded_index.py
-pylint ofiber/noise.py
-pep257 ofiber/noise.py
-pylint ofiber/parabolic.py
-pep257 ofiber/parabolic.py
-pylint ofiber/planar_parabolic.py
-pep257 ofiber/planar_parabolic.py
-pylint ofiber/planar_step.py
-pep257 ofiber/planar_step.py
-pylint ofiber/refraction.py
-pep257 ofiber/refraction.py
-pylint ofiber/__init__.py
-pep257 ofiber/__init__.py

rcheck:
make clean
Expand Down
4 changes: 2 additions & 2 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,11 @@
# -- Project information -----------------------------------------------------

project = 'ofiber'
copyright = '2018-2020 Scott Prahl'
copyright = '2018-2021 Scott Prahl'
author = 'Scott Prahl'

# The full version, including alpha/beta/rc tags
release = '0.5.0'
release = '0.6.0'

master_doc = 'index'

Expand Down
2 changes: 1 addition & 1 deletion ofiber/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
Info about calculating simple optical fibers parameters::
help(ofiber.basics)
Info about modes and other characteristics of cylindrical fibers::
help(ofiber.cylinder_step)
Expand Down
4 changes: 2 additions & 2 deletions ofiber/planar_step.py
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,9 @@
planes of the waveguide.
The top and bottom layers are semi-infinite with constant index of refraction.
The middle layer has a fixed thickness and a fixed index of refraction. This
The middle layer has a fixed thickness and a fixed index of refraction. This
waveguide is slightly simpler mathematically to solve than the cylindrical
waveguide and serves as a useful preliminary model that exhibits general
waveguide and serves as a useful preliminary model that exhibits general
behaviors found in most waveguides.
The functions fall into two classes, those for transverse electric fields (TE)
Expand Down
6 changes: 0 additions & 6 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,4 @@ envlist = py37
[testenv]
commands =
wfmconvert E info {toxinidir}/wfm/DS1052E.wfm
wfmconvert Z info {toxinidir}/wfm/DS1054Z-A.wfm
wfmconvert 2 info {toxinidir}/wfm/DS2000-A.wfm
wfmconvert 4 info {toxinidir}/wfm/DS4024-A.wfm
wfmconvert E csv {toxinidir}/wfm/DS1102E-A.wfm
wfmconvert E wav {toxinidir}/wfm/DS1102E-A.wfm
"""
4 changes: 2 additions & 2 deletions release.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@
make rcheck

# update the version in setup.py
git commit -m 'update version' setup.py
git commit -m 'update version' setup.cfg docs/conf.py

# update CHANGELOG.txt `git shortlog`
# update CHANGELOG.txt `git shortlog v0.5.0..HEAD`
git commit -m 'update recent changes' CHANGELOG.txt
git push

Expand Down
2 changes: 1 addition & 1 deletion setup.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ universal=1

[metadata]
name=ofiber
version=0.5.0
version=0.6.0
author=Scott Prahl
author_email[email protected]
description=Light Propagation in Optical Fibers
Expand Down

0 comments on commit 2a40f12

Please sign in to comment.