From 29f142cd551b6fa259ad9cd9a6994b5bbc9d6ca5 Mon Sep 17 00:00:00 2001 From: kat-grayson <118208076+kat-grayson@users.noreply.github.com> Date: Fri, 20 Dec 2024 12:15:57 +0100 Subject: [PATCH] Update README.md --- README.md | 41 +++++------------------------------------ 1 file changed, 5 insertions(+), 36 deletions(-) diff --git a/README.md b/README.md index c0e98f2..313f063 100644 --- a/README.md +++ b/README.md @@ -9,19 +9,13 @@ The algorithms take as input any Xarray object (either a Dataset or a DataArray) ### Disclaimer -No active development of the one-pass is occuring in this repository - that is occuring in a private repository. For any questions on development please contact katherine.grayson@bsc.es +No active development of the one-pass is occuring in this repository - that is occuring in a private repository. This repository contains the tagged version v0.6.2 used for publication. For any questions on development please contact katherine.grayson@bsc.es ## Installation -As there is currently no package-based installation for the `one_pass` the source must be obtained. This can easily be done (on any platform with internet connection) by cloning the repository directly. We recommend cloning the repository to depth 1 (only taking the latest commit to the main branch), to avoid cloning the larger history: +As there is currently no package-based installation for the `one_pass` the source must be obtained. This can easily be done (on any platform with internet connection) by cloning the repository directly: ``` -git clone --depth 1 https://earth.bsc.es/gitlab/digital-twins/de_340/one_pass.git - -``` -If however you want to work on other branches, clone the whole repository by: - -``` -git clone https://earth.bsc.es/gitlab/digital-twins/de_340/one_pass.git +git clone https://github.com/DestinE-Climate-DT/one_pass.git ``` After cloning, set up the environment using either conda or mamba (in the command below mamba can be replaced by conda if you do not have mamba installed): @@ -36,35 +30,10 @@ In any platform without interent connection, we have provided installation instr ## Documentation -All the information on how to install, configure and run the one_pass package is given the documentation, found in the docs folder. Here you will find the source code to build the online and pdf version of the documentation. - -To build the online version of the documentation you must clone the repo (see above), make sure you've activated the `env_opa` environment and - -``` -cd docs -make html - -``` - -This will build the oneline documentation in the folder `docs/build/html`. To access the documentation you can then click on `index.html` which will generate the webpage docs. If you have built the documentation on a remote platform (i.e. HPC) you can copy the documentation to your local machine via: - -``` -scp -r user@ssh_platform:~/path_to_one_pass/one_pass/docs/build/html /path/on/local/machine/to/docs - -``` -For example if you're on Levante `user@remote_platform` should be `username@levante.dkrz.de`. This will copy the documentation on to your local machine and you can click on `index.html` to view. - -To build the pdf version of the docs, again you must clone the repo (see above), make sure you've activated the `env_opa` environment and - -``` -cd docs -make latexpdf - -``` -which will make the pdf version of the docs in the folder `docs/build/latex`. It might be necessary to load a module such as `texlive` to enable the build of the pdf. +All the information on how to install, configure and run the one_pass package is given the documentation, found in the docs folder. ## Support -For all feedback, comments and issues, feel free to open an issue or email me at katherine.grayson@bsc.es +For all feedback, comments and issues, feel free to open an issue or email me at katherine.grayson@bsc.es.