search

patrickfuchs / buildH

:computer: Build hydrogen atoms from united-atom molecular dynamics of lipids and calculate the order parameters.
https://buildh.readthedocs.io/
BSD 3-Clause "New" or "Revised" License
14 stars 7 forks source link

[Request] Add documentation for building from source with minimal dependencies #144

Closed lilyminium closed 3 years ago

lilyminium commented 3 years ago
  1. The current documentation for building from source starts here: https://buildh.readthedocs.io/en/latest/installation.html#for-developpers

(typo note: developpers -> developers, developement -> development)

  1. Which links to this fairly complete document on how to install via conda with an environment file: https://github.com/patrickfuchs/buildH/blob/master/devtools/install_dev.md

(suggestion: I'd say "building from source" at some point for people googling)

However, I'm not sure I actually need any of the stuff in environment.yml apart from the link to requirements.txt. pytest, sphinx, etc are helpful if I want to make a development environment, but not necessary to just build the package from source and run it.

Request:

Add an explicit link to requirements.txt in the user-facing documentation with instructions for how to use it. This has the advantage of also documenting installing with pip, as some people can't or won't use conda. It also more explicitly fulfills the JOSS requirement for installation instructions "Is there a clearly-stated list of dependencies?".

patrickfuchs commented 3 years ago

Thanks very much @lilyminium for your suggestion.

Indeed I understand your point. In commit ad89bf3, I corrected the typos and created a new section Building from source in the installation page, which explains how to build from source without installing the full dev environment.

Regarding the JOSS requirement "Is there a clearly-stated list of dependencies?", in the main README, there is a section called "Requirements" which clearly states the packages needed (and Python versions) to run buildH. Now it is also written in the installation page of the doc.

patrickfuchs commented 3 years ago

For some reason the build-documentation github action didn't work (although it did in July!), so you can check the updated doc page here for now. I will try to solve this action ASAP, but I may need my colleague @pierrepo who is currently on vacation.

patrickfuchs commented 3 years ago

I could fix the doc compilation in commit 7441be9. Now the section Building from source is readable in the doc page: https://buildh.readthedocs.io/en/latest/installation.html#building-from-source.

lilyminium commented 3 years ago

Thank you!