RKWard on Windows
(0.7.0b) |
|||
(30 intermediate revisions by 3 users not shown) | |||
Line 2: | Line 2: | ||
[[Category:User Documentation]] | [[Category:User Documentation]] | ||
− | == | + | == Installing the official release == |
− | + | ||
− | + | Since version 0.7.0 installation of RKWard on windows should be straight-forward: Simply download and run the [https://download.kde.org/stable/rkward/0.7.0/win32/rkward-0.7.0b-R-3.4.4-KF5-5.43.exe latest installer]. The installer includes RKWard 0.7.0b, R 3.4.4, and all required KF5 frameworks (version 5.43). | |
− | + | ||
− | + | For installing older, KDE4-based versions of RKWard, refer to the instructions an an [https://rkward.kde.org/index.php?title=RKWard_on_Windows&oldid=1474 earlier version of this page]. | |
− | + | == Installing development snapshots == | |
− | + | Development snapshot are available from https://binary-factory.kde.org/job/RKWard_Nightly_mingw64/ . Note that these are built, automatically, and provided without any human testing. Back up your data, before using these. | |
− | + | == Updating R inside the RKWard installation == | |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
To update R, use the R installer. | To update R, use the R installer. | ||
* Often, new releases of R will work with old versions of RKWard, especially, for patch releases (those differing only in the third section of the version number), generally there should not be any problems. However, it is always a good idea to use the latest version of RKWard with the latest version of R. If in any doubt, back up your installation, first. | * Often, new releases of R will work with old versions of RKWard, especially, for patch releases (those differing only in the third section of the version number), generally there should not be any problems. However, it is always a good idea to use the latest version of RKWard with the latest version of R. If in any doubt, back up your installation, first. | ||
− | * You | + | * You will need to install to [Your\RKWard\Installation\]KDE\libs\R . |
− | + | ||
− | + | ||
* Remember to update your R packages after updating R. | * Remember to update your R packages after updating R. | ||
+ | == Known issues and work-arounds == | ||
+ | (Please use the [[Contact|bug trackers]] to report issues. This section is only meant to document some deficiencies, which are encountered relatively frequently.) | ||
+ | |||
+ | * Some versions of the Symantec '''virus scanner''' are known to report false positives for "knotify4.exe" and "keditfiletype.exe", based on heuristic detection. If in any doubt, please contact your virus scanner's vendor. | ||
+ | |||
+ | If you run into issues not listed above, or you can provide further insight on the above issues, please do not hesitage to [[Contact|contact]] us! | ||
== Compiling RKWard from source on Windows == | == Compiling RKWard from source on Windows == | ||
− | + | # Set up "craft" as detailed, here: https://community.kde.org/Guidelines_and_HOWTOs/Build_from_source/Windows . | |
− | + | ||
− | # Set up | + | |
# run | # run | ||
− | + | craft -i rkward | |
− | This should be all you need to fetch rkward and all dependencies (including R). Note that this | + | This should be all you need to fetch rkward and all dependencies (including R). Note that this may take several hours to complete. |
==== Notes ==== | ==== Notes ==== | ||
Line 84: | Line 38: | ||
* Currently this has only been tested with the MinGW(4) compiler. You are encouraged to try compiling using MSVC, but quite likely you will run into some problems. Report those on the [[Contact|mailing list]], and we will take care of them. | * Currently this has only been tested with the MinGW(4) compiler. You are encouraged to try compiling using MSVC, but quite likely you will run into some problems. Report those on the [[Contact|mailing list]], and we will take care of them. | ||
− | * At times, compilation using | + | * At times, compilation using craft will fail. If the build fails on the R or RKWard packages themselves, let us know on the [[Contact|mailing list]]. If the build fails at an earlier stage (qt / kdelibs / kdebase), you may want to ask for help on [kde-windows@kde.org the KDE windows mailing list]. |
− | * | + | * To customize your installation of R or RKWard, edit / refer to the following python files |
+ | ** ''CRAFT\ROOT''\etc\blueprints\locations\craft-blueprints-kde\extragear\rkward\rkward\rkward.py | ||
+ | ** ''CRAFT\ROOT''\etc\blueprints\locations\craft-blueprints-kde\binary\_win\r-base\r-base.py | ||
=== Custom compilation / Packaging ('''not''' recommended for most users) === | === Custom compilation / Packaging ('''not''' recommended for most users) === | ||
− | + | For more information, refer to the [[RKWard_on_Windows/Packaging|developers' notes on packaging RKWard for Windows]]. | |
=== Debugging / further info === | === Debugging / further info === | ||
See http://techbase.kde.org/Development/Tutorials/Debugging/Debugging_on_MS_Windows in the KDE wiki. | See http://techbase.kde.org/Development/Tutorials/Debugging/Debugging_on_MS_Windows in the KDE wiki. |
Latest revision as of 10:02, 17 April 2018
This page has been marked as needing an improvement. This means the page is incomplete, badly structured or otherwise in need of significant improvements. Most importantly, a walkthrough for the installer is needed |
Contents |
[edit] Installing the official release
Since version 0.7.0 installation of RKWard on windows should be straight-forward: Simply download and run the latest installer. The installer includes RKWard 0.7.0b, R 3.4.4, and all required KF5 frameworks (version 5.43).
For installing older, KDE4-based versions of RKWard, refer to the instructions an an earlier version of this page.
[edit] Installing development snapshots
Development snapshot are available from https://binary-factory.kde.org/job/RKWard_Nightly_mingw64/ . Note that these are built, automatically, and provided without any human testing. Back up your data, before using these.
[edit] Updating R inside the RKWard installation
To update R, use the R installer.
- Often, new releases of R will work with old versions of RKWard, especially, for patch releases (those differing only in the third section of the version number), generally there should not be any problems. However, it is always a good idea to use the latest version of RKWard with the latest version of R. If in any doubt, back up your installation, first.
- You will need to install to [Your\RKWard\Installation\]KDE\libs\R .
- Remember to update your R packages after updating R.
[edit] Known issues and work-arounds
(Please use the bug trackers to report issues. This section is only meant to document some deficiencies, which are encountered relatively frequently.)
- Some versions of the Symantec virus scanner are known to report false positives for "knotify4.exe" and "keditfiletype.exe", based on heuristic detection. If in any doubt, please contact your virus scanner's vendor.
If you run into issues not listed above, or you can provide further insight on the above issues, please do not hesitage to contact us!
[edit] Compiling RKWard from source on Windows
- Set up "craft" as detailed, here: https://community.kde.org/Guidelines_and_HOWTOs/Build_from_source/Windows .
- run
craft -i rkward
This should be all you need to fetch rkward and all dependencies (including R). Note that this may take several hours to complete.
[edit] Notes
- Currently this has only been tested with the MinGW(4) compiler. You are encouraged to try compiling using MSVC, but quite likely you will run into some problems. Report those on the mailing list, and we will take care of them.
- At times, compilation using craft will fail. If the build fails on the R or RKWard packages themselves, let us know on the mailing list. If the build fails at an earlier stage (qt / kdelibs / kdebase), you may want to ask for help on [kde-windows@kde.org the KDE windows mailing list].
- To customize your installation of R or RKWard, edit / refer to the following python files
- CRAFT\ROOT\etc\blueprints\locations\craft-blueprints-kde\extragear\rkward\rkward\rkward.py
- CRAFT\ROOT\etc\blueprints\locations\craft-blueprints-kde\binary\_win\r-base\r-base.py
[edit] Custom compilation / Packaging (not recommended for most users)
For more information, refer to the developers' notes on packaging RKWard for Windows.
[edit] Debugging / further info
See http://techbase.kde.org/Development/Tutorials/Debugging/Debugging_on_MS_Windows in the KDE wiki.