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

install help uses wrong names #846

Open
adhamhashibon opened this issue Jan 27, 2023 · 2 comments
Open

install help uses wrong names #846

adhamhashibon opened this issue Jan 27, 2023 · 2 comments
Labels
📖 documentation 🚧 installation Issues affecting the package installation. NOT related to the installation of ontologies.

Comments

@adhamhashibon
Copy link

adhamhashibon commented Jan 27, 2023

both the user docs and the readme are a bit hard to follow. it is not clear that one should clone and either run the install from within the simphony-osp folder like so pip install . or run 'pip install ./simphony-osp` from out side the folder!

@kysrpex
Copy link
Contributor

kysrpex commented Jan 30, 2023

I believe you may be getting confused because probably last time you tried SimPhoNy it was not available on PyPI.

The README says:

SimPhoNy is available on PyPI, so it can be installed using pip

The documentation says:

SimPhoNy is available on PyPI, so it can be installed using the pip package manager.

And both statements are followed by the command:

pip install simphony-osp

This command will pull the packge simphony-osp from PyPI. In this case, you do not need to clone anything!!

If you want to install the package from source, then the README says:

Detailed installation instructions can be found here.

And the documentation says:

If you are a developer or an advanced user, you might be interested in installing SimPhoNy from source.

git clone https://github.com/simphony/simphony-osp.git
pip install ./simphony-osp

@kysrpex kysrpex added 🚧 installation Issues affecting the package installation. NOT related to the installation of ontologies. 📖 documentation labels Jan 30, 2023
@kysrpex
Copy link
Contributor

kysrpex commented Feb 1, 2023

@adhamhashibon Did the previous message make things more clear? Can the issue be closed?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📖 documentation 🚧 installation Issues affecting the package installation. NOT related to the installation of ontologies.
Projects
None yet
Development

No branches or pull requests

2 participants