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

Module name #1

Closed
prisae opened this issue Dec 7, 2018 · 5 comments
Closed

Module name #1

prisae opened this issue Dec 7, 2018 · 5 comments

Comments

@prisae
Copy link
Contributor

prisae commented Dec 7, 2018

I suggest to change the module name from lops to pylops, to be the same as the package name to install.

I installed it with pip install pylops, fired-up an IPython session, and run import pylops just to get an error that pylops is apparently not installed. So you have to go to the documentation and examples to find out how to call it. Ah, it's name is lops, so import lops.

I might not be the only one facing that issue. Most modules follow the convention to name the module the same as the package you install (e.g. numpy, scipy, numba, matplotlib, basically most I can think of, although there are exceptions).

I thought I open an issue to discuss it and change it now (v1.0.1) or never, as the package is still pretty new and not too much code is written yet with import lops. This will probably change pretty soon and changing the module name would not be a good idea anymore down the road.

@mrava87
Copy link
Collaborator

mrava87 commented Dec 9, 2018

Agree. I thought it would make sense to just have lops when you are already in the python world, but I can see this would generate more confusion than anything else.

I have changed the module so that from version 1.0.1 you can do import pylops. I know this is not compatible with version 1.0.0 but since I don't expect many people to have started using PyLops yet I didn't think it would be needed to boost the version to 2.0.0.

Also in the README Getting started section I have now added a line to show how to import pylons.

NOTE: having some issues to put v1.0.1 on PyPi

HTTPError: 400 Client Error: This filename has already been used, use a different version. See https://pypi.org/help/#file-name-reuse for url: https://upload.pypi.org/legacy/

seems like I did it before while I was testing stuff and had by mistake boost up my version and PyPI doesn't seem to allow uploading versions that have been previously removed. Unless you have a suggestion here I suggest to wait until we have v1.1.0 (going to add some new operators soon anyways) and then upload that to PyPI.

@prisae
Copy link
Contributor Author

prisae commented Dec 9, 2018

Waiting for v1.1.0 is fine. Or simply bump it to version v1.0.2 now without any further changes.

@prisae
Copy link
Contributor Author

prisae commented Dec 9, 2018

I have changed the module so that from version 1.0.1 you can do import lops.

I assume you wanted to say

I have changed the module so that from version 1.0.1 you can do import pylops.

@mrava87
Copy link
Collaborator

mrava87 commented Dec 9, 2018

Aaah yep, I fixed it in the comment above :) otherwise that would be much of a change ;)

@prisae
Copy link
Contributor Author

prisae commented Dec 9, 2018

Indeed 😄 Closing it then, thanks!

@prisae prisae closed this as completed Dec 9, 2018
mrava87 pushed a commit that referenced this issue Oct 10, 2020
mrava87 added a commit that referenced this issue Jan 25, 2022
Improve Spread operator and example
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

No branches or pull requests

2 participants