Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update docs 4.1 #3244

Merged
merged 7 commits into from
Oct 15, 2019
Merged

Update docs 4.1 #3244

merged 7 commits into from
Oct 15, 2019

Conversation

jngrad
Copy link
Member

@jngrad jngrad commented Oct 10, 2019

Provide links to Dockerfiles, fix links in 4.1 release notes, fix typos.

@jngrad
Fix links in release notes
7603eb8
@jngrad
Remove duplicate argument documentation
1961cab 
Argument descriptions already in the docstrings of the linked
functions.
@jngrad
Fix typos
9fee2b9
@jngrad
Provide links to Dockerfiles for other Linux OSes
eb68e3a 
Based on feedback from the ESPResSo summer school's user and
developer meeting (@kosovan).
@jngrad jngrad added this to the Espresso 4.1.1 milestone Oct 10, 2019
@jngrad jngrad requested a review from pkreissl October 10, 2019 20:18
@codecov
Copy link

codecov bot commented Oct 10, 2019 •
edited
Loading

Codecov Report

Merging #3244 into python will decrease coverage by <1%.
The diff coverage is n/a.

Impacted file tree graph

@@          Coverage Diff           @@
##           python   #3244   +/-   ##
======================================
- Coverage      85%     85%   -1%     
======================================
  Files         528     528           
  Lines       25805   25805           
======================================
- Hits        22150   22148    -2     
- Misses       3655    3657    +2
Impacted Files Coverage Δ
src/core/electrostatics_magnetostatics/p3m.cpp 86% <0%> (-1%) ⬇️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 9dc1e06...eb68e3a. Read the comment docs.

@jngrad
Copy link
Member Author

jngrad commented Oct 10, 2019 •
edited
Loading

@christophlohrmann

  • Do you know why the first two lists of running.html#isotropic-npt-thermostat are an almost exact copy of system_setup.html#isotropic-npt-thermostat?
  • Why does system_setup.html give a circular link to itself instead of pointing to your far more detailed NPT discussion?
  • running.html says all directions fluctuate by default. Function signature says [0, 0, 0] by default. Shouldn't we write in the docstring that 0 means dimension is not fixed and 1 is fixed?
  • Why is the friction coefficient gammaV described as the piston mass Q?

    espresso/src/python/espressomd/thermostat.pyx

    Lines 429 to 431 in 9dc1e06

    gammav : :obj:`float`
    Artificial friction coefficient for the volume fluctuations.
    Mass of the artificial piston.

@codecov
Copy link

codecov bot commented Oct 11, 2019 •
edited
Loading

Codecov Report

Merging #3244 into python will decrease coverage by <1%.
The diff coverage is n/a.

Impacted file tree graph

@@          Coverage Diff           @@
##           python   #3244   +/-   ##
======================================
- Coverage      85%     85%   -1%     
======================================
  Files         530     530           
  Lines       25795   25795           
======================================
- Hits        22168   22167    -1     
- Misses       3627    3628    +1
Impacted Files Coverage Δ
src/core/particle_data.cpp 96% <0%> (-1%) ⬇️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 054183b...9d95c39. Read the comment docs.

@jngrad
Fix issue in the NPT documentation
823af52 
Fix broken link, incorrect docstrings and copy-paste errors (based
on inspection of the C++ code for the NPT integrator and offline
discussion with @christophlohrmann).
christophlohrmann
christophlohrmann approved these changes Oct 15, 2019
View reviewed changes
Copy link
Contributor

@christophlohrmann christophlohrmann left a comment

Choose a reason for hiding this comment

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

Looks good to me

@jngrad
Copy link
Member Author

jngrad commented Oct 15, 2019

bors r=fweik

bors bot added a commit that referenced this pull request Oct 15, 2019
@bors @jngrad @fweik
Merge #3244 #3250
94d51f5 
3244: Update docs 4.1 r=fweik a=jngrad

Provide links to Dockerfiles, fix links in 4.1 release notes, fix typos.

3250: core: virtual_sites: Removed default argument from virtual function and non-functional virtual COM feature r=jngrad a=fweik

Description of changes:
 - Removed dead code (`VIRTUAL_SITES_COM`, `THERMOSTAT_IGNORE_NON_VIRTUAL`)
 - Removed default argument on virtual function

Co-authored-by: Jean-Noël Grad <jgrad@icp.uni-stuttgart.de>
Co-authored-by: Florian Weik <fweik@icp.uni-stuttgart.de>
@bors
Copy link
Contributor

bors bot commented Oct 15, 2019

Build succeeded

@bors bors bot merged commit 9d95c39 into espressomd:python Oct 15, 2019
@jngrad jngrad deleted the update-docs-4.1 branch January 18, 2022 12:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@fweik fweik fweik approved these changes

@christophlohrmann christophlohrmann christophlohrmann approved these changes

@pkreissl pkreissl Awaiting requested review from pkreissl

Assignees
No one assigned
Labels
Documentation
Projects
None yet
Milestone
Espresso 4.1.1
Development

Successfully merging this pull request may close these issues.
3 participants
@jngrad @fweik @christophlohrmann