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

conda installation infos missing #62

Open
martin-raden opened this issue Dec 20, 2023 · 7 comments
Open

conda installation infos missing #62

martin-raden opened this issue Dec 20, 2023 · 7 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@martin-raden
Copy link
Member

work in progress

@teresa-m
Copy link
Member

I would maybe shorten the information in the readme since we have the documentation now separately. Here the conda installation is updated: https://backofenlab.github.io/Cherri/docs/welcome.html#installation

@martin-raden
Copy link
Member Author

du solltest in der docu unbedingt den zenodo link auf [https://doi.org/10.5281/zenodo.6533931] ändern, weil der aktuelle auf "v1" zeigt und dieser auf die letzte version...

zudem wärs gut, wenn man im zenodo repo die modelle direkt runterladen könnte, und nicht immer das komplette 800mb paket..

@martin-raden
Copy link
Member Author

und ja, in der github README kannst du direkt auf die generierten docs verlinken und die docu einschränken. ansonsten läufst du gefahr bei änderungen nur eine docu zu ändern, was fatal wäre..

@martin-raden martin-raden added the documentation Improvements or additions to documentation label Dec 22, 2023
@teresa-m
Copy link
Member

Die doku und readme sind upgedated.
https://backofenlab.github.io/Cherri/docs/usage.html#evaluation-of-rris
Falls du keine einwände hast würde ich das issue schließen.

@teresa-m teresa-m reopened this Jan 24, 2024
@martin-raden
Copy link
Member Author

hi teresa,
der zenodo doi link in der doku die du linkst ist immer noch auf eine spezielle version... bitte den verwenden, der hinten mit "1" endet. siehe oben!
Danke,
Martin

@martin-raden
Copy link
Member Author

du hast meine idee mit dem MODELPATH aufgenommen. den solltest du aber vor verwendung beispielhaft einführen

e.g.

MODELPATH=~/myproject

@teresa-m
Copy link
Member

hi teresa, der zenodo doi link in der doku die du linkst ist immer noch auf eine spezielle version... bitte den verwenden, der hinten mit "1" endet. siehe oben! Danke, Martin

Verstehe das mit der 1 nicht ganz. Ich like mit der doi: https://zenodo.org/records/10555733
Hier soll ich einen anderen link verwenden der auf 1 endet?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants