Skip to content
New issue

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

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

Already on GitHub? # to your account

Instructions to install with anaconda navigator #3428

Merged
merged 7 commits into from
Feb 10, 2025

Conversation

camipacifici
Copy link
Contributor

Description

This pull request is to address the lack of instructions to install jdaviz with anaconda navigator.

Change log entry

  • Is a change log needed? If yes, is it added to CHANGES.rst? If you want to avoid merge conflicts,
    list the proposed change log here for review and add to CHANGES.rst before merge. If no, maintainer
    should add a no-changelog-entry-needed label.

Checklist for package maintainer(s)

This checklist is meant to remind the package maintainer(s) who will review this pull request of some common things to look for. This list is not exhaustive.

  • Are two approvals required? Branch protection rule does not check for the second approval. If a second approval is not necessary, please apply the trivial label.
  • Do the proposed changes actually accomplish desired goals? Also manually run the affected example notebooks, if necessary.
  • Do the proposed changes follow the STScI Style Guides?
  • Are tests added/updated as required? If so, do they follow the STScI Style Guides?
  • Are docs added/updated as required? If so, do they follow the STScI Style Guides?
  • Did the CI pass? If not, are the failures related?
  • Is a milestone set? Set this to bugfix milestone if this is a bug fix and needs to be released ASAP; otherwise, set this to the next major release milestone. Bugfix milestone also needs an accompanying backport label.
  • After merge, any internal documentations need updating (e.g., JIRA, Innerspace)?

@github-actions github-actions bot added the documentation Explanation of code and concepts label Feb 4, 2025
@pllim pllim added this to the 4.2 milestone Feb 4, 2025
@pllim pllim added the no-changelog-entry-needed changelog bot directive label Feb 4, 2025
Copy link
Contributor

@pllim pllim left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! The rendered doc is at https://jdaviz--3428.org.readthedocs.build/en/3428/installation.html

I am not familiar with Navigator. Do we have to provide additional info to steer them away from the default channel (license drama, outdated versions)?

@@ -10,8 +10,8 @@ Installation
to the latest version. In general, it is good practice to install the development
version following the instructions below as full released versions may lag behind.

User Installation
-----------------
User Installation with conda
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think putting conda in the title here is a little misleading because this section covers installation in general, conda or not.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good point. I'll revert this. Thanks

Copy link

codecov bot commented Feb 4, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 87.53%. Comparing base (c72d6f2) to head (e38b8ed).
Report is 5 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #3428   +/-   ##
=======================================
  Coverage   87.53%   87.53%           
=======================================
  Files         128      128           
  Lines       19957    19962    +5     
=======================================
+ Hits        17469    17474    +5     
  Misses       2488     2488           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@camipacifici
Copy link
Contributor Author

I am not familiar with Navigator. Do we have to provide additional info to steer them away from the default channel (license drama, outdated versions)?

I am not sure either. As far as I understand, conda-forge is the first channel and default is the second so it should use conda-forge whenever possible. I do not know if there are other implications.

Copy link
Contributor

@pllim pllim left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the clear instructions with screenshots!

I double checked with conda build expert. Indeed, it is not possible to ask conda recipe to pip install, so our dependencies and their dependencies need to be all on conda-forge for jdaviz to be useful on conda-forge. FYI.

@camipacifici
Copy link
Contributor Author

Thank you for checking!

@pllim pllim added the trivial Only needs one approval instead of two label Feb 10, 2025
@pllim pllim enabled auto-merge (squash) February 10, 2025 15:35
@pllim pllim merged commit 2ed942d into spacetelescope:main Feb 10, 2025
18 of 19 checks passed
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
documentation Explanation of code and concepts no-changelog-entry-needed changelog bot directive trivial Only needs one approval instead of two
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants