OpenFreeEnergy / OpenFreeEnergy/ExampleNotebooks

Add README files to all data clarifying provenance and status

Open
#49 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Jupyter Notebook
Stars
70
Forks
15
Avg merge
10h 42m
Merged PRs (30d)
2

Description

We need to make sure that folks don't suddenly feel like using say the tyk2 inputs and assuming that they are synched with the PLB or even our own internal benchmark inputs.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by inventorying the data directories and identifying the tyk2 inputs, PLB inputs, and internal benchmark inputs mentioned in the issue. Add a README for each data area that records provenance and current status, with completion meaning users can distinguish synchronized inputs from standalone examples.

Written by the indexing model from the issue text.

Assessment

Tech stack
jupyter-notebook
Domain
data, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.