Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

License info #187

Merged
merged 54 commits into from
Oct 12, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
54 commits
Select commit Hold shift + click to select a range
b32de4a
Add pushbuttons for versions and license, change checkboxes to push b…
chipmuenk Sep 30, 2020
9dfe188
Rename PushBottons from chk* to but*
chipmuenk Sep 30, 2020
3569e5a
start creating a new module for displaying license and version info
chipmuenk Sep 30, 2020
e6dd236
Create a function instead of a method for the pop-up window and make …
chipmuenk Sep 30, 2020
5c462b1
connect pop-up window with corresponding button
chipmuenk Sep 30, 2020
3195a39
Add "PYQT_VERSION_STR"
chipmuenk Oct 1, 2020
84724c0
Clean up imports
chipmuenk Oct 1, 2020
686f42d
new dict structure for modules and versions
chipmuenk Oct 1, 2020
ad45eb8
Work on licensing information
chipmuenk Oct 1, 2020
79fa74c
add markdown module
chipmuenk Oct 1, 2020
ffd483c
Complete incomplete sentence
chipmuenk Oct 1, 2020
9333dcc
Normalize install dir
chipmuenk Oct 1, 2020
0231c8a
Complete overhaul of routines for displaying modules and their versions
chipmuenk Oct 1, 2020
460fc8b
Catch errors due to undefined variables in the md document
chipmuenk Oct 2, 2020
ba6b4f1
Fix formatting, add some info
chipmuenk Oct 2, 2020
20b7546
remove testing for Matplotlib >= 2.0, this is a requirement now
chipmuenk Oct 3, 2020
94500f8
Update infos
chipmuenk Oct 3, 2020
2080c88
Store module versions in new dict format and adapt all conversion rou…
chipmuenk Oct 3, 2020
f6ddcb4
added new info for software versions
chipmuenk Oct 3, 2020
2be05f8
Clean up button arrangement, debug info is now shown only when DEBUG …
chipmuenk Oct 4, 2020
6b02c7e
Remove trailing blanks
chipmuenk Oct 4, 2020
02f4ff0
Add load filter and save filter buttons
chipmuenk Oct 4, 2020
7b97256
Remove trailing blanks
chipmuenk Oct 4, 2020
12d6fd3
Move special file saving format here
chipmuenk Oct 4, 2020
8881ef7
Move filter save + load functions to io_lib, move buttons to input_spece
chipmuenk Oct 4, 2020
fe09ee6
bump required config file version to 3, remove input_files widget
chipmuenk Oct 5, 2020
13f84f4
config files can be replaced automatically now when their version num…
chipmuenk Oct 5, 2020
20a8e4a
no longer needed, parts moved to input_info and input_select
chipmuenk Oct 5, 2020
b00dd04
Further documentation update
chipmuenk Oct 5, 2020
6b2c8f0
minor corrections
chipmuenk Oct 5, 2020
0ff96cd
Replace QMessage by QDialog which is resizable
chipmuenk Oct 5, 2020
19da4fa
Add GPL license file
chipmuenk Oct 6, 2020
de84ed7
reorganize and improve display of ABOUT and LICENSE info
chipmuenk Oct 6, 2020
ffb5c00
add buttons for licenses
chipmuenk Oct 6, 2020
b5031f6
use new class instead of old function for test setup
chipmuenk Oct 10, 2020
c1fc8d8
use Grid instead of HBox Layout
chipmuenk Oct 10, 2020
bdb411e
Try applying resize policy
chipmuenk Oct 10, 2020
d9c133e
clean up imports
chipmuenk Oct 11, 2020
45c61fd
add testibility of clipboard export
chipmuenk Oct 11, 2020
a21143e
more import cleanups
chipmuenk Oct 11, 2020
3a5e1c5
remove outdated function about_window
chipmuenk Oct 11, 2020
9eb03ce
remove comments
chipmuenk Oct 11, 2020
56d8783
reorder buttons
chipmuenk Oct 11, 2020
e855511
improve information display
chipmuenk Oct 11, 2020
cea2ce9
swap order of methods, clean up
chipmuenk Oct 11, 2020
43215c0
rename LICENSE.txt to LICENSE.md
chipmuenk Oct 11, 2020
f4651de
rename widget, enable external html links
chipmuenk Oct 11, 2020
1cb44fa
enable display of license info
chipmuenk Oct 11, 2020
ae95fc8
update formatting and fix some broken links
chipmuenk Oct 11, 2020
19a397e
Add changelog, replace "close" label by an icon
chipmuenk Oct 11, 2020
e00ae82
update documentation
chipmuenk Oct 11, 2020
0f3e7f0
minor edits
chipmuenk Oct 12, 2020
4a83ae7
Export data as html to clipboard
chipmuenk Oct 12, 2020
41f5277
remove trailing blanks
chipmuenk Oct 12, 2020
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 4 additions & 39 deletions AUTHORS.md
Original file line number Diff line number Diff line change
@@ -1,52 +1,17 @@
Authors
=======
### Authors

[pyFDA][home] is written and maintained by Christian Muenker,
along with the contributors on [github](https://github.com/chipmuenk/pyfda) .

Special thanks:
~~~~~~~~~~~~~~~
#### Special thanks:

- [@endolith](https://github.com/endolith) for his [bandlimited periodic functions](https://gist.github.com/endolith/407991)
- [@endolith](https://github.com/endolith) a.o. or his [bandlimited periodic functions](https://gist.github.com/endolith/407991)
- [sbourdeauducq](https://github.com/sbourdeauducq) for discussions and support on [migen](https://github.com/m-labs/migen)
- [@cfelton](https://github.com/cfelton) for a lot of discussions on fixpoint simulations and [myhdl](http://myhdl.org/)
- [@sriyash25](https://github.com/sriyash25) for his contributions on fixpoint filters during the GSoC 2018


[home]: README_PYPI.md


External modules and libraries
==============================

pyFDA itself is licensed under the permissive MIT license. The source code is
released at the Github repository [chipmuenk/pyfda](https://github.com/chipmuenk/pyfda).

However, when using
binary distribution, several external libraries and icons come bundled with the binary.

Most included software has BSD-style licenses, i.e. MIT or PSF (Python Software Foundation)
with the notable exception of the Qt5 and PyQt libraries.
Please send me message if I've '


| Module | Licence | Purpose |
==============================
| Python | PSF |
| [numpy](https://numpy.org/) | BSD | Base package for fast array numerics|
| [scipy](https://www.scipy.org/) | BSD | | Library for scientific computing |
| [numexpr](https://github.com/pydata/numexpr) | MIT | Fast numerical array expression|
| [matplotlib](https://matplotlib.org/) | PSF-based | Plotting library |
| Qt5 | LPGL | Widget library (UI etc.) |
| PyQt | GPL | Python wrapper for Qt5 |
| docutils | |
| migen | | Fixpoint simulation and synthesis |
| nMigen | | Fixpoint simulation and synthesis |
| mplcursors | | Interactive cursors |
| pyInstaller | GPL 2.0 |Packager for distributing the binary |

https://velovix.github.io/post/lgpl-gpl-license-compliance-with-pyinstaller/

Icons (except the pyFDA icon) are taken from the "Open Iconic" Icons collection
at [https://useiconic.com/open/](https://useiconic.com/open/) under MIT license.

[home]: README_PYPI.md
29 changes: 19 additions & 10 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
# Changelog
## Changelog

## [v0.4.0](https://github.com/chipmuenk/pyfda/tree/v0.3.2) (2020-09-xx)
### [v0.4.0](https://github.com/chipmuenk/pyfda/tree/v0.4.0) (2020-10-xx)

**Bug Fixes**
#### Bug Fixes
- Make compatible to matplotlib 3.3 by cleaning up hierarchy for NavigationToolbar in mpl_widgets.py
[(Issue \#179)](https://github.com/chipmuenk/pyfda/issues/179) and get rid of mpl 3.3 related deprecation warnings. Disable zoom rectangle and pan when zoom is locked.
([Issue \#179](https://github.com/chipmuenk/pyfda/issues/179), [Issue \#44](https://github.com/chipmuenk/pyfda/issues/144))
and get rid of mpl 3.3 related deprecation warnings. Disable zoom rectangle and pan when zoom is locked.

- [PR \#182:](https://github.com/chipmuenk/pull/182) Get rid of deprecation warnings "Creating an ndarray from ragged nested sequences" [(Issue \#180)](https://github.com/chipmuenk/pyfda/issues/180)
- [PR \#182:](https://github.com/chipmuenk/pyfda/pull/182) Get rid of deprecation warnings "Creating an ndarray from ragged nested sequences" [(Issue \#180)](https://github.com/chipmuenk/pyfda/issues/180)
by declaring explicitly np.array(some_ragged_list , dtype=object) or by handling the elements of ragged list indidually
([chipmuenk](https://github.com/chipmuenk))

Expand All @@ -21,19 +22,27 @@

- Enforce correct sign for various input fields

**Enhancements**
#### Enhancements

- Add cursor / annotations in plots [(Issue \#112)](https://github.com/chipmuenk/issues/112) This is only available when [mplcursors](https://mplcursors.readthedocs.io/) module is installed and for matplotlib >= 3.1.
- Include license information for distribution of pyFDA as source code and in bundled form, redesign the whole
about window

- Add cursor / annotations in plots ([Issue \#112](https://github.com/chipmuenk/pyfda/issues/112)) This is only available when
[mplcursors](https://mplcursors.readthedocs.io/) module is installed and for matplotlib >= 3.1.

- [PR \#183:](https://github.com/chipmuenk/pull/183) Replace simpleeval library by numexpr.
This enables the creation of formula based stimuli, closing [Issue \#162](https://github.com/chipmuenk/issues/162)
- [PR \#183:](https://github.com/chipmuenk/pyfda/pull/183) Replace simpleeval library by numexpr.
This enables the creation of formula based stimuli, closing [Issue \#162](https://github.com/chipmuenk/pyfda/issues/162) and
part of [Issue \#44](https://github.com/chipmuenk/pyfda/issues/144).

- Add chirp stimulus in Impulse Response tab.

- The top level module name for generated Verilog netlists (Fixpoint tab) is now derived from the
specified file name. The module name is converted to lower cased and sanitized so that is only
contains alpha-numeric characters and '_'. ([(Issue \#176)](https://github.com/chipmuenk/pyfda/issues/176),
contains alpha-numeric characters and '_'. [(Issue \#176)](https://github.com/chipmuenk/pyfda/issues/176),
"allow different module names for verilog export").

- User and user log config files now can be replaced automatically if the config file version number is wrong
([Issue \#44](https://github.com/chipmuenk/pyfda/issues/144))

- Add CHANGELOG.md (this file)

Expand Down
22 changes: 3 additions & 19 deletions LICENSE.txt → LICENSE.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
pyFDA License Agreement (MIT License)
--------------------------------------
### MIT License

Copyright (c) 2014- The pyFDA Development Team

**Copyright (c) 2013 - 2020** pyFDA Development Team and others (see AUTHORS.md)

Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation
Expand All @@ -25,20 +25,4 @@ FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.


Included software
-----------------

License terms are included in any software used inside pyFDA's source code.


Included images (pyfda/images)
----------------------------------

[1] pyFDA License Agreement (see above)

pyfda/images/icons/pyfda_icon.odt
pyfda/images/icons/pyfda_icon.png
pyfda/images/icons/pyfda_icon.svg



Loading