Add pip support

[DavidAnderegg]

Overview

As promised in #171 this PR makes SHARPy installable via pip. After building and testing, you simply install it in the current anaconda environment by running pip install .. This copies all necessary files into the environment and makes the command sharpy globally available (as long as the anaconda environment is activated).

If you are developing SHARPy, you can install it in development mode with this command: pip install -e .. This creates only a link to the location of the SHARPy files and allows "live editing" of its source while still having all the other benefits. More about it here.

Changes

• created setup.pywhich handles the install procedure (you might want to make sure I entered the proper information)
• added __version__ variable to sharpy.__init__.py. This tells the setup the current version of the library and has to be changed manually before a new release
• moved the cases folder into sharpy/cases. This way it becomes part of the sharpy package itself. I guess this is the most controversial change I am proposing. But it is a lot cleaner and makes life easier (the examples can be imported everywhere via sharpy.cases....). One could argue that it should not be part of the library as it does not really provide functionality. But I have seen this in the past (for example here) and I believe the benefits are worth it. What do you think?
• Changed the examples to import cases from SHARPy (e.g from sharpy.cases.templates import ...)
• Removed the bin directory and its content
• added the function sharpy_run() to sharpy_main.py which gets executed whenever you call sharpy in the console. It is basically the same as bin/sharpy was
• Updated the docs to remove mentions of sharpy_vars.sh

General Notes

• I have broken the example nonlinear_t-tail_HALE.ipynb because i moved the cases folder. Maybe you can fix it? All the other examples seem to work.
• Please don't do this again. This completely breaks expected python behavior and took me quite some time to figure out.

I am quite sure i broke something it did not think about. Please test it and let me know what you think. Feel free to commit to my branch.

[ngoiz]

Hi David,

Thank you very much for taking the effort and adding this to SHARPy, it will be a great addition that will make things a lot easier. I'll go through it over the next few days and comment here or commit directly to the branch if I see anything.

Again, many thanks!

[ngoiz]

Finally got around to reviewing and updating this, apologies and many thanks for adding this feature, @DavidAnderegg!!

All looks good, I added minor things and restored a data file that was lost thanks to gitignore I assume.

Branch updated with the latest development branch that includes the automated unittests as a Github action that are also passing.