search

simphony / simphony-osp

A framework that aims to achieve interoperability between software such as simulation engines, databases and data repositories using a knowledge graph as the common language.
https://simphony.readthedocs.io
Other
16 stars 12 forks source link

install help uses wrong names #846

Open adhamhashibon opened 1 year ago

adhamhashibon commented 1 year ago

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 commented 1 year ago

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 commented 1 year ago

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