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

Update README.md #3

Merged
merged 2 commits into from
Mar 25, 2024
Merged

Update README.md #3

merged 2 commits into from
Mar 25, 2024

Conversation

raphaelshirley
Copy link
Collaborator

Added basic installation instructions. These worked on mac in a fresh conda environment.

Problem & Solution Description (including issue #)

Code Quality

  • My code follows the code style of this project
  • I have written unit tests or justified all instances of #pragma: no cover; in the case of a bugfix, a new test that breaks as a result of the bug has been added
  • My code contains relevant comments and necessary documentation for future maintainers; the change is reflected in applicable demos/tutorials (with output cleared!) and added/updated docstrings use the NumPy docstring format
  • Any breaking changes, described above, are accompanied by backwards compatibility and deprecation warnings

Added basic installation instructions.
Copy link

codecov bot commented Feb 27, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (474ff67) to head (325d7eb).

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.
📢 Have feedback on the report? Share it here.

Copy link
Collaborator

@drewoldag drewoldag left a 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
Copy link
Collaborator

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
@raphaelshirley
Copy link
Collaborator Author

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?

@drewoldag
Copy link
Collaborator

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.

@raphaelshirley raphaelshirley merged commit e5c47db into main Mar 25, 2024
6 checks passed
@raphaelshirley raphaelshirley deleted the raphaelshirley-patch-1 branch March 25, 2024 20:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants