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

Proposal for installation cleanup #106

Open
petrrr opened this issue Nov 24, 2014 · 1 comment
Open

Proposal for installation cleanup #106

petrrr opened this issue Nov 24, 2014 · 1 comment
Assignees
Labels

Comments

@petrrr
Copy link

petrrr commented Nov 24, 2014

Here are some proposals for cleanup:

  • Currently PyProgs installs as waveloc and examples as waveloc_examples. See also the setup.py script (https://github.com/amaggi/waveloc/blob/master/setup.py#L12). This is probably unnecessarily confusing. So I'd propose just to rename these directories in the repo.
  • Also installing the examples as module does not really make sense, these are all callable scripts which should not be imported as modules.
  • Probably, deprecated and README could be moved from PyProgs.
  • I am wondering if the tests (currently in PyProgs) should not be put into a separate directory.
  • Module naming with mixed case is quite unusual, and I believe it is not PEP8 complaint (https://www.python.org/dev/peps/pep-0008#package-and-module-names). Consider renaming some of them.
  • What about the run_* scripts in scripts? Should they be considered examples?
  • lib, nll, test_data are probably related to tests or examples as well

These are just some observation. So feel free to just ignore them.

@amaggi amaggi added the cleanup label Dec 3, 2014
@amaggi amaggi self-assigned this Dec 3, 2014
@amaggi amaggi added this to the Version 1.0 released milestone Dec 3, 2014
@amaggi
Copy link
Owner

amaggi commented Dec 9, 2014

Have started propagating these fixes in the u-grid branch, notably :

  • renamed the waveloc and waveloc-examples directories
  • moved the tests to a separate directory

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants