Updated readme file
This commit is contained in:
24
README.md
24
README.md
@ -8,7 +8,7 @@ Includes tools and workflows for comprehensive data integration and automated me
|
|||||||
|
|
||||||
Follow these steps to install and set up the project:
|
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
|
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
|
cd Path/to/GitLab
|
||||||
git clone https://gitlab.psi.ch/5505/data-integration-and-metadata-annotation.git
|
git clone https://gitlab.psi.ch/5505/data-integration-and-metadata-annotation.git
|
||||||
@ -20,25 +20,27 @@ Follow these steps to install and set up the project:
|
|||||||
```
|
```
|
||||||
conda env create -f environment.yml
|
conda env create -f environment.yml
|
||||||
```
|
```
|
||||||
4. Activate the created environment by running the following command:
|
|
||||||
|
## Working with Jupyter Notebook on the `multiphase_chemistry_env`
|
||||||
|
|
||||||
|
1. Open an Anaconda Prompt as a regular user, ensure that `multiphase_chemistry_env` is in the list of available enviroments and activate it by running the following commands:
|
||||||
```
|
```
|
||||||
|
conda env list
|
||||||
conda activate multiphase_chemistry_env
|
conda activate multiphase_chemistry_env
|
||||||
```
|
```
|
||||||
5. Once the enviroment is activated, register the associated kernel in jupyter by running:
|
2. Register the associated kernel in Jupyter by running:
|
||||||
|
|
||||||
```
|
```
|
||||||
python -m ipykernel install --user --name multiphase_chemistry_env --display-name "Python (multiphase_chemistry_env)"
|
(multiphase_chemistry_env) python -m ipykernel install --user --name multiphase_chemistry_env --display-name "Python (multiphase_chemistry_env)"
|
||||||
```
|
```
|
||||||
|
3. Start a Jupyter Notebook by running the command:
|
||||||
|
|
||||||
6. Start a Jupyter Notebook by running the command:
|
|
||||||
```
|
```
|
||||||
jupyter notebook
|
(multiphase_chemistry_env) jupyter notebook
|
||||||
```
|
```
|
||||||
and select the `multiphase_chemistry_env` environment from the kernel options.
|
and select the `multiphase_chemistry_env` environment from the kernel options.
|
||||||
|
|
||||||
|
## Working with Visual Studio Code (VS Code) on the `multiphase_chemistry_env`
|
||||||
7. Otherwise, for 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.
|
1. Open the project in VS Code, click on the Python interpreter in the status bar and choose the `multiphase_chemistry_env` environment.
|
||||||
|
|
||||||
## Data integration workflow
|
## Data integration workflow
|
||||||
|
|
||||||
|
Reference in New Issue
Block a user