Files organization about vibration_toolbox

[josephcslater]

Frankly I'd like to move away from that book. Keep in mind, I wrote the software for him for $1000 23 years ago. I'm still doing the job, lol. I'd like it to be text independent, so let's not organize as per the book, but simply by function.

It might be easiest to have a single .py file that they all call that sets up the imports (scipy, etc.), separating them into files will be fine. I can later organize them so import vtoolbox imports all of them. separating files doesn't change that in python.

The numerical stuff is fine, but in reality dead. Nobody would use either of those methods today. Much better integrators abound. The integrator built into scipy is better. Why expend time learning an old method that works poorly? It's worthwhile for a numerical methods class, but this is about understanding the physics of vibration and how to do analysis to drive engineering decisions. That's much more critical. Thus the need for sliders in the notebooks so that one can learn to get a feel for parametric sensitivities.

[raphaeltimbo]

Regarding the organization of files, I was thinking that we could have a __init__.py file inside the pvtoolbox directory. Inside this file we could write -> from . import free_response as free. If we use -> import pvtoolbox as pv inside the notebook, functions inside free_response.py will be available using pv.free. (e.g.: pv.free.sdof_free_response() to call sdof_free_response).

[josephcslater]

That's too convoluted for the user in my opinion. I would only want separate .py files to make it easier a for use to edit. Can we not make it one "." with everything after that? Having a complex structure for users is unnecessary and cumbersome.

That said, I don't want p in the import, etc. I just want the name in usage to be vibration toolbox, or perhaps even renamed. If the user is in Python, Python is already clear.

I don't have a good answer yet, but these are things to keep in mind.

Sent from my iPhone

On Jul 1, 2016, at 1:03 PM, raphaeltimbo [email protected] wrote:

Regarding the organization of files, I was thinking that we could have a init.py file inside the pvtoolbox directory. Inside this file we could write -> "from . import free_response as free". If we use -> "import pvtoolbox as pv" inside the notebook, functions inside free_response.py will be available using pv.free. (e.g.: pv.free.sdof_free_response() to call sdof_free_response).

—
You are receiving this because you commented.
Reply to this email directly, view it on GitHub, or mute the thread.

[raphaeltimbo]

You are right. I am still trying to understand python import.. Maybe later we can find a way to organize this. For now I am going to keep using the vtoolbox.py file.

[josephcslater]

Use the .py file, but let's use separate ipynb files because they merge so poorly.

I did have the thought of perhaps pulling out the sdof stuff, chapters 1-3, which can also be tools for later on to some degree. That's a more logical break around a larger chunk.

Sent from my iPhone

On Jul 5, 2016, at 6:01 PM, raphaeltimbo [email protected] wrote:

You are right. I am still trying to understand python import.. Maybe later we can find a way to organize this. For now I am going to keep using the vtoolbox.py file.

—
You are receiving this because you commented.
Reply to this email directly, view it on GitHub, or mute the thread.

[raphaeltimbo]

Regarding the ipynb files, I was looking at that and the biggest problem are the outputs from the notebooks. For version control we can word around this by using the 'clear outputs' from the notebook or better:
https://github.com/kynan/nbstripout

[josephcslater]

This is a good plan. It's what I did with my course notes.

On Jul 23, 2016, at 9:25 PM, raphaeltimbo [email protected] wrote:

Regarding the ipynb files, I was looking at that and the biggest problem are the outputs from the notebooks. For version control we can word around this by using the 'clear outputs' from the notebook or better:
https://github.com/kynan/nbstripout https://github.com/kynan/nbstripout
—
You are receiving this because you commented.
Reply to this email directly, view it on GitHub #5 (comment), or mute the thread https://github.com/notifications/unsubscribe-auth/AMOL5zKXrp7GVw9yMy1a1eWMQc9JxDIlks5qYr73gaJpZM4JAKEx.

[josephcslater]

On Jul 23, 2016, at 9:25 PM, raphaeltimbo [email protected] wrote:

Regarding the ipynb files, I was looking at that and the biggest problem are the outputs from the notebooks. For version control we can word around this by using the 'clear outputs' from the notebook or better:
https://github.com/kynan/nbstripout https://github.com/kynan/nbstripoutI have implemented this in .gitattributes. I don't know if you need to do anything on your machine to make it work locally for you.

Best Regards- Joe

—
You are receiving this because you commented.
Reply to this email directly, view it on GitHub #5 (comment), or mute the thread https://github.com/notifications/unsubscribe-auth/AMOL5zKXrp7GVw9yMy1a1eWMQc9JxDIlks5qYr73gaJpZM4JAKEx.

[josephcslater]

Please sync and take a look at the new mods.
I renamed vtoolbox.py to sdof.py as a way to separate them from what will be less educational and more utilitarian codes. Renaming functions may now make sense as sdof in function names will appear redundant. This should make the usage a bit cleaner.

[josephcslater]

pip install works. Whether the package works... well, that's why it's beta.

https://pypi.python.org/pypi/VibrationToolbox/0.5b0

[raphaeltimbo]

I am closing this one since now I think the project has a defined structure for the files/modules.