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

Use a Python package boilerplate #1

Closed
miquelduranfrigola opened this issue Feb 22, 2024 · 5 comments
Closed

Use a Python package boilerplate #1

miquelduranfrigola opened this issue Feb 22, 2024 · 5 comments
Assignees

Comments

@miquelduranfrigola
Copy link
Member

miquelduranfrigola commented Feb 22, 2024

This repository should have the structure of a Python package. @HellenNamulinda you can gain inspiration from other Ersilia repositories such as lazy-qsar or stylia.

In short, I typically like to have:

  • A src or xai4chem folder where the package code resides.
  • A notebooks folder where I do my analyses and data processing
  • A scripts folder where I have executable pipelines, also for analyses.
  • An assets folder where I keep image files etc.
  • A data folder
  • A results folder
  • All the necessary files, for example, a setup.py, a LICENSE, etc.
@miquelduranfrigola
Copy link
Member Author

Hi @HellenNamulinda I have quickly had a look and it looks good to me. Feel free to close the issue or leave it open.

@HellenNamulinda
Copy link
Collaborator

I will close this

@miquelduranfrigola
Copy link
Member Author

Hi @HellenNamulinda
I've quickly checked the setup.py file. I think the classifiers are not yet specified. We can start from python 3.10 in my opinion. Also, the keywords are somewhat redundant: explainable ai is equivalent to xai. Also, please check consistency between having a hyphen or not. Why drug-discovery has a hyphen and machine learning doesn't? Just pick a rule (hyphen or not hyphen) and stick to it.

@HellenNamulinda
Copy link
Collaborator

@miquelduranfrigola,
I will adjust those in the next PR.

@HellenNamulinda
Copy link
Collaborator

This was addressed in the commit: adff61c

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

No branches or pull requests

2 participants