From b5ed1cb826bcc4e9db5b81e62f97c23ced5983d6 Mon Sep 17 00:00:00 2001 From: Florez Ospina Juan Felipe Date: Fri, 24 May 2024 11:56:30 +0200 Subject: [PATCH] Updated readme file --- README.md | 50 ++++++++++++++++++++++++++++---------------------- 1 file changed, 28 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index e0f04b3..13a7b99 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,8 @@ -# functionsPython +# Data integration and metadata annotation -Python library to work with XPS data campaigns, encoded in HDF5 files. +Repository for integrating data in HDF5 from various sources and managing metadata updates in the integrated files. -## TODO -* Talk to Thorsten about rga txt files. Example folder contains incosistent rga txt files, there is no unique column separator (, or ) +Includes tools and workflows for comprehensive data integration and automated metadata review processes. ## Installation @@ -12,7 +11,7 @@ Follow these steps to install and set up the project: 1. Download our GitLab repository in your GitLab folder, or alternatively open a Git Bash terminal and run the following commands ``` cd Path/to/GitLab - git clone https://gitlab.psi.ch/5505/functionspython.git + git clone https://gitlab.psi.ch/5505/data-integration-and-metadata-annotation.git ``` 2. Open an Anaconda Prompt (Anaconda3) as administrator, and set the current directory to the path of the project's folder. @@ -27,28 +26,12 @@ Follow these steps to install and set up the project: * Visual Studio Code (VS Code): After opening your project in VS Code, click on the Python interpreter in the status bar and choose the `multiphase_chemistry_env` environment. -## Getting started - -To make it easy for you to get started with GitLab, here's a list of recommended next steps. - -Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)! - -## Add your files - -- [ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files -- [ ] [Add files using the command line](https://docs.gitlab.com/ee/gitlab-basics/add-file.html#add-a-file-using-the-command-line) or push an existing Git repository with the following command: - -``` -cd existing_repo -git remote add origin https://gitlab.psi.ch/5505/functionspython.git -git branch -M main -git push -uf origin main -``` ## Data integration workflow ## Metadata review workflow - review through branches - updating files with metadata in Openbis + ### Specifying a compound attribute in yaml language. Consider the compound attribute *relative_humidity*, which has subattributes *value*, *units*, *range*, and *definition*. The yaml description of such an attribute is as follows: @@ -74,6 +57,29 @@ relative_humidity: ``` +## ------------------- +## Getting started + +To make it easy for you to get started with GitLab, here's a list of recommended next steps. + +Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)! + +## TODO +* Talk to Thorsten about rga txt files. Example folder contains incosistent rga txt files, there is no unique column separator (, or ) + +## Add your files + +- [ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files +- [ ] [Add files using the command line](https://docs.gitlab.com/ee/gitlab-basics/add-file.html#add-a-file-using-the-command-line) or push an existing Git repository with the following command: + +``` +cd existing_repo +git remote add origin https://gitlab.psi.ch/5505/functionspython.git +git branch -M main +git push -uf origin main +``` + + ``` cd existing_repo git remote add origin https://gitlab.psi.ch/5505/functionspython.git