-
Notifications
You must be signed in to change notification settings - Fork 29
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs:Submit the project packaging process and EXE installation and Op…
…eration Guide documents
- Loading branch information
unknown
authored and
unknown
committed
Jan 7, 2025
1 parent
22968ec
commit 78cf1e5
Showing
2 changed files
with
153 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,56 @@ | ||
| # Project packaging process | ||
|
|
||
| ## Table of Contents | ||
|
|
||
| - [1. Download the original code file from the project's [Github address]([Jin-sjh/Geochemistrypi: an open-sourced highly automated machine learning Python framework for data-driven geochemistry discovery](https://github.com/Jin-sjh/Geochemistrypi))](#1) | ||
| - [2. Open the folder in WinRAR](#2) | ||
| - [3. Select `Command'`-> `Add file to compressed file`](#3) | ||
| - [4. Create a compressed file in self-extracting format](#4) | ||
| - [5. Check `Advanced` -> `Self-extracting file option`](#5) | ||
| - [6. In the General TAB, set the path to the decompression](#6) | ||
| - [7. Set the shortcut options in the Advanced TAB](#7) | ||
| - [8. In the Text and ICONS TAB, set the exe's title, window text, and icon](#8) | ||
|
|
||
| --- | ||
|
|
||
| ## 1. Download the original code file from the project's [Github address]([Jin-sjh/Geochemistrypi: an open-sourced highly automated machine learning Python framework for data-driven geochemistry discovery](https://github.com/Jin-sjh/Geochemistrypi))<a id="1"></a> | ||
|
|
||
|  | ||
|
|
||
| After downloading, decompress the package to your desktop. | ||
|
|
||
|  | ||
|
|
||
| ## 2. Open the folder in WinRAR<a id="2"></a> | ||
|
|
||
|  | ||
|
|
||
| ## 3. Select `Command` -> `Add file to compressed file`<a id="3"></a> | ||
|
|
||
|  | ||
|
|
||
| ## 4. Create a compressed file in self-extracting format<a id="4"></a> | ||
|
|
||
|  | ||
|
|
||
| Select Create a self-extracting compressed file in Compression Options. | ||
|
|
||
| ## 5. Check `Advanced` -> `Self-extracting file option`<a id="5"></a> | ||
|
|
||
|  | ||
|
|
||
| ## 6. In the General TAB, set the path to the decompression<a id="6"></a> | ||
|
|
||
|  | ||
|
|
||
| ## 7. Set the shortcut options in the Advanced TAB<a id="7"></a> | ||
|
|
||
|  | ||
|
|
||
| ## 8. In the Text and ICONS TAB, set the exe's title, window text, and icon<a id="8"></a> | ||
|
|
||
|  | ||
|
|
||
| Corresponding part: | ||
|
|
||
|  |
97 changes: 97 additions & 0 deletions
97
docs/source/For User/EXE Installation and Operation Guide.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,97 @@ | ||
| # EXE Installation and Operation Guide | ||
|
|
||
| ## Table of Contents | ||
|
|
||
| - [1. EXE Installation Framework](#section1) | ||
| - [1.1 Check whether anaconda is installed](#subsection1-1) | ||
| - [1.2 Create Virtual Environment](#subsection1-2) | ||
| - [1.3 Check for Software Updates](#subsection1-3) | ||
| - [1.4 Launch the Project](#subsection1-4) | ||
| - [2. User Operation Steps](#section2) | ||
| - [2.1 Double-click to Launch EXE File](#subsection2-1) | ||
| - [2.2 Select Installation Location](#subsection2-2) | ||
| - [2.3 Run Desktop Project Icon](#subsection2-3) | ||
| - [2.4 Detect Project Updates](#subsection2-4) | ||
| - [2.5 Place Spreadsheet Files](#subsection2-5) | ||
| - [2.6 Enter 'y' to Continue](#subsection2-6) | ||
|
|
||
| --- | ||
|
|
||
| ## 1 EXE Installation Framework <a id="section1"></a> | ||
|
|
||
| ### 1.1 Check whether anaconda is installed <a id="subsection1-1"></a> | ||
|
|
||
|  | ||
|
|
||
| Anaconda Distribution is a free distribution of Python/R for scientific computing, which makes it easy to manage Python runtime environments. The installation program will first check whether Anaconda is installed on your computer. If not installed, the program will download and install it from the official website; if installed, it will proceed to the next step. | ||
|
|
||
|  | ||
|
|
||
| ### 1.2 Create Virtual Environment <a id="subsection1-2"></a> | ||
|
|
||
| The installation program will run Anaconda, automatically install dependent libraries, and create the virtual environment required for the project. | ||
|
|
||
|  | ||
|
|
||
| **Note:** | ||
|
|
||
| - At this stage. Only option `1` can be used for installation | ||
|
|
||
|  | ||
|
|
||
| ### 1.3 Check for software updates <a id="subsection1-3"></a> | ||
|
|
||
| When the software runs, it will automatically detect whether the current code is the latest version. If it is not the latest version, it will prompt the user to update. | ||
|
|
||
|  | ||
|
|
||
| ### 1.4 Launch the Project <a id="subsection1-4"></a> | ||
|
|
||
| After the project is launched, two folders will be automatically created on the desktop: one for placing spreadsheet data to be processed, and the other for saving the results of the project. | ||
|
|
||
|
|
||
|
|
||
| --- | ||
|
|
||
| ## 2. User Operation Steps <a id="section2"></a> | ||
|
|
||
| ### 2.1 Double-click to Launch EXE File <a id="subsection2-1"></a> | ||
|
|
||
|  | ||
|
|
||
| After downloading the installation program from the specified location, double-click the file to start it. | ||
|
|
||
| **Note:** | ||
|
|
||
| - The installation program may be incorrectly identified as a virus by Windows and deleted. If this happens, please turn off real-time protection in the Windows Security Center and install again. | ||
|
|
||
| ### 2.2 Select Installation Location <a id="subsection2-2"></a> | ||
|
|
||
|  | ||
|
|
||
| - The installation program defaults to `C:\Program Files (x86)\geochemistrypi`. | ||
| - If the computer system prohibits external software operations in the specified path, you can choose to adjust the installation location to another place, such as `C:\Users\Dell\Desktop`. | ||
|
|
||
| ### 2.3 Run Desktop Project Icon <a id="subsection2-3"></a> | ||
|
|
||
|  | ||
|
|
||
| After installation, shortcuts will be created on the desktop and in the `All Apps` menu bar of the `Win` key. Clicking either shortcut will start the program. | ||
|
|
||
| ### 2.4 Detect Project Updates <a id="subsection2-4"></a> | ||
|
|
||
| After the program starts, it will automatically detect whether it is the latest version. If there is an update, it will automatically download and install the latest version. | ||
|
|
||
|  | ||
|
|
||
| ### 2.5 Place Spreadsheet Files <a id="subsection2-5"></a> | ||
|
|
||
| After the program starts, two folders will be automatically created on the desktop. Users can place the spreadsheet data files to be processed in `geopi_data_input`, and the results of the project processing will be stored in `geopi_data_output`. | ||
|
|
||
|  | ||
|
|
||
| ### 2.6 Enter 'y' to Continue <a id="subsection2-6"></a> | ||
|
|
||
| After placing the files, confirmation is required. Enter 'y' to proceed to the operation interface. | ||
|
|
||
|  |