-
Notifications
You must be signed in to change notification settings - Fork 3
Installation and Update
If you have installed PeakPo
before, you may conduct Step 2 below only. Make sure you update paths in peakpo.bat
or peakpo.command
for the new version if you use those to run PeakPo
.
If you have previously installed PeakPo
, you may already have Anaconda or Miniconda set up. In that case, you can skip Steps 1 and 2 and proceed directly to Step 3 for an update. If you need to create a new environment, start from Step 2.
Download and install Anaconda or Miniconda for your operating system from the official website:
🔗 https://www.anaconda.com/distribution/
For macOS users:
- The PyQt version used in this release is supported only on Intel-based Macs.
- If you are using an Apple Silicon Mac (M1/M2/M3), you need to run Terminal in Rosetta mode and install the Intel version of Anaconda/Miniconda.
See instructions in this website:
🔗 Rosetta Installation Guide
-
Open Terminal (macOS/Linux) or PowerShell (Windows), and navigate to a directory where you want to install
PeakPo
. For example:cd ~ mkdir Python cd Python
-
Create a folder for
PeakPo
installation:mkdir PeakPo-7.8.0 cd PeakPo-7.8.0
-
Clone the
PeakPo
repository:git clone https://github.com/SHDShim/PeakPo .
Conda
in the Anaconda distribution provides virtual environment functionality. Learn more here. We will create a virtual environment for PeakPo
.
-
Open Terminal (macOS/Linux) or Anaconda PowerShell (Windows).
-
Navigate to the
PeakPo
environments folder:cd ~/Python/PeakPo-7.8.0/peakpo/environments
-
Create a
conda
environment forPeakPo
(replacepkpo2022fbs
with your preferred name):For macOS:
conda env create --name pkpo2022fbs --file pkpo2022fbs-mac.yml
For Windows:
conda env create --name pkpo2022fbs --file pkpo2022fbs-win.yml
-
Activate the environment:
conda activate pkpo2022fbs
You are now ready to run PeakPo
.
-
Navigate to the
peakpo
folder:cd ~/Python/PeakPo-7.8.0/peakpo
-
Activate the environment and launch
PeakPo
:conda activate pkpo2022fbs python -m peakpo
If you prefer launching PeakPo
by double-clicking an icon:
- Locate the
shortcuts
folder insidePeakPo
. - Edit
peakpo.bat
(Windows) orpeakpo.command
(macOS) to match your environment setup. - Save the file and move it to an easily accessible location, such as your Desktop or Applications folder.
Executables are no longer provided due to technical issues. However, older versions are still available.
Download for your OS from the link below:
🔗 Older Versions
Home
FAQ
Installation and Update
Data types and functions
Plot and sidebars
Toolbars
Base pattern
Waterfall patterns
Background subtraction
Setup
Control gray scale
Azimuthal integration
JCPDSs
JCPDS, control the view
Make a jcpds from cif
Workflow
Tweak
Save Tweak to JCPDS
Get Tweak result
Peak fitting
Unit-cell fitting
Session
Output files
Publication-ready Cake plot
Illustrator-ready PeakPo plot
Install in anaconda
Update
Run PeakPo in python
Update history
Issues and Suggestions
Environments | FBS setup | APS setups
PeakPo with Jupyter