JTSDK for Windows¶
Overview¶
JTSDK is a collection of several open source development frameworks ( QT, Python, Tcl/Tk ), GNU Coreutils, isolated development environments ( Windows CMD, MSYS, Cygwin ), utility packages and customized build scripts for the WSJT Project
Efforts have been taken to minimize custom package configurations, allowing the end-user to install / update most of the packages manually if desired. Those that cannot be updated, will have comments to that affect on their respective page. Both on-line and off-line installers will be provided.
Environments¶
There are (4) pimary environments, each suited to a specific purpose. For the most part, the environments are isolated from user installed packages, with the exeption of Windows System32. This helps prevent conflicts between JTSDK applications and any of the same name or type on the systems path.
Environments Table | ||
---|---|---|
Name | Application | Framework |
JTSDK-QT | WSJT-X, WSPR-x and MAP65 | QT |
JTSDK-PY | WSJT and WSPR | Python |
JTSDK-MSYS | GNU Tools and GCC | MSYS |
JTSDK-DOC | Cygwin Tools | Cygwin |
Installation¶
This installation method assumes you have not installed JTSDK previously. Adjust as necessary if reinstalling. Download the following packages, then follow the Install Sequence. below.
Downloads¶
Click the following links to download each of the installers:
Install Sequence¶
It is important to install the packages in the correct order. Simply follow the list below, and accept the defaults in each installer. The entire process takes ~15-20 minutes, depending on system speed.
The installation location for is fixed to C:\JTSDK
it cannot be
changed. This is due to the way Python and QT are installed.
- Install MS-VCredist (2010), follow the prompts
- Install MS-VCredist (2013), follow the prompts
- Unzip, then run the OmniRig Installer, follow the prompts
- JTSDK Main Installer, follow the prompts
- JTSDK Update-1, follow the prompts
- JTSDK Update-2, follow the prompts, provides QT 5.5 and GCC 4.9
- JTSDK Update-3, follow the prompts, adds Ruby and AsciiDoctor
- JTSDK Update-4, Move Build scripts to a stable branch ( Important Upgrade! )
Post Installation¶
After the installation finishes, and before building Hamlib3 or other autotools applications:
- Open JTSDK-MSYS once, close then re-open JTSDK-MSYS.
- Now follow the instructions per your version of Windows
XP / Vista / Win7¶
- Start >> Programs >> JTSDK >> Tools >> JTSDK Maintenance
- Then type..:
update
- Then type..:
upgrade
Win8 / Win10¶
- Launchers should be listed under a location similar to:
- All Apps >> J >> JTSDK >> JTSDK Maintenance
- Then type:
update
- Then type:
upgrade
Basic Compiling¶
You should build / rebuild Hamlib3 often, as it is receives frequent updates. You must also build Hamlib3 “before” building WSJT-X the first time.
Build Hamlib3
- Open JTSDK-MSYS or JTSDK-QT
- Type:
build-hamlib3
WSJTX v1.7.0 Devel Example
- Open JTSDK-QT ( Desktop Icon or Start Menu )
- Type:
build-wsjtx rinstall
WSJT v10.0 Example
- Open JTSDK-PY ( Desktop Icon or Start Menu )
- Type:
build-wsjt install
Build Notes¶
- The install locations will be posted at the bottom of the each sucessful run
- Besure sure to check your build options with:
list-options
Reporting Issues¶
Submitt Issues to: JTSDK Win GitHub
Changelog¶
2.0.5 (2016-03-08)¶
- Fixed typo in build-hamlib3.cmd
- Update version file to v2.0.4-1
- Fix bug related to updating svn using switch
Contributing¶
Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.
Bug reports¶
When reporting a bug please include:
- Your operating system name and version.
- Any details about your local setup that might be helpful in troubleshooting.
- Detailed steps to reproduce the bug.
Documentation improvements¶
JTSDK Win could always use more documentation, whether as part of the official JTSDK Win docs, in docstrings, or even on the web in blog posts, articles, and such.
Feature requests and feedback¶
The best way to send feedback is to file an issue at https://github.com/KI7MT/jtsdk-win/issues.
If you are proposing a feature:
- Explain in detail how it would work.
- Keep the scope as narrow as possible, to make it easier to implement.
- Remember that this is a volunteer-driven project, and that code contributions are welcome :)
Development¶
To set up jtsdk-win for local development:
Fork jtsdk-win (look for the “Fork” button).
Clone your fork locally:
git clone git@github.com:your_name_here/jtsdk-win.git
Create a branch for local development:
git checkout -b name-of-your-bugfix-or-feature
Now you can make your changes locally. ANythign you commit will be on the branch you create for yoru feature or bug fix.
Commit your changes and push your branch to GitHub:
git add . git commit -m "Your detailed description of your changes." git push origin name-of-your-bugfix-or-feature
- Submit a pull request through the GitHub website.
Pull Request Guidelines¶
If you need some code review or feedback while you’re developing the code just make the pull request.
For merging, you should:
- Update documentation when there’s new API, functionality etc.
- Add a note to
CHANGELOG.rst
about the changes. - Add yourself to
AUTHORS.rst
.
Authors¶
Authors can be contacted on the wsjt-devel mailing list or through the WSJT Yahoo Group.
Many authors contribute to the applicaitnos and packages
Name | Informatinn |
---|---|
Project Manager | Joe Taylor, K1JT |
Project Web Site | http://physics.princeton.edu/pulsar/K1JT/ |
Mailing List | wsjt-devel@lists.sourceforge.net |
Source Code | http://sourceforge.net/projects/wsjt/ |
Yahoo Group | https://groups.yahoo.com/neo/groups/wsjtgroup/info |
License¶
Copyright (c) 2014-2016, Greg Beam All rights reserved.
This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with this program. If not, see <http://www.gnu.org/licenses/>.