-
Notifications
You must be signed in to change notification settings - Fork 0
Home
Welcome to the nti-wavelet-tools wiki!
This is a toolset that has just recently been moved to GitHub, and welcomes new users and developers. Old SVN repository and issue management site: https://deep.reak.bme.hu/projects/wavelet
Most of the code is in IDL, but we have interfaces to Python modules and are moving into Python. IDL-Python interface requires IDL 8.5 or later and Python 3.6 or later. From version 2.0.0 on, we have a functioning GUI in Python with signal loading and saving capability to and from the IDL sav format, as well. This insures easy communication of signals between the two versions.
We follow the following Git branching policy: http://nvie.com/posts/a-successful-git-branching-model/
Branch old-trunk is an exemption: Here we have many new (and old) features in different stages of development. The redevelopment of these features is foreseen in Python if needed.
It must be noted, that the Python version of the signal processing toolbox is reliant on the local presence of the following repo: https://github.com/fusion-flap/flap thus for full functionality, this repo should be cloned and placed in the Python path, as well:
$$git clone https://github.com/fusion-flap/flap.git
placing the "flap" folder in the Python path (this can be found in Spyder Tools/PYTHONPATH manager/add path/flap_path)
For every contribution to the repository, a dedicated issue & branch should exist. If it does not, create one!
- Create an issue for your contribution (if not yet existent) link for issues
- Create a issue branch for the specific issue (let's call it issue-branch) from the develop-branch (if not yet existent).
We are done for now with the GitHub interface. Finally, we can start to work on our computer:
- Clone the master branch in a proper location (create a work folder for it)
$$git clone https://github.com/fusion-flap/nti-wavelet-tools.git
- Checkout the branch on which you want to work
$$git checkout issue-branch
- Develop your code
- Once you are happy with it or workday is over, and it works (preferably tested!), you shall add, commit, and push your modification to the issue-branch
$$git add your_modified_file.py
$$git commit -m '#IssueNumber short message'
$$git push
- Once the development of the issue is done, it should be merged back to the development branch through a pull request.
- Short description for reviewing pull requests: link
The old project wiki can be found here: https://deep.reak.bme.hu/projects/wavelet/wiki (Warning: All repository-related instructions are now obsolete.)