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

Installation Issues #14

Closed
akaszynski opened this issue Sep 15, 2021 · 3 comments · Fixed by #15
Closed

Installation Issues #14

akaszynski opened this issue Sep 15, 2021 · 3 comments · Fixed by #15

Comments

@akaszynski
Copy link

Hello,

I'm reviewing your submission for JOSS and having a tough time getting started installing your library. I'd suggest the following:

  • Provide a package of your library on PyPi
  • Check for an installation of OGS and then raise a descriptive error when the application is missing. For example, immediately after:

    ogs6py/ogs6py/ogs.py

    Lines 114 to 117 in 354945b

    if sys.platform == "win32":
    ogs_path = os.path.join(ogs_path, "ogs.exe")
    else:
    ogs_path = os.path.join(ogs_path, "ogs")

    Add a test if the file exists with os.path.isfile, and then point the user to a url containing application installation directions.
  • Avoid non-descriptive runtime errors:
    raise RuntimeError

Cheers!
Alex

@leouieda
Copy link

Related to openjournals/joss-reviews#3673 (so we can see the status in the review issue)

@joergbuchwald
Copy link
Owner

Hi @akaszynski,
thanks for reviewing. Concerning the first point, ogs6py is already on PyPI: https://pypi.org/project/ogs6py/
Perhaps, I should add that to the installation instructions as well...

@akaszynski
Copy link
Author

thanks for reviewing. Concerning the first point, ogs6py is already on PyPI: https://pypi.org/project/ogs6py/
Perhaps, I should add that to the installation instructions as well...

Ha! I feel stupid for not even looking. Yes, directions would be helpful for that.

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 a pull request may close this issue.

3 participants