-
Notifications
You must be signed in to change notification settings - Fork 0
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
Update README.md #3
Conversation
Added basic installation instructions.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #3 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 1 1
Lines 8 8
=========================================
Hits 8 8 ☔ View full report in Codecov by Sentry. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This looks good to me, I left one comment regarding conda installing sqlite. All in all though, it looks good.
README.md
Outdated
```console | ||
git clone https://github.com/LSSTDESC/rail_lephare.git | ||
cd rail_lephare | ||
conda install -c conda-forge pytables sqlite |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I just took a swing at this on my work computer (M1 mac) and I only needed to conda install pytables. I didn't have to include sqlite in the conda install.
I don't think it hurts anything to include it, but I'm not sure it's necessary.
Remove unnecessary sqlite install
Yes, you are right. I retried without sqlite and had no problems. I added it to solve an error I was getting with pytest but realised that was also due to the missing pytables originally. I have removed the sqlite install. Longer term is it possible to install pytables automatically using the pyproject.toml requirements or can that not access conda-forge? |
It's a little tricky simply because some of the dependencies are only in PyPI and others are available on both conda-forge and PyPI. I believe that this is a rough edge that RAIL has, and it's not isolated to rail_lephare. So, theoretically anyone who has RAIL installed and working should be more of less familiar with this annoyance. |
Added basic installation instructions. These worked on mac in a fresh conda environment.
Problem & Solution Description (including issue #)
Code Quality
#pragma: no cover
; in the case of a bugfix, a new test that breaks as a result of the bug has been added