ESyS-Particle

tutorial update

Asked by Yuanxingyu

Hi, everyone,
I'm a freshman on studying EsysParticle. I wondered whether the EsysParticle tutorial was updated recently? As i study Esys further, i found that i could not found many functions were proposed in the tutorial (version 2.3.1), for example: sim.readGeometry(..) et. al. I wondered the function list and their usage. If possible, could you please tell me how to find the functions?

Yours,
Yuan

Question information

Language:
English Edit question
Status:
Solved
For:
ESyS-Particle Edit question
Assignee:
No assignee Edit question
Solved by:
Dion Weatherley
Solved:
Last query:
Last reply:
Revision history for this message
Best Dion Weatherley (d-weatherley) said : 		#1

Hi Yuan,

Whilst the ESyS-Particle Tutorial has not been updated for some time, all of the information and scripts therein still work with the latest versions of ESyS-Particle. I am a little surprised that you are unable to find reference to functions such as readGeometry(..). I will try to explain how to find further information on these functions:

Firstly, it is important to note that the word "sim" in the Tutorial is a user-defined variable name. When a simulation container is constructed via sim = LsmMpi (..) at the start of a simulation script, this variable name is assigned to a class of type LsmMpi. readGeometry(..) and many other functions are subroutines of the LsmMpi class. The ESyS-Particle Python API Reference Manual provides more information on all of the ESyS-Particle classes and their subroutines:
http://esys.geocomp.uq.edu.au/esys-particle_python_doc/current/pythonapi/html/index.html

The documentation specific to LsmMpi is here:
http://esys.geocomp.uq.edu.au/esys-particle_python_doc/current/pythonapi/html/esys.lsm.LsmPy.LsmMpi-class.html

Please note that the online Python API documentation is also a bit outdated now. It does not contain documentation for some more recently added features. You are encouraged to generate new documentation during compilation and installation of the latest versions of ESyS-Particle. To do that, ensure you have doxygen and epydoc installed prior to compiling ESyS-Particle from source code.

I hope this helps.

Cheers,

Dion

Revision history for this message
Yuanxingyu (yxy-482263) said : 		#2

Thanks Dion Weatherley, that solved my question.