Skip to content

Commit

Permalink
Merge pull request #292 from ZJUEarthData/dev/Ruitao
Browse files Browse the repository at this point in the history
docs: Provide download links in the Installation Manual and User Guide, and merge the Solutions and Suggestions for Installation Failure into the Q&A section.
  • Loading branch information
SanyHe authored Feb 3, 2024
2 parents 6c9bc69 + 9a7bbe1 commit 3852e8b
Show file tree
Hide file tree
Showing 3 changed files with 31 additions and 34 deletions.
20 changes: 20 additions & 0 deletions docs/source/For User/Contact us/Q&A.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,4 +32,24 @@ The absolute path of any disk is fine, but the path cannot contain spaces, and i

No, but the current process is a common data mining process, and we will write an abbreviated introduction afterwards.

**Q6. I'm having trouble installing our software because the download speed for Ray/Fiona is too slow or failing. How should I resolve this issue?**
To resolve the issue of slow or failed downloads for Ray/Fiona during installation, you can use the pip command with the Tsinghua mirror source, which may improve download speeds. This applies to both Mac and Windows systems. Here's the command:

```bash
pip install ray -i https://pypi.tuna.tsinghua.edu.cn/simple
```
You can refer to the video below:
+ Reference video: [Solutions to Failures in Direct pip Installation in China.mp4](https://www.bilibili.com/video/BV1zg4y1j7bx/?spm_id_from=333.999.0.0&vd_source=350db2ec0e0c3ee7f424928a21e82674).

Additionally, you can try cloning the source code from GitHub or Gitee repositories and then use the following command to install dependencies,For better download speeds, it is recommended to use the Tsinghua mirror source:

```bash
pip install -r requirements/production.txt -i https://pypi.tuna.tsinghua.edu.cn/simple
```
GitHub Link: https://github.com/ZJUEarthData/geochemistrypi
Gitee Link: https://gitee.com/zju-earth-data/geochemistrypi

This approach is also suitable for developers who want to test the latest updates. For more information, refer to the "Local Deployment" section under "For Developers" in the online documentation.

+ Reference video: [The Fastest Currently Feasible Installation Method in China—Installing from GitHub Using requirements.mp4](https://www.bilibili.com/video/BV1pM411V7iR/?spm_id_from=333.999.0.0&vd_source=350db2ec0e0c3ee7f424928a21e82674)
<br />
36 changes: 2 additions & 34 deletions docs/source/For User/Installation Manual.md
Original file line number Diff line number Diff line change
Expand Up @@ -125,38 +125,6 @@ geochemistrypi --version

## 3. Solutions and Suggestions for Installation Failure <a name="Solutions"> </a>

### 3.1 Use Tsinghua Mirror Source
If you encounter errors while Installing the software, please refer to the **Q&A** section under **Contact Us** in the **FOR USER** of our online documentation.

If you cannot download our software because Ray/Fiona downloads are too slow or just fail , you can use the pip with Tsinghua mirror source to re-download the package in terms of the specific error.
```
pip install ray -i https://pypi.tuna.tsinghua.edu.cn/simple
```
+ Reference video: [Solutions to Failures in Direct pip Installation in China.mp4](https://www.bilibili.com/video/BV1zg4y1j7bx/?spm_id_from=333.999.0.0&vd_source=350db2ec0e0c3ee7f424928a21e82674).

### 3.2 Use 'pip install -r requirements/production.txt'

Another way to download related dependecies is to clone the source code from GitHub or Gitee repository firstly:

GitHub Link: https://github.com/ZJUEarthData/geochemistrypi

Gitee Link: https://gitee.com/zju-earth-data/geochemistrypi

After that, unpacking the source code file. Open Terminal on Mac or Command Promt on Window and navigate to the directory to the source code file, use the following command to download the dependency :

```
pip install -r requirements/production.txt
```

Or use the Tsinghua mirror source to download:

```
pip install -r requirements/production.txt -i https://pypi.tuna.tsinghua.edu.cn/simple
```

+ Reference video: [The Fastest Currently Feasible Installation Method in China—Installing from GitHub Using requirements.mp4](https://www.bilibili.com/video/BV1pM411V7iR/?spm_id_from=333.999.0.0&vd_source=350db2ec0e0c3ee7f424928a21e82674)

**Note**: Actually this method can be used for developers to test our latest updates. For more information, please refer to our online documentation in **Local Deployment** under the section of **FOR DEVELOPER**.

### 3.3 Report An Error to Our Team

You can refer to our online documentation in **Contact Us** under the section of **FOR USER**.
If you are still unable to resolve the issue after consulting, you can visit the **Contact Us** section in our online documentation under **FOR USER**. There, you can report the error to our team.
9 changes: 9 additions & 0 deletions docs/source/For User/User Guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,15 @@
## 1. Installation <a name="installation"> </a>

Requirements: Python 3.9

The normal ways to install Python Python 3.9:

(1) If you are a Windows user, you can use Microsoft Store App to download directly by searching Python.

(2) Refer to the download section in [Python official documentation](https://www.python.org).

(3) If you are Chinese users, you can refer to this blog [Python Download - RUNOOB](https://www.runoob.com/python/python-install.html) to download too.

**Note**:You must have Python 3.9 installed on your computer to use the software.

### 1.1 Check Environment
Expand Down

0 comments on commit 3852e8b

Please sign in to comment.