fmi-basel / faim-robocopy

A python-based UI for robocopy
MIT License
3 stars 0 forks source link

FAIM Robocopy

FAIM Robocopy provides a user interface for the windows tool robocopy.

Installation

Using pixi

Provided pixi is installed on the host system, clone this repository into a local directory:

git clone https://github.com/fmi-basel/faim-robocopy

Then start the faim-robocopy task:

cd faim-robocopy
pixi run faim-robocopy

Using conda/mamba/anaconda

Requirements: python, git. We recommend installing Anaconda and will use it in this installation guide.

Open an Anaconda prompt and change to the directory where you want to keep FAIM-Robocopy:

cd PATH/TO/DIR

where you substitutePATH/TO/DIR with a path on your machine.

Then, create a new conda environment and activate it:

conda create -n faim-robocopy python=3.6 git
conda activate faim-robocopy

Next, clone the source code from github:

git clone --recursive https://github.com/fmi-basel/faim-robocopy.git

and install the remaining dependencies

cd faim-robocopy
conda install --yes --file requirements.txt

You can now launch the GUI from the console using:

python FAIM-robocopy.pyw

(Make sure the "faim-robocopy" environment is activated -> conda activate faim-robocopy)

Creating a shortcut

For convenience, we recommend creating a shortcut. To do so, right-click and drag FAIM-robocopy.pyw to the desired location and choose Create shortcuts here. Then, right click the shortcut and select Properties. There, select the Shortcut tab and extend the field Target: as follows:

<CONDA_ENVIRONMENT_PATH>\pythonw.exe <CODE_PATH>\faim-robocopy\FAIM-robocopy.pyw

The first part <CONDA_ENVIRONMENT_PATH>\pythonw.exe needs to be added, while the second part<CODE_PATH>\faim-robocopy\FAIM-robocopy.pyw is the path to the script which will already be there.

In order to determine the correct <CONDA_ENVIRONMENT_PATH>\pythonw.exe, open an anaconda prompt (if not already open) and activate the faim-robocopy environment with conda activate faim-robocopy. Then, type where pythonw: It will show at least two paths. The one of which ends in faim-robocopy\pythonw.exe is the path that should be used in the shortcut.

As an example, the Target: might look like:

C:\anaconda\envs\faim-robocopy\pythonw.exe C:\tools\faim-robocopy\FAIM-robocopy.pyw

If you are on a more recent version of Windows 10, then you will most likely have to use the following Target in the shortcut:

conda run -n faim-robocopy pythonw <CODE_PATH>\faim-robocopy\FAIM-robocopy.pyw

where you will have to replace C:\anaconda52\x64 with the path where you installed anaconda.