Requires Python 3.9+. Currently, we build and test hexrdgui
exclusively with dependencies from the conda-forge
channel.
To install the latest stable release
conda install -c hexrd -c conda-forge hexrdgui
To install the latest changes on master, do the following. Note that this release may be unstable.
conda install -c hexrd/label/hexrd-prerelease -c hexrd/label/hexrdgui-prerelease -c conda-forge hexrdgui
Binary packages for Windows, Mac and Linux can be found attached to each main release.
For conda installs, launch by typing
hexrdgui
in a shell. Binary installs are native applications that open on double-click.
Requires Python 3.9+. First clone the Git repositories
git clone https://github.com/HEXRD/hexrd.git
git clone https://github.com/HEXRD/hexrdgui.git
For now we need to explicitly install hexrd
, until we push it to PyPI. Not currently recommended!
pip install -e hexrd
pip install -e hexrdgui
First, make sure python3.9+ is installed in your target env. If it is not, run the following command:
conda install -c conda-forge python=3.9
Next install dependencies using the prerelease conda package
conda install -c hexrd/label/hexrdgui-prerelease -c hexrd/label/hexrd-prerelease -c conda-forge hexrdgui
Finally, from the directory containing the hexrd and hexrdgui git repositories, use pip to link into environment for development:
CONDA_BUILD=1 pip install --no-build-isolation --no-deps -U -e hexrd
CONDA_BUILD=1 pip install --no-build-isolation --no-deps -U -e hexrdgui
set CONDA_BUILD=1
pip install --no-build-isolation --no-deps -U -e hexrd
pip install --no-build-isolation --no-deps -U -e hexrdgui
If you are running in Windows PowerShell or other environments where the stdout
and stderr is not appearing in the console you can run the python module directly
python hexrdgui/hexrd/ui/main.py
, you should then see stdout and stderr.
Packages are built for every PR push, merge into master or tag push. They are built using GitHub Actions.
The following packages are upload as artifacts:
HEXRDGUI-Linux-<version>.tar.bz2
- The Linux conda package.HEXRDGUI-MacOSX-<version>.tar.bz2
- The MacOSX conda package.HEXRDGUI-Windows-<version>.tar.bz2
- The Windows conda package.HEXRDGUI-<version>.tar.gz
- The Linux package (tarball).HEXRDGUI-<version>.dmg
- The MacOS package (DMG).HEXRDGUI-<version>.msi
- The Windows package (MSI).HEXRDGUI-<version>.zip
- The Windows package (zip).
Note: That the packages on MacOS and Windows are not signed.
PRs are built using the hexrd-prerelease
label on the HEXRD conda channel
When a PR is merged into master the conda package is uploaded to the HEXRD channel using the hexrdgui-prerelease
label.
When a tag is pushed HEXRDGUI is built using the main
label on HEXRD conda channel and the result package is upload using the main
label.