add recommended install instructions on the readme?

OpenDrift / trajan

Trajectory analysis package for simulated and observed trajectories

https://opendrift.github.io/trajan/

GNU General Public License v2.0

11 stars 5 forks source link

add recommended install instructions on the readme? #62

Open jerabaul29 opened 1 year ago

jerabaul29 commented 1 year ago

Adding it on the readme directly may be useful for n00bs like me? :)

try latest main again. git clone + pip install -e . to replace the pip package.

may be enough, just so that the instructions are easily available? :)

gauteh commented 1 year ago

Yes, instructions are here, but can be repeated: https://opendrift.github.io/trajan/#installation

more detailed instructions for installing a development version can follow this setup: https://opendrift.github.io/install.html

jerabaul29 commented 1 year ago

Yes, this is where I got the installation instructions last, but:

I wonder if having this directly on the readme may be useful (though this is just taste / you should decide :) ), so I / users do not have to go through link after link to "just" install :)
the "install from git" was not listed, only the pypy pip and the conda :) - so could maybe be added there if you want to keep it all there rather than in the readme? :)

gauteh commented 1 year ago

Yes, I agree, they should also be in the README. As with OpenDrift we try to guide the different users to the most appropriate method. For most it should be enough to just do either conda install trajan og pip install trajan.