MDAnalysis / membrane-curvature

MDAnalysis tool to calculate membrane curvature.

https://membrane-curvature.readthedocs.io/

GNU General Public License v3.0

29 stars 6 forks source link

Added installation via pip #67

Closed ojeda-e closed 3 years ago

ojeda-e commented 3 years ago

Changes here included fixes #66

While I was here I changed other minor things

[x] Added pip in README.
[x] Fixed installation instructions for MDATests and added link.
[x] Fixed typos in Usage page in docs.

codecov[bot] commented 3 years ago

Codecov Report

Merging #67 (16facf4) into main (e163629) will not change coverage. The diff coverage is n/a.

orbeckst commented 3 years ago

About NF banner: if anyone remembers Nicole's GitHub handle then we could also ping her directly for advice.

ojeda-e commented 3 years ago

Thanks, @orbeckst.

I looked at https://pypi.org/project/membrane-curvature/ and at the top it says "solution_posres" – is this supposed to be an image??

Yes, It's supposed to be this image included in the README. But it doesn't show up properly on PyPi.

I'll add the link to UserGuide for MDAnalysis, that's something I didn't consider before. Thanks.

Edit: TIL: I'll have to use the image's external link to make the image display on PiPy. PiPy won't read the package distribution for the image.

IAlibay commented 3 years ago

I am not 100% sure if this project should display the "powered by NumFOCUS" banner because by itself it's no a NF project

That's a difficult one. Is the core library NF sponsored or is the whole organisation? I think we probably should ping Nicole an email about this for future MDAKits too...

On Wed, 11 Aug 2021 at 22:09, Lily Wang @.***> wrote:

@.**** commented on this pull request.

In README.md https://github.com/MDAnalysis/membrane-curvature/pull/67#discussion_r687193766 :

@@ -25,6 +25,12 @@ With MembraneCurvature you can: Installation

+MembraneCurvature is available via pip: +

I think powered by MDA is probably enough, yeah,

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/MDAnalysis/membrane-curvature/pull/67#discussion_r687193766, or unsubscribe https://github.com/notifications/unsubscribe-auth/AC7CAXM437SG7AITSMWLRWTT4LRJFANCNFSM5B7MCYUA .

ojeda-e commented 3 years ago

@IAlibay is it ok to merge this PR, while we wait for confirmation to add/remove NF badge?

orbeckst commented 3 years ago

I'd remove the badge and merge and then add it back later if it's decided that it's the right thing to do.

orbeckst commented 3 years ago

I just emailed NF with the badge question.

ojeda-e commented 3 years ago

Thanks @orbeckst.