Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add WPG installation instruction #15

Open
JunCEEE opened this issue Apr 7, 2022 · 0 comments
Open

Add WPG installation instruction #15

JunCEEE opened this issue Apr 7, 2022 · 0 comments
Labels
documentation Improvements or additions to documentation must have
Milestone

Comments

@JunCEEE
Copy link
Collaborator

JunCEEE commented Apr 7, 2022

As mentioned in #7 (comment)

An instruction to install WPG is needed.

I'd write somewhere in the documentation:
SimEx-Lite depends on WPG (github.com/Samoyl/WPG). Please download and build WPG as per their documentation. Then, you have to make the WPG library "visible" to SimEx-Lite. To this end, do one of the following:

$PYTHONPATH: If you have the environment variable $PYTHONPATH set, copy the WPG/ directory into any directory listed in $PYTHONPATH.
conda: If you installed SimEx-Lite in a conda environment, activate that environment and copy the WPG/ directory to $CONDA_PREFIX/lib/python3.x/site-packages/ (x is your python minor version).
pip: If you installed SimEx-Lite with pip install, copy the WPG directory into $HOME/.local/lib/python3.x/site-packages
Test that WPG can be imported by running:

$> python -c 'import WPG.Beamline'

@JunCEEE JunCEEE added this to the 1.1.0 milestone Jul 27, 2023
@JunCEEE JunCEEE added documentation Improvements or additions to documentation must have labels Jul 27, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation must have
Projects
None yet
Development

No branches or pull requests

1 participant