The program can be downloaded in standalone format from the releases page. Python and the required packages are included, so that you don't have to follow the "getting started" guide below.
- Python 3.7 or later
- The packages specified by requirements.txt. Running the command
pip install -r requirements.txtin the root folder of the repo will install these. If you have any issues with pip failing to build the packages on Windows, you may find prebuilt versions here.
In the root folder of the repo, run the command python -m frcpredict to launch the software.
Example input parameters can be found in the Example_parameters.json file. Additional examples and configuration file can be found in the Zenodo repoistory 10.5281/zenodo.18144981, related to the article: "A versatile tool to predict and guide RESOLFT images based on photoswitching, labelling, and optical properties", Andreas Bodén, Staffan Al-Kadhimi, Eleonora Uriati, Ilaria Testa and Francesca Pennacchietti.
To build a bundle with a runnable executable and dependencies included, run the PyInstaller command:
pyinstaller frcpredict.spec. PyInstaller can be downloaded from PyPI using
pip install pyinstaller.
See the wiki for more information about how to use the program as well as a developer guide.