OpenFreeEnergy / OpenFreeEnergy/ExampleNotebooks
should we still reference Perses in showcase notebook?
Nobody has claimed this yet.
- Dominant language
- Jupyter Notebook
- Stars
- 70
- Forks
- 15
- Avg merge
- 10h 42m
- Merged PRs (30d)
- 2
Description
When I first ran the showcase notebook without any contextual knowledge, I was confused as to why behavior was described as "Perses-like", since the Perses homepage comes with a big "under development" disclaimer.
I now understand that OpenFE borrowed from Perses, but for a new user I think this is more distracting than it is helpful. I suggest we rephrase or remove these references for the sake of clarity.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Open the showcase notebook and find the references describing behavior as “Perses-like.” Read the surrounding explanation and revise or remove those references so a new user is not distracted by Perses’s development status; done means the notebook’s wording is clear without that contextual confusion.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- jupyter-notebook
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100