Reorganizing package and adding `setup.py`

bernardopacini commented 3 years ago

Purpose

This PR reorganizes the pyXLIGHT package to make it easier to build, install, and use (Issue #2). The code is not significantly changed besides adjusting how modules are setup and imported.

This PR also does not address complexifying the code.

Type of change

What types of change is it? Select the appropriate type(s) that describe this PR

Bugfix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (non-backwards-compatible fix or feature)
Code style update (formatting, renaming) X Refactoring (no functional changes, no API changes)
Documentation update
Other (please describe)

Testing

Moved functionality test to tests/ directory

Checklist

Put an x in the boxes that apply.

[ ] I have run unit and regression tests which pass locally with my changes
[ ] I have added new tests that prove my fix is effective or that my feature works
[X] I have added necessary documentation

bernardopacini commented 3 years ago

With regards to standardizing the repo with a config.mk file and testing, I think we can fix up the configuration files in this PR (as they are related to setup and installation) but I would hold off on Azure and instead implement that as its own PR. Is this okay with you @nwu63? If yes, I'll go ahead and update the config file structure.

bernardopacini commented 3 years ago

With regards to standardizing the repo with a config.mk file and testing, I think we can fix up the configuration files in this PR (as they are related to setup and installation) but I would hold off on Azure and instead implement that as its own PR. Is this okay with you @nwu63? If yes, I'll go ahead and update the config file structure.

I went ahead and made these changes. The build process is similar to the one used for ADflow, but simplified given that it is a smaller / more simple code.

ewu63 commented 3 years ago

With regards to standardizing the repo with a config.mk file and testing, I think we can fix up the configuration files in this PR (as they are related to setup and installation) but I would hold off on Azure and instead implement that as its own PR. Is this okay with you @nwu63? If yes, I'll go ahead and update the config file structure.

I'm fine with implementing Azure (and converting the existing test to use unittest) in a later PR.

mdolab / CMPLXFOIL