Skip to content

Add getting started docs#163

Merged
IAlibay merged 2 commits into
mainfrom
getting-started-docs
Jun 15, 2026
Merged

Add getting started docs#163
IAlibay merged 2 commits into
mainfrom
getting-started-docs

Conversation

@hannahbaumann

@hannahbaumann hannahbaumann commented Jun 12, 2026

Copy link
Copy Markdown
Contributor

Fixes #51

@IAlibay IAlibay left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thanks, this looks good!

Two small things but I'm approving early.

Comment thread docs/getting_started.rst
from lomap import LomapAtomMapper

mapper = LomapAtomMapper()
mappings = list(mapper.suggest_mappings(ligands[0], ligands[1]))

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

[nit] can you maybe just add an inline comment above with something along the lines of suggest_mappings is a generator so we call list to get all the possible mappings.

Comment thread docs/getting_started.rst
from lomap import default_lomap_score

score = default_lomap_score(mapping)
print(f"{score:.3f}")

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

[nit] the score for this mapping is really low so it might be surprising to someone following these instructions.

Could you maybe add a comment just below about how the score is ~ 0.095, which is expected for these two ligands (it's not immediately clear to me why - might be trying to do some ring breaking or a methyl to ring transformation?).

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Yes, this is a ring breaking transformation. Will add this.

@IAlibay

IAlibay commented Jun 15, 2026

Copy link
Copy Markdown
Member

Thanks so much @hannahbaumann !

@IAlibay IAlibay merged commit 31f21c9 into main Jun 15, 2026
12 checks passed
@IAlibay IAlibay deleted the getting-started-docs branch June 15, 2026 14:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Populate Lomap "getting started" docs

2 participants