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 Installation Guide #5416

Merged
merged 1 commit into from Aug 15, 2023
Merged

Update Installation Guide #5416

merged 1 commit into from Aug 15, 2023

Conversation

rcomer
Copy link
Member

@rcomer rcomer commented Aug 5, 2023

πŸš€ Pull Request

Description

The installation guide is now out of date in a couple of places:

  • Since v3.1 we do not provide platform-specific Conda downloads, so I do not think it is necessary to still list those platforms in the guide.
  • Thanks to some outstanding work by @greglucas, Cartopy now has wheels πŸ₯³, so users do not need to install any dependencies separately. I tested the pip command in a new venv on my Ubuntu laptop and it Just Workedβ„’.

I've also changed the language we use to distinguish things.

  • "Users" vs "Developers" - I think we discussed previously somewhere that this distinction is a little ambiguous because users of Iris are going to be developing something. In any case I might have reason to install a development version to do science and I might have reason to install a released version while contributing to Iris, so I prefer to distinguish by the Iris version type.
  • I'm also not sure that "from source" is a helpful distinction for a pure python project. So I went for "from a git checkout" instead.

I took the liberty of adding this to the v3.7.0 project as I think it would be nice to have this in the upcoming release's docs. Obviously boot it out again if you disagree.


Consult Iris pull request check list

@codecov
Copy link

codecov bot commented Aug 5, 2023

Codecov Report

Patch and project coverage have no change.

Comparison is base (becc890) 89.37% compared to head (1b746a7) 89.37%.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #5416   +/-   ##
=======================================
  Coverage   89.37%   89.37%           
=======================================
  Files          89       89           
  Lines       22443    22443           
  Branches     5381     5381           
=======================================
  Hits        20058    20058           
  Misses       1639     1639           
  Partials      746      746           

β˜” View full report in Codecov by Sentry.
πŸ“’ Have feedback on the report? Share it here.

@rcomer
Copy link
Member Author

rcomer commented Aug 5, 2023

Renders like this

Copy link
Member

@pp-mo pp-mo left a comment

Choose a reason for hiding this comment

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

Yes absolutely, I think this is a worthy improvement !!
Thanks @rcomer

@ESadek-MO ESadek-MO removed their request for review August 15, 2023 10:35
@pp-mo
Copy link
Member

pp-mo commented Aug 15, 2023

I'm eager to fix this, but it needs a rebase/merge to resolve conflicts.
Could we possibly get that done today @rcomer ???
I'm hoping to cut an iris3.7.0rc0 shortly

@rcomer
Copy link
Member Author

rcomer commented Aug 15, 2023

OK I rebased, but git didn't tell me I had any conflicts πŸ˜•

@pp-mo
Copy link
Member

pp-mo commented Aug 15, 2023

OK I rebased, but git didn't tell me I had any conflicts πŸ˜•

OK I might have misunderstood. Can't remember what it looked like, now !

It does appear that you need to resolve the conversation you opened - I can't do it.
(To be clear, I agree -- proposal is fine)

@pp-mo pp-mo merged commit 915c1f4 into SciTools:main Aug 15, 2023
17 checks passed
@pp-mo
Copy link
Member

pp-mo commented Aug 15, 2023

Thanks @rcomer, it's in !
Iris 3.7 coming soon, I can feel it ..

@rcomer
Copy link
Member Author

rcomer commented Aug 15, 2023

Thanks @pp-mo!

@rcomer rcomer deleted the doc-install branch August 15, 2023 13:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: 🏁 Done
Development

Successfully merging this pull request may close these issues.

None yet

2 participants