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.

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

Sort out sphinx documents for features that cannot be built together #1134

Closed
RudolfWeeber opened this issue May 8, 2017 · 4 comments
Closed
Milestone

Comments

@RudolfWeeber
Copy link
Contributor

Sphinx uses introspection to get the doc strings from the python moduels.
Hence, modules not being built due to missing myconfig.hpp features are not included in the doc.
We build the doc based on the maxset features set.

@RudolfWeeber
Copy link
Contributor Author

#1135

@RudolfWeeber
Copy link
Contributor Author

The tenative outcome is the following:

No Python support, may still be incomatible with other featues:
Misc:
BD
CONFIGTEMP #1147
EK_REACTION #1138
IMMERSED_BOUNDARY #1139
LEES_EDWARDS #1140
METADYNAMICS #1142
MOL_CUT #1143
MULTI_TIMESTEP #1144
SHANCHEN #1145
UMBRELLA #1146

Dpd related: #943
DPD
DPD_MASS
DPD_MASS_LIN
DPD_MASS_RED
INTER_DPD
TRANS_DPD
TUNABLE_SLIP

Stokesian Dynamics: #1091
SD
SD_FF_ONLY
SD_NOT_PERIODIC
SD_USE_FLOAT

Object in fluid related #1141
AFFINITY
OIF_LOCAL_FORCES
OIF_GLOBAL_FORCES
MEMBRANE_COLLISION

Include in maxset:
BOND_ANGLE
BOND_ANGLE_COSINE
BOND_ANGLE_COSSQUARE
BOND_ANGLE_HARMONIC
BOND_ANGLE_OLD
H5MD

Incompatible featues:
CG_DNA because of Coulomb Debye Hueckel #1135
COULOMB_DEBYE_HUECKEL incompatible with Debye Hueckel #1135
GAUSSRANDOM, GAUSSRANDOMCUT #1137
THERMOSTAT_IGNORE_NON_VIRTUAL
VIRTUAL_SITES_COM
VIRTUAL_SITES_NO_VELOCITY
VIRTUAL_SITES_THERMOSTAT
BOND_CONSTRAINT (rattle is incompatible with ROTATION) #1148

External Dependency:
SCAFACOS
SCAFACOS_DIPOLES

remove:
TK Remove
FORCE_CORE

@RudolfWeeber
Copy link
Contributor Author

Regarding the stuff to be included (previous comment):

All the BOND_ANGLE_SOMETHING features are legacy stuff not present in the Python interface.
there is a pr open to remove them entirely #1153

H5MD is an external dependency, which is compiled in if available. So nothing to do, as well.
SCAFACOS doc is also compiled in, if it is available.
We should probably change the version on the CI server to one, which includes the dipolar stuff, so that that is included in the doc as well.

@RudolfWeeber RudolfWeeber added this to the Espresso 4.0 milestone Sep 6, 2017
@RudolfWeeber
Copy link
Contributor Author

Afaik, the only things left are SHANCHEn and the different LB noise types.
Everything else has been removed or refactored.
Since noe of this affects the docs at this point, I'll close this issue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant