Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create pydas package to better organize modules and improve installation process #12

Open
wants to merge 15 commits into
base: master
Choose a base branch
from

Conversation

jwallen
Copy link
Owner

@jwallen jwallen commented Feb 14, 2015

This moves the pydas and pydaspk modules into a common pydas package, as discussed in #11. As a result of these changes, end users will need to update their import statements, e.g.

from pydas import DASSL
from pydaspk import DASPK

become

from pydas.dassl import DASSL
from pydas.daspk import DASPK

The installers should now include the .pxd and .pyx files in the installed package, so that people can link to the compiled PyDAS modules. There is also a pydas.get_include() function that should work like the one from numpy.

The test modules were also moved into a tests folder.

Now that we're wrapping multiple DAE solvers, it makes sense to collect them
into a package. At the same time, we can improve the naming convention by
calling the moved modules pydas.dassl and pydas.daspk instead of pydas and
pydaspk.

This will force everyone to update their import statements.
Also fix a reference to header file das.h (now named pydas/dassl.h) in the
pydas.dassl module.
To further tidy up the top project folder.
Similar changes will be required by all end users.
The .pxd files are needed to allow others to link against the compiled
pydas.dassl and pydas.daspk modules. The .pyx files are nice to have so that
folks have another means of viewing the code behind the compiled modules.

Closes #11.
Usage should mirror numpy.get_include(), and thereby make it easier to link
against the compiled PyDAS modules.
rwest added a commit to ReactionMechanismGenerator/PyDAS that referenced this pull request Mar 12, 2015
This moves files into new pydas package, and means that software
using this library will need to be modified slightly:

    -from pydas import DASSL
    +from pydas.dassl import DASSL

It also removes DASPK2 and adds DASPK3.1, which allows
sensitivity analysis.

See
jwallen/PyDAS#11
jwallen/PyDAS#12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants