NSLS2 / NSLS2/PyXRF

Update source install instructions

Open
#311 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
38
Forks
29
PR merge metrics
No merged PRs in 30d

Description

Recently was installing pyxrf in a clean py39 venv. I followed the instructions on the readthedocs, but still needed to manually add some dependencies.

Expected Behavior

I followed the instructions posted here http://nsls-ii.github.io/PyXRF/installation.html
I started with a new py39 venv. Cloned the repo, installed PyQt, and then pip installed pyxrf. I expected pyxrf to run after that, but I ran into dependency issues

Current Behavior

I needed to manually install some dependencies (scikit-beam and xraylib) in order to get pyxrf to run.

Possible Solution

Can the requirements.txt file be updated to include these dependencies?

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading requirements.txt and the source-install instructions at http://nsls-ii.github.io/PyXRF/installation.html. Check how a clean Python 3.9 virtual environment installs PyXRF, add the missing scikit-beam and xraylib dependencies if appropriate, and verify that PyXRF runs without manual dependency installation.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
build-system
Issue type
Bug
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
58/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.