Updated documantation

egiron · Oct 3, 2023 · 672a6e0 · 672a6e0
1 parent 8916ebe
commit 672a6e0
Show file tree

Hide file tree

Showing 8 changed files with 32 additions and 473 deletions.
diff --git a/README.md b/README.md
@@ -1,3 +1,5 @@
+![header](./docs/assets/header_tfunct_color.jpg)
+
 <p align="center">
   <!-- <a href="https://orderseed.cimmyt.org/iwin-results.php"><img
     src="https://img.shields.io/badge/CIMMYT-IWIN-blue"
@@ -7,10 +9,10 @@
     src="https://github.com/egiron/TemperatureFunct/actions/workflows/ci.yaml/badge.svg"
     alt="Build"
   /></a>
-  <!-- <a href="https://pypistats.org/packages/tfunct"><img
+  <a href="https://pypistats.org/packages/tfunct"><img
     src="https://img.shields.io/pypi/dm/tfunct.svg" 
     alt="Downloads"
-  /></a> -->
+  /></a>
   <a href="https://pypi.org/project/tfunct"><img 
     src="https://img.shields.io/pypi/v/tfunct.svg" 
     alt="Python Package Index"

diff --git a/docs/assets/header_tfunct_color.jpg b/docs/assets/header_tfunct_color.jpg
diff --git a/docs/data.md b/docs/data.md
@@ -35,7 +35,7 @@ The last generation of [ERA5] global atmospheric reanalysis weather data is used
  [ERA5]: https://cds.climate.copernicus.eu/cdsapp#!/dataset/10.24381/cds.6c68c9bb?tab=overview
 
 
-## Loading datasets using the API
+## Loading data using the API
 
 All of the above data can be loaded and displayed using the library API.
 

diff --git a/docs/getting_started.md b/docs/getting_started.md
@@ -21,12 +21,30 @@ Here we compare three different temperature functions with different cardinal te
 
 ---
 
+## Creating application directory and installing dependencies
+
+Launch your terminal and navigate to your desired location to create the project directory. Run the following commands to create a directory for your project and initialize a grain yield model inside it:
+
+``` sh
+mkdir <`subfolder`>
+cd <`subfolder`>
+```
+
+Create a virtual environment with:
+
+``` sh
+python3 -m venv venv
+```
+!!! Note
+    Please follow the [installation instructions] to complete the steps above according to your local system.
+
+
 ## Setup a folder
 
 Enter a folder or subfolder of your project root where you created the python environment and activate it.
 ``` sh
-cd <`subfolder`>
-. venv/bin/activate
+# cd <`subfolder`>
+source ./venv/bin/activate
 ```
 If you didn't install the `venv` yet, please review the detailed [installation instructions]