SimonEnsemble / PorousMaterials.jl

Julia package towards classical molecular modeling of nanoporous materials
GNU General Public License v3.0
51 stars 11 forks source link

suggestions for PorousMaterials.jl #42

Closed mtap-research closed 6 years ago

mtap-research commented 6 years ago

Hello,

I think the code is well-documented and will help others to run/deploy monte carlo simulations with ease. However, I have a couple of suggestions for the code.

  1. I cannot help notice there are some special characters, e.g., α for alpha angle in crystal, everywhere in the code. I think it makes much easier to type in "alpha" instead of copy and paste "α", or volume instead of "Ω". Another example is "π". I find it much easier to simply type "pi" than copy/paste "π " and I am sure other people feel the same way. So perhaps it might be good to change these special characters into words.

  2. People who will test drive the code will be the ones that will be much comfortable running the code in terminal environment and not necessarily in Julia environment. So it would be nice if the examples are converted into command line scripts.

Thanks and I hope the code will be a success!!

SimonEnsemble commented 6 years ago

Thanks for the feedback Greg! I added the answers to these in the FAQ here.

mtap-research commented 6 years ago

Thanks!! FAQ is super helpful 👍