search

mrgprasad / kanapy

Synthetic microstructure generator. Online documentation:
https://mrgprasad.github.io/kanapy/index.html
GNU Affero General Public License v3.0
20 stars 7 forks source link

Documentation improvements #3

Closed KedoKudo closed 5 years ago

KedoKudo commented 5 years ago

@mrgprasad Currently kanapy has a very extensive documentation, but I think most users could appreciate if the following aspects of the documentation can be improved:

mrgprasad commented 5 years ago

@KedoKudo Thank you for the suggestions. Could you please elaborate on your benchmark comment? Do you mean benchmarking the particle packing simulation time?

KedoKudo commented 5 years ago

As a user, I would prefer to know what is the most time consuming aspect of kanapy and the corresponding scalability (lognorm, linear, quadratic, etc.). I can use these information to extrapolate a rough estimate of the total computational time required for my workflow. For example, if I am using kanapy to generate the microstructure input for my micromechanics simulation, I need to decide whether I want to bundle the two steps into one HPCC job. If generating a microstructure only accounts for a fraction of the total simulation time and it scales very well, I would probably bundle two steps into one and use the total simulation time as a rough estimate to request time on HPCC. Otherwise, I would most likely submit separate requests to maximize my chance of getting the time.

mrgprasad commented 5 years ago

@KedoKudo Based on you suggestions for documentation improvement, I have updated the following:

  1. The contents of the .dump file has been described in the Usage section under the heading: Visualize the packing simulation.

  2. The user can now specify in the input file, the output unit in which the ABAQUS file and the Output statistics can be exported.

  3. In the documentation, under the section Applications, I have added a sub-section called Simulation benchmarks. This details the CPU time required for particle packing and voxelization routines. These are the critical aspects of Kanapy.

  4. src.kanapy. has been changed to kanapy. in the documentation.

KedoKudo commented 5 years ago

@mrgprasad Thank you for adding the benchmark and various other edits in the documentation. I will close this issue now.