Documentation: read and test

[ipelupessy]

the documentation (https://amuse.readthedocs.io/) needs to be read and critically assessed, preferably by a set of new eyes..

@MJCWilhelm: can you do this?

[MJCWilhelm]

Yes I'll be on it! On what timescale does it need to be done?

[ipelupessy]

there is no deadline...but if you do it soon you will also not spend too much time on it;-) the documentation is all in the repository, so if you can work on it and commit (small changes) or make PR (larger ones) if you see anything...or make issues if you see a problem but no solution ofcourse..

[MJCWilhelm]

I went through a big chunk of it and already pushed some updates to the tutorial (mostly update to python3). For the rest I had some questions/comments:

• The entire 'installation' section is outdated, and should probably be replaced by the version on the github.io page. Where can I find the source for those pages, and would a copy-paste work?

• Some of the tutorials (particle sets, implementing code) use optional gnuplot. I can't seem to get it to work (how to import?), but I'd say that matplotlib is widespread enough that we can use that instead.

• I tried out the Blender tutorial, but the native python interpreter didn't know amuse. Perhaps someone with Blender experience can update this?

• The 'integrating a c++/fortran code' sections are somewhat incomplete, as many codes have parameters and states, and these aren't detailed in any of the tutorials.

• The 'adding a gravitational dynamics code' section is unfinished.

--- Concerning these last two, perhaps I can make a new example code (just a simple Euler/leapfrog integrator) and use that for both sections? The gravitational dynamics section I assume would make use of the pre-defined gravitational dynamics interface?

• The script that is referred to in 'plotting with amuse' is missing. This should be 'test_plot.py' in examples/applications.

I haven't had time yet to go through the reference documentation or the design documentation.

[ipelupessy]

great!!

[ipelupessy]

additional comments:

• @rieder do you have suggestions for the install doc?
• i think indeed gnuplot should be removed
• I have not noticed anyone using blender the last few years, so for me that can also be removed
• indeed, a new better (more up to date) example is most welcome...

[rieder]

• @rieder do you have suggestions for the install doc?

I'll need to think about this

• i think indeed gnuplot should be removed

agreed

• I have not noticed anyone using blender the last few years, so for me that can also be removed

agreed

• indeed, a new better (more up to date) example is most welcome...

definitely

[stale[bot]]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed in 28 days if no further activity occurs. Thank you for your contributions.

[ipelupessy]

did we fix/ follow up on the last suggestions?

[stale[bot]]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed in 28 days if no further activity occurs. Thank you for your contributions.

[rieder]

did we fix/ follow up on the last suggestions?

no