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

Addition MDonatello to MDAKits #160

Merged
merged 4 commits into from
Oct 18, 2024
Merged

Conversation

talagayev
Copy link
Member

Addition of MDonatello to MDAKits:

@talagayev
Copy link
Member Author

The package would be ready to be reviewed :)
Currently the Package is sitting in my own Github repository without any Organizations or Communities connected to it, but it was part of GSOC 2024 with the project being:

https://summerofcode.withgoogle.com/programs/2024/projects/sfy3kuqc

So I am not sure if it should stay there. @richardjgowers, @yuxuanzhuang what are your opinons, should it be moved somewhere?

@orbeckst orbeckst added the new create a new MDAKit label Aug 28, 2024
@orbeckst
Copy link
Member

@richardjgowers @yuxuanzhuang have you discussed with @talagayev where the package should live? If it were to be moved then it would be nice to do that before registering the kit, and so avoid having to re-review.

@richardjgowers
Copy link
Member

@orbeckst We've not discussed but to me it makes sense for @talagayev to keep ownership of the repo

@IAlibay
Copy link
Member

IAlibay commented Aug 29, 2024

Whilst not explicitly against the GSoC rules, I will point out that the mentors guide does discourage the use of private repositories for GSoC projects: https://google.github.io/gsocguides/mentor/notes-for-first-year-organizations.html

Indeed, the spirit of GSoC is integration into the organization rather than apparent exclusion. That's something that Google promotes as a key component of the GSoC program.

Ultimately the decision is up to the contributors, but I would suggest taking this, and how it looks to GSoC, into account.

@talagayev
Copy link
Member Author

I am fine with both of the solutions :) I think I have already the secret keys for Codecov and Docs implemented there, so it should be fine with the movement of the package, since I should be still able to commit changes if I move the package.

@IAlibay
Copy link
Member

IAlibay commented Sep 1, 2024

@lilyminium @fiona-naughton can either of you assign yourselves to shepherd this PR?

@fiona-naughton fiona-naughton self-assigned this Sep 5, 2024
@fiona-naughton
Copy link
Contributor

Looking good to me - thanks @talagayev! My one comment might be mention it's for use in jupyter notebooks in the description.

I also see you have a CHANGELOG line, but it's commented out - is that intentional? No worries if you're planning to come back to it once the CHANGELOG has some entries, just wanted to check.

Leaving this for open for now since I'm not clear on if you were planning to move the repo under MDAnalysis or keep as-is?

(PS - love the logo 😄 )

Added mention of jupyter notebook
fixed changelog commenting out
@talagayev
Copy link
Member Author

Hey @fiona-naughton, nice thank you :) I added the mention of jupyter notebook in the description.
I think I forgot to comment it out, but I adjusted it, just need to start using it, since there are currently no entries there :)

(PS. Thanks, hopefully I won't get a copyright strike for it 🙃 )

@orbeckst orbeckst added the mdakit About an MDAKit. label Sep 6, 2024
@fiona-naughton
Copy link
Contributor

Sorry for the delay getting back to you @talagayev

Re: your logo, we've discussed amongst the coredevs. First, since this Kit isn't directly hosted with MDAnalysis, we're asking you to remove the MDAnalysis logo from your logo. You can still use the 'blank' MDAKits template (https://github.com/MDAnalysis/branding/tree/main/templates/MDAKits).

Second, please note that MDAnalysis does not endorse copyright infringement in any way. This is not a determination that your kit does or does not infringe any copyrights but a general statement of the position of the MDAnalysis organization. We recommend all authors check their kits use code and other materials under appropriate licenses and do not infringe on any copyrights. MDAnalysis cannot give any legal advice on these matters; if you're unsure about any legal matters please consult a lawyer.

Otherwise things are look good - thank you!

@talagayev
Copy link
Member Author

Sorry for the delay getting back to you @talagayev

Re: your logo, we've discussed amongst the coredevs. First, since this Kit isn't directly hosted with MDAnalysis, we're asking you to remove the MDAnalysis logo from your logo. You can still use the 'blank' MDAKits template (https://github.com/MDAnalysis/branding/tree/main/templates/MDAKits).

Second, please note that MDAnalysis does not endorse copyright infringement in any way. This is not a determination that your kit does or does not infringe any copyrights but a general statement of the position of the MDAnalysis organization. We recommend all authors check their kits use code and other materials under appropriate licenses and do not infringe on any copyrights. MDAnalysis cannot give any legal advice on these matters; if you're unsure about any legal matters please consult a lawyer.

Otherwise things are look good - thank you!

All good :)

Yup, I adjusted the Logo to the blank MDAKits Logo.

I removed also the additional Gear of the logo, so that it is now the blank MDAKits Logo, since yes it can be problematic, because of the copyright, so it makes sense to remove it :) I would add an additional gear if it would be fine, but I would do it by creating the gear design by myself, so that it won't be affected by copyrights. I woudl probably go for something to represent visualization/molecules so there won't be any indication of Donatello in the logo :)

Thank again for looking at the PR 😸

@orbeckst
Copy link
Member

@talagayev you can use and re-use the MDAKit template (blank gears) — that's all covered by its license. Copying a gear and adding it is all fine. But the MDAnalysis logo (the blobs in three colors and the MDAnalysis word) can't be used for legal reasons.

@talagayev
Copy link
Member Author

@talagayev you can use and re-use the MDAKit template (blank gears) — that's all covered by its license. Copying a gear and adding it is all fine. But the MDAnalysis logo (the blobs in three colors and the MDAnalysis word) can't be used for legal reasons.

Nice, then it should be fine as it is now on the readthedocs:

https://mdonatello.readthedocs.io/en/latest/

Should I modify something else for the MD? :)

@orbeckst
Copy link
Member

orbeckst commented Oct 8, 2024

@fiona-naughton can you review this kit or do you need reviewers?

@fiona-naughton
Copy link
Contributor

Sorry for taking so long to get back to this @talagayev, but all looks good now, thanks - I'll go ahead and merge. Congrats on another MDAKit!

@fiona-naughton fiona-naughton merged commit fd70787 into MDAnalysis:main Oct 18, 2024
5 checks passed
@talagayev
Copy link
Member Author

Hey @fiona-naughton, it's fine :) thank you very much for looking into the PR. thanks, yay :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
mdakit About an MDAKit. new create a new MDAKit
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants