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

Major List Update 2023-08 #94

Closed
Irratzo opened this issue Aug 26, 2023 · 7 comments
Closed

Major List Update 2023-08 #94

Irratzo opened this issue Aug 26, 2023 · 7 comments
Assignees
Labels
add-project Add new project to best-of list configuration Issue refers to the best-of list configuration

Comments

@Irratzo
Copy link
Member

Irratzo commented Aug 26, 2023

Issue corresponding to 1) commit c850b31 and its corresponding README update f99194f ...

closing add project issues #21, #23, #28, #29, #30, #31, #35, #36, #37, #39, #44, #45, #49, #54, #66, #67, #68, #69, #70, #71, #73, #74, #75, #76, #77, #78, #80, #86, #87, #88

Note: Closing multiple issues with commit message.. The correct syntax is git commit -m "closes #1, closes #2, closes #3; YOUR COMMIT MESSAGE".

and 2) commit series b666491 ... ba49089, adding some distnguishing graphical deco to the header, in this case, an emoji-tuple as list "logo". Started with the idea of having combining the Atom emoji with a self-made, same-style neural network emoji. Didn't like that in the end. Found no emoji that really works for signifying ML, so just stuck with the emoji triple Atom, DNA, Gem Stone / Snowflake, to signify atomistic molecules & materials.

The following is about the 1), the batch processing of a long list of add project issues. I document here how I did it for the next quarterly update around October.

@Irratzo Irratzo added configuration Issue refers to the best-of list configuration add-project Add new project to best-of list labels Aug 26, 2023
@Irratzo
Copy link
Member Author

Irratzo commented Aug 26, 2023

Major List Update How-To.

The following is about the batch processing of a long list of accumulated add-project issues. I document here how I did it this time, as reference for the next quarterly update around October.

@Irratzo
Copy link
Member Author

Irratzo commented Aug 26, 2023

  1. Copy-paste all issues' project lists into a text file. We want to turn those into the format required by projects.yaml, so that we can just paste it there and run the Action update-best-of-list to incorporate them in the README.

Note:

  • In the following replacements, some replacements depend on earlier ones, so order matters.
  • Applied hand-made corrections (some issues don't conform to the format) are not explicitly mentioned here.
  1. Apply replacements to property keys.
Issue format projects.yaml format
- Project Name: - name:
- Gitbub URL: https://github.com/ github_id:
- Category: category:
- Labels: labels:
- Description: description:
- License: license:
pypi: ^J pypi_id:
conda: ^J conda_id:
maven: ^J maven_id:
- Package Managers: ^J EMPTY
- Resource: resource:
^J-----^J ^J
- Package Managers: None # package managers: none
- URL: # homepage:
license: None # license: # none found

Legend:

  • ^J = newline character (Emacs)
  • ----- lines were used to visually separate projects

@Irratzo
Copy link
Member Author

Irratzo commented Aug 26, 2023

  1. Convert labels values, list of comma-separated strings into bracket-encased list of comma-separated double-quoted strings.

Did not find a single regex command that manages to do this in one operation. Seems to required nested grouping, and couldn't get it to work. Instead, here did it like this.

# regex: single-item labels.
# description: in each line beginning with "labels: " and ending with single string, quote string, encase in brackets.
# example: labels: ab-c --> labels: ["ab-c"].
# reference: chatpgt.
sed -E '/^  labels: [^,]+$/ s/(labels: )(.+)/\1["\2"]/; /^labels: [^,]+$/! s/, /, /' in.file > out.file
# regex: multi-item labels bracketing.
# description: in each line beginning with "labels: " and ending with comma-separated list of strings, encase list in brackets.
# example: labels: ab-c, def --> labels: [ab-c, def].
# reference: chatgpt.
sed -E '/^  labels: .*[ ,].*$/ s/([^:]+: )(.+)/\1[\2]/; /^labels: .*[ ,].*$/! s/, */, /' in.file > out.file

Note that order of replacement matters here.

  • Apply regex: multi-item labels bracketing.
  • Manually insert quotes to multi-item labels ([ab-c, def] --> ["ab-c", "def"]).
    • Back up all non-label lines containing commas somehwere. (In case, same for brackets).
    • Replace [ --> [", and , --> ", ", and ] --> "].
  • Apply regex: single-item labels.

@Irratzo
Copy link
Member Author

Irratzo commented Aug 26, 2023

  1. Go over list again, correct by hand, incorrect categories, labels, links, missing descriptions, etc. In case new categories or labels had to be added, also add them in projects.yaml.

  2. sort some of the projects into sections as done in current projects.yaml. Some of the categories, such as community, datasets, educational, have some resource: true projects. Those don't get sorted by CI/CD project-score rank in the final README, but appear in order of appearance as in projects.yaml. So, separate them out and sort them alphabetically.

@Irratzo
Copy link
Member Author

Irratzo commented Aug 26, 2023

  1. Copy-paste the processed list over into projects.yaml. Don't just append, but merge with the existing sections. That means, for the resource: true sections, resort merger alphabetically.

  2. Normal update process: Push. Use commit syntax git commit -m "quarterly update YYYY-MM. closes #1, closes #2, closes #3.". On GitHub, run action update-best-of-list. Merge & rebase resulting pull request. Done.

  3. Clean up releases list. TODO

  4. Publish Zenodo release, update DOI. TODO

  5. Social media announcements. See below.

@Irratzo Irratzo self-assigned this Aug 26, 2023
@Irratzo
Copy link
Member Author

Irratzo commented Aug 26, 2023

Closed with commit c069f2a.

@Irratzo Irratzo closed this as completed Aug 26, 2023
@Irratzo Irratzo mentioned this issue Dec 3, 2023
5 tasks
Irratzo added a commit that referenced this issue Aug 12, 2024
…, closes #216, closes #217, closes #218, closes #219, closes #221, closes #226, closes #227, closes #230, closes #232, closes #236, closes #239, closes #242, closes #245, closes #247, closes #250, closes #251, closes #252, closes #255, closes #260, closes #261, , closes #265, closes #270, closes #273, closes #274, closes #276, closes #277, closes #280, closes #283, closes #284, closes #285, closes #286, closes #288, closes #289, closes #290, closes #292, closes #293, closes #294, closes #296, closes #300, closes #306, closes #308, closes #310, closes #312, closes #313, closes #314, closes #315, closes #316, closes #317, closes #318, closes #319, closes #320, closes #321, closes #325, closes #331, closes #332, closes #339, closes #341, closes #342, closes #343
@Irratzo Irratzo mentioned this issue Aug 13, 2024
17 tasks
@Irratzo
Copy link
Member Author

Irratzo commented Aug 18, 2024

Social media announcements

Note. The '@' handles below are the respective social media site's profile handles, not GitHub profile handles.

Twitter

Main message.

"Best of Atomistic Machine Learning" is a new, comprehensive list of 300+ popular AML projects, auto-ranked by quality score. Interatomic potentials, electronic structure, datasets, community resources. Courtesy http://judft.de team. https://go.fzj.de/best-of-aml #AI4Science

Response messages.

Updated quarterly. Current focus rather more on materials than drug design. Write me if you'd like to maintain & expand it together.

Tagging some project authors & others. @shuiwangji, @ruben_laplaza, @stefabat, @pavlodral, @JWestermayr, @LabOfScience, @lab_COSMO, @vl_deringer, @bfocassio, @Patilurvesh, @xie_tian, @tesssmidt, @marceldotsci, @niklasschmitz_, @RGBLabMIT, @AttilaCangi, @IlyesBatatia, @gncsimm,

@MichelangeloDo9, @MatteoCobelli1, @_RossiKevin, @davkovacs10, @lopanits, @DrugTorch, @ja_kirkpatrick, @RosyCers, @gasteigerjo, @chrsmrrs, @gdefabritiis, @MScherbela, @UllahArif_Hkt, @bm_chiheb, @tk_rusch, @j0hnparkhill, @1stBZ, @AlexLavin_C137, @mniepert, @ai4sciencetalks,

@Matgenix, @GerCanMAC, @andrrizzi, @andrea_anelli, @jigyasa_nigam, @andrewwhite01, @JoshRackers, @isomorphiclabs, @wenzel_susanne, @s_the_kessel, @luthaf, @RhysGoodall, @AleLunghi, @zany_cloud, @Smlqc1Smlqc, @albertfabriz, @ZakJost, @ssanvito, @GrohsPhilipp, @TobiasMorawietz,

@HannesStaerk, @CASUSscience, @simonbatzner, @openmsf, @hongbin_zhang, @wim_tuerger, @rbhar90, @deep_chem, @LuigiSbailo, @acceleration_c, @SandipDeScience, @NArtrith, @Ms_VS_voice, @jtmargraf, @_MatthiasRupp, @venkvis, @ktschuett, @JasonUnkcpz, @gerhardgoldbeck, @EMMC_ASBL,

@aytwang, @MaterialismPod, @ChengBingqing, @GroupTuckerman, @cedergroup, @persson_group, @bkoz37, @Materials_Intel, @nc_frey, @mat_mol_ml, @AENET_Network, @KPatBerkeley, @materialsvrlab, @MolecularXtal, @FelixMusil, @zackulissi, @P_Friederich, @Bjork_Hammer, @MicheleCeriotti,

@Evert_v_N, @MPBircher, @leeley18, @ArghyaBhowmik5, @EliskaGreplova, @EntosAI, @helmholtz_ai, @jhrmnn, @itamblyn, @olexandr, @FrankNoeBerlin, @MLSTjournal, @toniobuonassisi, @keeeto2000, @AndersSChristen, @janhjensen, @ProfvLilienfeld, @MolSSI_NSF, @KulikGroup, @Psik_Network

LinkedIn

Message text.

"Best of Atomistic Machine Learning" is a new, comprehensive list of 350+ popular AML projects, auto-ranked by quality score. Interatomic potentials, electronic structure, datasets, language models, community resources. https://lnkd.in/efgkYs_y. Courtesy http://judft.de/. hashtag#AI4Science

BlueSky

None.

Mastodon

Main message.

"Best of Atomistic Machine Learning" https://go.fzj.de/best-of-aml is a new, comprehensive list of 300+ popular AML projects, auto-ranked by quality score. Interatomic potentials, electronic structure, datasets, community resources. Courtesy http://judft.de/ team.

Response messages.

Updated quarterly. Current focus rather more on materials than drug design. Write me if you’d like to maintain & expand it together 🙏 .

Tagging some project authors & others. @ncfrey, @carrasqu, @jonkhler, @rbhar90, @janhjensen, @MolecularXtal, @volkerblum, @pfau, @marcel, @margraf, @physics_ange, @grynova_CCC, @JuliaWestermayr, @FMarquardtGroup, @mpifkf, @vl_deringer, @jhrmnn, @andrewwhite01, @luthaf, @simonbatzner, @michele_ceriotti, @lab_COSMO.

Facebook

@Irratzo Irratzo changed the title Quarterly update 2023-08 List Update 2023-08 Aug 18, 2024
@Irratzo Irratzo changed the title List Update 2023-08 Major List Update 2023-08 Aug 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
add-project Add new project to best-of list configuration Issue refers to the best-of list configuration
Projects
None yet
Development

No branches or pull requests

1 participant