Skip to content

Add extended documentation for experiment addition - #480

Merged
comcon1 merged 4 commits into
NMRLipids:mainfrom
comcon1:add-extended-expadd-documentation
Apr 5, 2026
Merged

Add extended documentation for experiment addition#480
comcon1 merged 4 commits into
NMRLipids:mainfrom
comcon1:add-extended-expadd-documentation

Conversation

@comcon1

@comcon1 comcon1 commented Mar 14, 2026

Copy link
Copy Markdown
Member

Use last experience of adding experiment's metadata to fullfill the documentation.

@AvNeEsH71-iam, please look into it!


📚 Documentation preview 📚: https://databank--480.org.readthedocs.build/

@comcon1 comcon1 added the documentation Improvements or additions to documentation label Mar 14, 2026
@comcon1
comcon1 marked this pull request as ready for review March 15, 2026 12:15
@AvNeEsH71-iam

AvNeEsH71-iam commented Mar 17, 2026

Copy link
Copy Markdown
Collaborator

Dear sir @comcon1. I went through the compiled documentation - https://databank--480.org.readthedocs.build/

I would like to suggest from a beginers point of view -

  • It might be helpful to add a short note clarifying that SOLUTION_COMPOSITION values should be in mass %, not molar concentration. I made this mistake and it is easy to confuse the two.

  • The install command pip install nmrlipids_databank does not currently work, the package is not available under this name on PyPI. When I tried to install it, I had to use pip install git+https://github.com/NMRLipids/FAIRMD_lipids.git instead. It would be helpful to clarify the correct install command to avoid confusion for new contributors.

Very minor typos :

  • instrutions = should be instructions (in the "Adding simulations" section)
  • straingforward = should be straightforward (in the "Installation" section)
  • intialize = should be initialize (in the Databank template description)

These were some very minor suggestions and point outs I would like to mentions. Please let me know if you would like me to make a pull request to address these points.

Thanks and Regards,
Avneesh Singh

@markussmiettinen markussmiettinen 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.

These look like highly relevant improvements. Further fine-tuning will happen as people will try to add data following them.

@comcon1

comcon1 commented Apr 5, 2026

Copy link
Copy Markdown
Member Author

Dear sir @comcon1. I went through the compiled documentation - https://databank--480.org.readthedocs.build/

I would like to suggest from a beginers point of view -

  • It might be helpful to add a short note clarifying that SOLUTION_COMPOSITION values should be in mass %, not molar concentration. I made this mistake and it is easy to confuse the two.
  • The install command pip install nmrlipids_databank does not currently work, the package is not available under this name on PyPI. When I tried to install it, I had to use pip install git+https://github.com/NMRLipids/FAIRMD_lipids.git instead. It would be helpful to clarify the correct install command to avoid confusion for new contributors.

Very minor typos :

  • instrutions = should be instructions (in the "Adding simulations" section)
  • straingforward = should be straightforward (in the "Installation" section)
  • intialize = should be initialize (in the Databank template description)

These were some very minor suggestions and point outs I would like to mentions. Please let me know if you would like me to make a pull request to address these points.

Thanks and Regards, Avneesh Singh

Thanx. I fixed all them.

@comcon1
comcon1 merged commit 6733204 into NMRLipids:main Apr 5, 2026
7 of 8 checks passed
@comcon1
comcon1 deleted the add-extended-expadd-documentation branch May 24, 2026 14:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants